Columns that must meet a specific threshold value (after an aggregation function is\n applied to it) for each output row to be returned.
", "smithy.api#required": {} } + }, + "additionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AdditionalAnalyses", + "traits": { + "smithy.api#documentation": "An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
\nThe\n additionalAnalyses\n parameter is\n currently\n supported for the list analysis rule (AnalysisRuleList) and the custom\n analysis rule (AnalysisRuleCustom).
An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
" + } + }, + "disallowedOutputColumns": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnList", + "traits": { + "smithy.api#documentation": "A list of columns that aren't allowed to be shown in the query output.
" + } + }, "differentialPrivacy": { "target": "com.amazonaws.cleanrooms#DifferentialPrivacyConfiguration", "traits": { @@ -1209,6 +1277,12 @@ "smithy.api#documentation": "Columns that can be listed in the output.
", "smithy.api#required": {} } + }, + "additionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AdditionalAnalyses", + "traits": { + "smithy.api#documentation": "An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
" + } } }, "traits": { @@ -1693,6 +1767,23 @@ } } }, + "com.amazonaws.cleanrooms#AnalysisType": { + "type": "enum", + "members": { + "DIRECT_ANALYSIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_ANALYSIS" + } + }, + "ADDITIONAL_ANALYSIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDITIONAL_ANALYSIS" + } + } + } + }, "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate": { "type": "operation", "input": { @@ -2414,7 +2505,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Only supports AWS account ID.
", "smithy.api#required": {} } }, @@ -2492,7 +2583,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Only supports AWS account ID.
", "smithy.api#required": {} } }, @@ -3183,6 +3274,20 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" } }, + "com.amazonaws.cleanrooms#ConfigurationDetails": { + "type": "union", + "members": { + "directAnalysisConfigurationDetails": { + "target": "com.amazonaws.cleanrooms#DirectAnalysisConfigurationDetails", + "traits": { + "smithy.api#documentation": "The direct analysis configuration details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details.
" + } + }, "com.amazonaws.cleanrooms#ConfiguredAudienceModelArn": { "type": "string", "traits": { @@ -3714,6 +3819,12 @@ "smithy.api#documentation": "A description of the configured table association.
" } }, + "analysisRuleTypes": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleTypeList", + "traits": { + "smithy.api#documentation": "The analysis rule types for the configured table association.
" + } + }, "createTime": { "target": "smithy.api#Timestamp", "traits": { @@ -3733,6 +3844,194 @@ "smithy.api#documentation": "A configured table association links a configured table to a collaboration.
" } }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The membership identifier for the configured table association analysis rule.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableAssociationId": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "\n The\n unique identifier for the configured table association.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "configuredTableAssociationArn": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn", + "traits": { + "smithy.api#documentation": "\n The\n Amazon Resource Name (ARN) of the configured table association.
", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy", + "traits": { + "smithy.api#documentation": "The policy of the configured table association analysis rule.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", + "traits": { + "smithy.api#documentation": "The type of the configured table association analysis rule.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the configured table association analysis rule.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The update time of the configured table association analysis rule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An\n analysis rule for a configured table association. This analysis rule specifies how data\n from the table can be used within its associated\n collaboration.\n In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.
The list of collaboration members who are allowed to receive results of queries run\n with this configured table.
" + } + }, + "allowedAdditionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AllowedAdditionalAnalyses", + "traits": { + "smithy.api#documentation": "The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
\nThe\n allowedAdditionalAnalyses\n parameter\n is currently supported for the list analysis rule\n (AnalysisRuleList) and the custom analysis rule\n (AnalysisRuleCustom).
The configured table association analysis rule applied to a configured table with the aggregation analysis rule.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleCustom": { + "type": "structure", + "members": { + "allowedResultReceivers": { + "target": "com.amazonaws.cleanrooms#AllowedResultReceivers", + "traits": { + "smithy.api#documentation": "The list of\n collaboration members who are allowed\n to\n receive results of queries run with this configured table.
" + } + }, + "allowedAdditionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AllowedAdditionalAnalyses", + "traits": { + "smithy.api#documentation": "The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configured table association analysis rule applied to a configured table with the custom analysis rule.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleList": { + "type": "structure", + "members": { + "allowedResultReceivers": { + "target": "com.amazonaws.cleanrooms#AllowedResultReceivers", + "traits": { + "smithy.api#documentation": "The list of collaboration members who are allowed to receive results of queries run\n with this configured table.
" + } + }, + "allowedAdditionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AllowedAdditionalAnalyses", + "traits": { + "smithy.api#documentation": "The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configured table association analysis rule applied to a configured table with the list analysis rule.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy": { + "type": "union", + "members": { + "v1": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicyV1", + "traits": { + "smithy.api#documentation": "The policy for the configured table association analysis rule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Controls on the query specifications that can be run on an associated configured table.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicyV1": { + "type": "union", + "members": { + "list": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleList", + "traits": { + "smithy.api#documentation": "Analysis rule type that enables only list queries on a configured table.
" + } + }, + "aggregation": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleAggregation", + "traits": { + "smithy.api#documentation": "Analysis rule type that enables only aggregation queries on a configured table.
" + } + }, + "custom": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleCustom", + "traits": { + "smithy.api#documentation": "Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Controls on the query specifications that can be run on an associated configured table.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType": { + "type": "enum", + "members": { + "AGGREGATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGGREGATION" + } + }, + "LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIST" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType" + } + }, "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn": { "type": "string", "traits": { @@ -3777,6 +4076,20 @@ "list": { "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociations" }, + "operations": [ + { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRule" + } + ], "traits": { "aws.api#arn": { "template": "membership/{MembershipId}/configuredtableassociation/{ConfiguredTableAssociationId}" @@ -4246,7 +4559,7 @@ "collaboration": { "target": "com.amazonaws.cleanrooms#Collaboration", "traits": { - "smithy.api#documentation": "The entire created collaboration object.
", + "smithy.api#documentation": "The collaboration.
", "smithy.api#required": {} } } @@ -4461,7 +4774,7 @@ "analysisRulePolicy": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy", "traits": { - "smithy.api#documentation": "The entire created configured table analysis rule object.
", + "smithy.api#documentation": "The analysis rule policy that was created for the configured table.
", "smithy.api#required": {} } } @@ -4473,7 +4786,7 @@ "analysisRule": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRule", "traits": { - "smithy.api#documentation": "The entire created analysis rule.
", + "smithy.api#documentation": "The analysis rule that was created for the configured table.
", "smithy.api#required": {} } } @@ -4523,6 +4836,102 @@ } } }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRuleInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create analysis rules for configured table association" + }, + "smithy.api#documentation": "Creates a new analysis rule for an associated configured table.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRuleInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The unique ID for the configured table association. Currently accepts the\n configured table association ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", + "traits": { + "smithy.api#documentation": "The type of analysis rule.
", + "smithy.api#required": {} + } + }, + "analysisRulePolicy": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy", + "traits": { + "smithy.api#documentation": "The analysis rule policy that was created for the configured table\n association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRuleOutput": { + "type": "structure", + "members": { + "analysisRule": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", + "traits": { + "smithy.api#documentation": "The analysis rule for the configured table association.\n In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.
The entire configured table association object.
", + "smithy.api#documentation": "The configured table association.
", "smithy.api#required": {} } } @@ -5401,6 +5810,88 @@ "smithy.api#idempotent": {} } }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationAnalysisRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationAnalysisRuleInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationAnalysisRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an existing configured table association analysis rule" + }, + "smithy.api#documentation": "Deletes\n an analysis rule for a configured table association.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationAnalysisRuleInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The\n identifier for the configured table association that's related to the analysis rule that you\n want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", + "traits": { + "smithy.api#documentation": "The\n type of the analysis rule that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationAnalysisRuleOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationInput": { "type": "structure", "members": { @@ -6123,6 +6614,20 @@ "smithy.api#documentation": "The epsilon and noise parameter values that you want to update in the differential privacy template.
" } }, + "com.amazonaws.cleanrooms#DirectAnalysisConfigurationDetails": { + "type": "structure", + "members": { + "receiverAccountIds": { + "target": "com.amazonaws.cleanrooms#ReceiverAccountIds", + "traits": { + "smithy.api#documentation": "The account IDs for the member who received the results of a protected query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The direct analysis configuration details.
" + } + }, "com.amazonaws.cleanrooms#DisplayName": { "type": "string", "traits": { @@ -6818,6 +7323,93 @@ "smithy.api#readonly": {} } }, + "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRuleInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get analysis rules for a configured table association" + }, + "smithy.api#documentation": "\n Retrieves\n the analysis rule for a configured table association.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRuleInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "\n The\n identifier for the configured table association that's related to the analysis\n rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", + "traits": { + "smithy.api#documentation": "\n The\n type of analysis rule that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRuleOutput": { + "type": "structure", + "members": { + "analysisRule": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", + "traits": { + "smithy.api#documentation": "The\n analysis rule for the configured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.
The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", "smithy.api#httpQuery": "maxResults" } } @@ -8269,7 +8861,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } }, "analysisTemplateSummaries": { @@ -8335,14 +8927,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", "smithy.api#httpQuery": "maxResults" } } @@ -8354,7 +8946,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } }, "collaborationAnalysisTemplateSummaries": { @@ -8423,14 +9015,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", "smithy.api#httpQuery": "maxResults" } } @@ -8452,7 +9044,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
" } } }, @@ -8611,14 +9203,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -8633,7 +9225,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } }, "collaborationPrivacyBudgetTemplateSummaries": { @@ -8713,14 +9305,14 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } } @@ -8742,7 +9334,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } } }, @@ -8792,14 +9384,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.
", "smithy.api#httpQuery": "maxResults" } }, @@ -8818,7 +9410,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } }, "collaborationList": { @@ -8886,14 +9478,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -8976,14 +9568,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", "smithy.api#httpQuery": "maxResults" } } @@ -9002,7 +9594,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } } } @@ -9049,14 +9641,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", "smithy.api#httpQuery": "maxResults" } } @@ -9075,7 +9667,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } } } @@ -9320,14 +9912,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", "smithy.api#httpQuery": "maxResults" } } @@ -9339,7 +9931,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } }, "memberSummaries": { @@ -9393,14 +9985,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", "smithy.api#httpQuery": "maxResults" } }, @@ -9419,7 +10011,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } }, "membershipSummaries": { @@ -9487,14 +10079,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -9509,7 +10101,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } }, "privacyBudgetTemplateSummaries": { @@ -9589,14 +10181,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -9618,7 +10210,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } } }, @@ -9689,14 +10281,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n `maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service can return a nextToken even if the maximum results has not\n been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -9708,7 +10300,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } }, "protectedQueries": { @@ -9774,21 +10366,21 @@ "schemaType": { "target": "com.amazonaws.cleanrooms#SchemaType", "traits": { - "smithy.api#documentation": "If present, filter schemas by schema type.
", + "smithy.api#documentation": "If present, filter schemas by schema type. The only valid schema type is currently\n `TABLE`.
", "smithy.api#httpQuery": "schemaType" } }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#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 \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", "smithy.api#httpQuery": "maxResults" } } @@ -9807,7 +10399,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } } } @@ -10915,7 +11507,7 @@ "parameters": { "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateParametersOutput", "traits": { - "smithy.api#documentation": "Specifies the epsilon and noise parameters for the privacy budget template.
", + "smithy.api#documentation": "Specifies the\n epsilon\n and noise parameters for the privacy budget template.
", "smithy.api#required": {} } } @@ -11252,6 +11844,21 @@ "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, + "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputConfiguration": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "The\n unique identifier for the account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configuration details for the protected query member output.
" + } + }, "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputList": { "type": "list", "member": { @@ -11284,7 +11891,13 @@ "s3": { "target": "com.amazonaws.cleanrooms#ProtectedQueryS3OutputConfiguration", "traits": { - "smithy.api#documentation": "Required configuration for a protected query with an `S3` output type.
" + "smithy.api#documentation": "Required configuration for a protected query with an\n s3\n output type.
Required configuration for a protected query with a member output type.
The duration of the Protected Query, from creation until query completion.
" + "smithy.api#documentation": "The duration of the protected query, from creation until query completion.
" } } }, @@ -11502,6 +12115,14 @@ "smithy.api#documentation": "The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`,\n `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.
", "smithy.api#required": {} } + }, + "receiverConfigurations": { + "target": "com.amazonaws.cleanrooms#ReceiverConfigurationsList", + "traits": { + "smithy.api#default": [], + "smithy.api#documentation": "The receiver configuration.
", + "smithy.api#required": {} + } } }, "traits": { @@ -11585,6 +12206,39 @@ "target": "com.amazonaws.cleanrooms#TableAlias" } }, + "com.amazonaws.cleanrooms#ReceiverAccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AccountId" + } + }, + "com.amazonaws.cleanrooms#ReceiverConfiguration": { + "type": "structure", + "members": { + "analysisType": { + "target": "com.amazonaws.cleanrooms#AnalysisType", + "traits": { + "smithy.api#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.
The configuration details of the receiver configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The receiver configuration for a protected query.
" + } + }, + "com.amazonaws.cleanrooms#ReceiverConfigurationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ReceiverConfiguration" + } + }, "com.amazonaws.cleanrooms#ResourceAlias": { "type": "string", "traits": { @@ -11796,7 +12450,7 @@ "columns": { "target": "com.amazonaws.cleanrooms#ColumnList", "traits": { - "smithy.api#documentation": "The columns for the relation that this schema represents.
", + "smithy.api#documentation": "The columns for the relation this schema represents.
", "smithy.api#required": {} } }, @@ -11810,14 +12464,14 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#AnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "The analysis rule types that are associated with the schema. Currently, only one entry is\n present.
", + "smithy.api#documentation": "The analysis rule types associated with the schema. Currently, only one entry is\n present.
", "smithy.api#required": {} } }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "The analysis method for the schema. The only valid value is currently\n DIRECT_QUERY.
The analysis method for the schema. The only valid value is currently\n DIRECT_QUERY.
" } }, "creatorAccountId": { @@ -11844,7 +12498,7 @@ "collaborationArn": { "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
", + "smithy.api#documentation": "The unique ARN for the collaboration that the schema belongs to.
", "smithy.api#required": {} } }, @@ -11858,21 +12512,21 @@ "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the schema was created.
", + "smithy.api#documentation": "The time the schema was created.
", "smithy.api#required": {} } }, "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The most recent time at which the schema was updated.
", + "smithy.api#documentation": "The time the schema was last updated.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.cleanrooms#SchemaType", "traits": { - "smithy.api#documentation": "The type of schema.
", + "smithy.api#documentation": "The type of schema. The only valid value is currently `TABLE`.
", "smithy.api#required": {} } }, @@ -11948,30 +12602,6 @@ "traits": { "smithy.api#enumValue": "DIFFERENTIAL_PRIVACY" } - }, - "CUSTOM_ANALYSIS_NOT_ALLOWED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_ANALYSIS_NOT_ALLOWED" - } - }, - "NO_MEMBER_ACCOUNT_ALLOWED_TO_PROVIDE_ANALYSIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_MEMBER_ACCOUNT_ALLOWED_TO_PROVIDE_ANALYSIS" - } - }, - "DIFFERENTIAL_PRIVACY_BUDGET_NOT_CONFIGURED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIFFERENTIAL_PRIVACY_BUDGET_NOT_CONFIGURED" - } - }, - "ID_MAPPING_TABLE_NOT_POPULATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ID_MAPPING_TABLE_NOT_POPULATED" - } } } }, @@ -12015,7 +12645,7 @@ "status": { "target": "com.amazonaws.cleanrooms#SchemaStatus", "traits": { - "smithy.api#documentation": "The status of the schema.
", + "smithy.api#documentation": "The status of the schema, indicating if it is ready to query.
", "smithy.api#required": {} } }, @@ -12036,6 +12666,14 @@ "traits": { "smithy.api#documentation": "The configuration details of the schema analysis rule for the given type.
" } + }, + "analysisType": { + "target": "com.amazonaws.cleanrooms#AnalysisType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The type of analysis that can be performed on the schema.
\nA schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.
The type of schema object.
", + "smithy.api#documentation": "The type of schema object. The only valid schema type is currently `TABLE`.
", "smithy.api#required": {} } }, @@ -12961,6 +13635,102 @@ } } }, + "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRuleInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update analysis rules for a configured table association" + }, + "smithy.api#documentation": "\n Updates\n the analysis rule for a configured table association.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}" + } + } + }, + "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRuleInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for the configured table association to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", + "traits": { + "smithy.api#documentation": "The analysis rule type\n that\n you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "analysisRulePolicy": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy", + "traits": { + "smithy.api#documentation": "\n The\n updated analysis rule policy for the configured table association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRuleOutput": { + "type": "structure", + "members": { + "analysisRule": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", + "traits": { + "smithy.api#documentation": "\n The\n updated analysis rule for the configured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.
This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify\n an equality condition on all key attributes. This enforces that each SELECT\n statement in a batch returns at most a single item.
The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.
\nA HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.
This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify\n an equality condition on all key attributes. This enforces that each SELECT\n statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB\n .
The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.
\nA HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.
The response to each PartiQL statement in the batch. The values of the list are \n ordered according to the ordering of the request statements.
" + "smithy.api#documentation": "The response to each PartiQL statement in the batch. The values of the list are\n ordered according to the ordering of the request statements.
" } }, "ConsumedCapacity": { @@ -850,7 +850,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested,\n or an internal processing failure occurs. If a partial result is returned, the operation returns a value for\n UnprocessedKeys. You can use this value to retry the operation starting\n with the next item to get.
If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.
If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nBy default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.
When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.
If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.
", + "smithy.api#documentation": "The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is\n requested, or an internal processing failure occurs. If a partial result is returned,\n the operation returns a value for UnprocessedKeys. You can use this value\n to retry the operation starting with the next item to get.
If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.
If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nBy default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.
When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.
If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.
", "smithy.api#examples": [ { "title": "To retrieve multiple items from a table", @@ -919,7 +919,7 @@ "RequestItems": { "target": "com.amazonaws.dynamodb#BatchGetRequestMap", "traits": { - "smithy.api#documentation": "A map of one or more table names or table ARNs and, for each table, a map that describes one or more\n items to retrieve from that table. Each table name or ARN can be used only once per\n BatchGetItem request.
Each element in the map of items to retrieve consists of the following:
\n\n ConsistentRead - If true, a strongly consistent read\n is used; if false (the default), an eventually consistent read is\n used.
\n ExpressionAttributeNames - One or more substitution tokens for\n attribute names in the ProjectionExpression parameter. The\n following are some use cases for using\n ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name\n in an expression.
\nTo prevent special characters in an attribute name from being\n misinterpreted in an expression.
\nUse the # character in an expression to\n dereference an attribute name. For example, consider the following attribute\n name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be\n used directly in an expression. (For the complete list of reserved words, see\n Reserved\n Words in the Amazon DynamoDB Developer Guide).\n To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this\n example:
\n\n #P = :val\n
Tokens that begin with the : character\n are expression attribute values, which are placeholders\n for the actual value at runtime.
\nFor more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.
\n\n Keys - An array of primary key attribute values that define\n specific items in the table. For each primary key, you must provide\n all of the key attributes. For example, with a simple\n primary key, you only need to provide the partition key value. For a composite\n key, you must provide both the partition key value and the\n sort key value.
\n ProjectionExpression - A string that identifies one or more\n attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the expression must be\n separated by commas.
If no attribute names are specified, then all attributes are returned. If any\n of the requested attributes are not found, they do not appear in the\n result.
\nFor more information, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.
\n\n AttributesToGet - This is a legacy parameter. Use\n ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.
A map of one or more table names or table ARNs and, for each table, a map that\n describes one or more items to retrieve from that table. Each table name or ARN can be\n used only once per BatchGetItem request.
Each element in the map of items to retrieve consists of the following:
\n\n ConsistentRead - If true, a strongly consistent read\n is used; if false (the default), an eventually consistent read is\n used.
\n ExpressionAttributeNames - One or more substitution tokens for\n attribute names in the ProjectionExpression parameter. The\n following are some use cases for using\n ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name\n in an expression.
\nTo prevent special characters in an attribute name from being\n misinterpreted in an expression.
\nUse the # character in an expression to\n dereference an attribute name. For example, consider the following attribute\n name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be\n used directly in an expression. (For the complete list of reserved words, see\n Reserved\n Words in the Amazon DynamoDB Developer Guide).\n To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this\n example:
\n\n #P = :val\n
Tokens that begin with the : character\n are expression attribute values, which are placeholders\n for the actual value at runtime.
\nFor more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.
\n\n Keys - An array of primary key attribute values that define\n specific items in the table. For each primary key, you must provide\n all of the key attributes. For example, with a simple\n primary key, you only need to provide the partition key value. For a composite\n key, you must provide both the partition key value and the\n sort key value.
\n ProjectionExpression - A string that identifies one or more\n attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the expression must be\n separated by commas.
If no attribute names are specified, then all attributes are returned. If any\n of the requested attributes are not found, they do not appear in the\n result.
\nFor more information, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.
\n\n AttributesToGet - This is a legacy parameter. Use\n ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.
A map of table name or table ARN to a list of items. Each object in Responses consists\n of a table name or ARN, along with a map of attribute data consisting of the data type and\n attribute value.
A map of table name or table ARN to a list of items. Each object in\n Responses consists of a table name or ARN, along with a map of\n attribute data consisting of the data type and attribute value.
The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of\n data over the network, consisting of up to 25 item put or delete operations. While\n individual items can be up to 400 KB once stored, it's important to note that an item's\n representation might be greater than 400KB while being sent in DynamoDB's JSON format\n for the API call. For more details on this distinction, see Naming Rules and Data Types.
\n BatchWriteItem cannot update items. If you perform a BatchWriteItem\n operation on an existing item, that item's values will be overwritten by the\n operation and it will appear like it was updated. To update items, we recommend you\n use the UpdateItem action.
The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.
If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchWriteItem returns a\n ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nWith BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.
\nIf one or more of the following is true, DynamoDB rejects the entire batch write\n operation:
\nOne or more tables specified in the BatchWriteItem request does\n not exist.
Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.
\nYou try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).
\nThere are more than 25 requests in the batch.
\nAny individual item in a batch exceeds 400 KB.
\nThe total request size exceeds 16 MB.
\nAny individual items with keys exceeding the key length limits. For a\n partition key, the limit is 2048 bytes and for a sort key, the limit is 1024\n bytes.
\nThe BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of\n data over the network, consisting of up to 25 item put or delete operations. While\n individual items can be up to 400 KB once stored, it's important to note that an item's\n representation might be greater than 400KB while being sent in DynamoDB's JSON format\n for the API call. For more details on this distinction, see Naming Rules and Data Types.
\n BatchWriteItem cannot update items. If you perform a\n BatchWriteItem operation on an existing item, that item's values\n will be overwritten by the operation and it will appear like it was updated. To\n update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.
For tables and indexes with provisioned capacity, if none of the items can be\n processed due to insufficient provisioned throughput on all of the tables in the\n request, then BatchWriteItem returns a\n ProvisionedThroughputExceededException. For all tables and indexes, if\n none of the items can be processed due to other throttling scenarios (such as exceeding\n partition level limits), then BatchWriteItem returns a\n ThrottlingException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nWith BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.
\nIf one or more of the following is true, DynamoDB rejects the entire batch write\n operation:
\nOne or more tables specified in the BatchWriteItem request does\n not exist.
Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.
\nYou try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).
\nThere are more than 25 requests in the batch.
\nAny individual item in a batch exceeds 400 KB.
\nThe total request size exceeds 16 MB.
\nAny individual items with keys exceeding the key length limits. For a\n partition key, the limit is 2048 bytes and for a sort key, the limit is 1024\n bytes.
\nA map of one or more table names or table ARNs and, for each table, a list of operations to be\n performed (DeleteRequest or PutRequest). Each element in the\n map consists of the following:
\n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:
\n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value. For each primary key, you must provide\n all of the key attributes. For example, with a\n simple primary key, you only need to provide a value for the partition\n key. For a composite primary key, you must provide values for\n both the partition key and the sort key.
\n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:
\n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values are rejected with a\n ValidationException exception.
If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.
\nA map of one or more table names or table ARNs and, for each table, a list of\n operations to be performed (DeleteRequest or PutRequest). Each\n element in the map consists of the following:
\n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:
\n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value. For each primary key, you must provide\n all of the key attributes. For example, with a\n simple primary key, you only need to provide a value for the partition\n key. For a composite primary key, you must provide values for\n both the partition key and the sort key.
\n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:
\n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values are rejected with a\n ValidationException exception.
If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.
\nA map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as\n RequestItems, so you can provide this value directly to a subsequent\n BatchWriteItem operation. For more information, see\n RequestItems in the Request Parameters section.
Each UnprocessedItems entry consists of a table name or table ARN and, for that table,\n a list of operations to perform (DeleteRequest or\n PutRequest).
\n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:
\n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value.
\n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:
\n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values will be rejected with a\n ValidationException exception.
If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.
\nIf there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.
A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as\n RequestItems, so you can provide this value directly to a subsequent\n BatchWriteItem operation. For more information, see\n RequestItems in the Request Parameters section.
Each UnprocessedItems entry consists of a table name or table ARN\n and, for that table, a list of operations to perform (DeleteRequest or\n PutRequest).
\n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:
\n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value.
\n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:
\n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values will be rejected with a\n ValidationException exception.
If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.
\nIf there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
", "smithy.api#required": {} } }, @@ -2141,7 +2141,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.
", "smithy.api#required": {} } }, @@ -2203,19 +2203,19 @@ "DeletionProtectionEnabled": { "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", "traits": { - "smithy.api#documentation": "Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
" + "smithy.api#documentation": "Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.
" } }, "ResourcePolicy": { "target": "com.amazonaws.dynamodb#ResourcePolicy", "traits": { - "smithy.api#documentation": "An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
\nWhen you attach a resource-based policy while creating a table, the policy application is strongly consistent.
\nThe maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.
\nYou need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.
An Amazon Web Services resource-based policy document in JSON format that will be\n attached to the table.
\nWhen you attach a resource-based policy while creating a table, the policy application\n is strongly consistent.
\nThe maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this\n limit. For a full list of all considerations that apply for resource-based policies, see\n Resource-based\n policy considerations.
\nYou need to specify the CreateTable and\n PutResourcePolicy\n IAM actions for authorizing a user to create a table with a\n resource-based policy.
Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Sets the maximum number of read and write units for the specified table in on-demand\n capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.
The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table from which to delete the item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, @@ -2658,7 +2658,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Deletes the resource-based policy attached to the resource, which can be a table or stream.
\n\n DeleteResourcePolicy is an idempotent operation; running it multiple times on the same resource doesn't result in an error response, unless you specify an ExpectedRevisionId, which will then return a PolicyNotFoundException.
To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, even if your resource-based policy explicitly denies the root principal's access.\n
\n DeleteResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after running the DeleteResourcePolicy request, DynamoDB might still return the deleted policy. This is because the policy for your resource might not have been deleted yet. Wait for a few seconds, and then try the GetResourcePolicy request again.
Deletes the resource-based policy attached to the resource, which can be a table or\n stream.
\n\n DeleteResourcePolicy is an idempotent operation; running it multiple\n times on the same resource doesn't result in an error response,\n unless you specify an ExpectedRevisionId, which will then return a\n PolicyNotFoundException.
To make sure that you don't inadvertently lock yourself out of your own resources,\n the root principal in your Amazon Web Services account can perform\n DeleteResourcePolicy requests, even if your resource-based policy\n explicitly denies the root principal's access.
\n DeleteResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after running the\n DeleteResourcePolicy request, DynamoDB might still return\n the deleted policy. This is because the policy for your resource might not have been\n deleted yet. Wait for a few seconds, and then try the GetResourcePolicy\n request again.
The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be removed. The resources you can specify include tables and streams. If you remove the policy of a table, it will also remove the permissions for the table's indexes defined in that policy document. This is because index permissions are defined in the table's policy.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be\n removed. The resources you can specify include tables and streams. If you remove the\n policy of a table, it will also remove the permissions for the table's indexes defined\n in that policy document. This is because index permissions are defined in the table's\n policy.
", "smithy.api#required": {} } }, "ExpectedRevisionId": { "target": "com.amazonaws.dynamodb#PolicyRevisionId", "traits": { - "smithy.api#documentation": "A string value that you can use to conditionally delete your policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, the request will fail and return a PolicyNotFoundException.
A string value that you can use to conditionally delete your policy. When you provide\n an expected revision ID, if the revision ID of the existing policy on the resource\n doesn't match or if there's no policy attached to the resource, the request will fail\n and return a PolicyNotFoundException.
A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
\nThis value will be empty if you make a request against a resource without a policy.
" + "smithy.api#documentation": "A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
\nThis value will be empty if you make a request against a resource without a\n policy.
" } } }, @@ -2725,7 +2725,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the\n DELETING state until DynamoDB completes the deletion. If the table is\n in the ACTIVE state, you can delete it. If a table is in\n CREATING or UPDATING states, then DynamoDB returns a\n ResourceInUseException. If the specified table does not exist, DynamoDB\n returns a ResourceNotFoundException. If table is already in the\n DELETING state, no error is returned.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).\n
\nDynamoDB might continue to accept data read and write operations, such as\n GetItem and PutItem, on a table in the\n DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
\nIf you have DynamoDB Streams enabled on the table, then the corresponding stream on\n that table goes into the DISABLED state, and the stream is automatically\n deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the\n DELETING state until DynamoDB completes the deletion. If the table is\n in the ACTIVE state, you can delete it. If a table is in\n CREATING or UPDATING states, then DynamoDB returns a\n ResourceInUseException. If the specified table does not exist, DynamoDB\n returns a ResourceNotFoundException. If table is already in the\n DELETING state, no error is returned.
For global tables, this operation only applies to\n global tables using Version 2019.11.21 (Current version).
\nDynamoDB might continue to accept data read and write operations, such as\n GetItem and PutItem, on a table in the\n DELETING state until the table deletion is complete. For the full\n list of table states, see TableStatus.
When you delete a table, any indexes on that table are also deleted.
\nIf you have DynamoDB Streams enabled on the table, then the corresponding stream on\n that table goes into the DISABLED state, and the stream is automatically\n deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.
", "smithy.api#required": {} } } @@ -2920,7 +2920,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.
", "smithy.api#required": {} } }, @@ -2988,7 +2988,7 @@ "target": "com.amazonaws.dynamodb#DescribeEndpointsResponse" }, "traits": { - "smithy.api#documentation": "Returns the regional endpoint information. For more information \n on policy permissions, please see Internetwork traffic privacy.
" + "smithy.api#documentation": "Returns the regional endpoint information. For more information on policy permissions,\n please see Internetwork traffic privacy.
" } }, "com.amazonaws.dynamodb#DescribeEndpointsRequest": { @@ -3260,7 +3260,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.
", "smithy.api#required": {} } } @@ -3388,7 +3388,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Returns information about the table, including the current status of the table, when\n it was created, the primary key schema, and any indexes on the table.
\nFor global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).\n
\nIf you issue a DescribeTable request immediately after a\n CreateTable request, DynamoDB might return a\n ResourceNotFoundException. This is because\n DescribeTable uses an eventually consistent query, and the metadata\n for your table might not be available at that moment. Wait for a few seconds, and\n then try the DescribeTable request again.
Returns information about the table, including the current status of the table, when\n it was created, the primary key schema, and any indexes on the table.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).
\nIf you issue a DescribeTable request immediately after a\n CreateTable request, DynamoDB might return a\n ResourceNotFoundException. This is because\n DescribeTable uses an eventually consistent query, and the metadata\n for your table might not be available at that moment. Wait for a few seconds, and\n then try the DescribeTable request again.
The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.
", "smithy.api#required": {} } } @@ -3473,7 +3473,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes auto scaling settings across replicas of the global table at once.
\nFor global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
\nDescribes auto scaling settings across replicas of the global table at once.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).
\nThe name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
", "smithy.api#required": {} } } @@ -3537,7 +3537,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.
", "smithy.api#required": {} } } @@ -3630,7 +3630,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Stops replication from the DynamoDB table to the Kinesis data stream. This is done\n without deleting either of the resources.
" + "smithy.api#documentation": "Stops replication from the DynamoDB table to the Kinesis data stream. This\n is done without deleting either of the resources.
" } }, "com.amazonaws.dynamodb#DoubleObject": { @@ -5057,7 +5057,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.
\nFor PartiQL reads (SELECT statement), if the total number of processed\n items exceeds the maximum dataset size limit of 1 MB, the read stops and results are\n returned to the user as a LastEvaluatedKey value to continue the read in a\n subsequent operation. If the filter criteria in WHERE clause does not match\n any data, the read will return an empty result set.
A single SELECT statement response can return up to the maximum number of\n items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any\n filtering to the results using WHERE clause). If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set. If NextToken is present, you need to paginate the result set and include \n NextToken.
This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.
\nFor PartiQL reads (SELECT statement), if the total number of processed\n items exceeds the maximum dataset size limit of 1 MB, the read stops and results are\n returned to the user as a LastEvaluatedKey value to continue the read in a\n subsequent operation. If the filter criteria in WHERE clause does not match\n any data, the read will return an empty result set.
A single SELECT statement response can return up to the maximum number of\n items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any\n filtering to the results using WHERE clause). If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set. If NextToken is present, you need to paginate the result set\n and include NextToken.
An optional parameter that returns the item attributes for an\n ExecuteStatement operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" + "smithy.api#documentation": "An optional parameter that returns the item attributes for an\n ExecuteStatement operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" } } }, @@ -5580,7 +5580,7 @@ "S3BucketOwner": { "target": "com.amazonaws.dynamodb#S3BucketOwner", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.
\nS3BucketOwner is a required parameter when exporting to a S3 bucket in another account.
\nThe ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.
\nS3BucketOwner is a required parameter when exporting to a S3 bucket in another\n account.
\nChoice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.
" + "smithy.api#documentation": "Choice of whether to execute as a full export or incremental export. Valid values are\n FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If\n INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be\n used.
" } }, "IncrementalExportSpecification": { @@ -5839,7 +5839,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table containing the requested item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table containing the requested item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, @@ -5895,7 +5895,7 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
\n\n GetResourcePolicy follows an \n eventually consistent\n model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
Returns the resource-based policy document attached to the resource, which can be a\n table or stream, in JSON format.
\n\n GetResourcePolicy follows an \n eventually consistent\n model. The following list\n describes the outcomes when you issue the GetResourcePolicy request\n immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a\n PutResourcePolicy request, DynamoDB might return a\n PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a\n DeleteResourcePolicy request, DynamoDB might return\n the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a\n CreateTable request, which includes a resource-based policy,\n DynamoDB might return a ResourceNotFoundException or\n a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually\n consistent query, the metadata for your policy or table might not be\n available at that moment. Wait for a few seconds, and then retry the\n GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the\n PutResourcePolicy request, the policy will be applied in the\n authorization of requests to the resource. Because this process is eventually\n consistent, it will take some time to apply the policy to all requests to a resource.\n Policies that you attach while creating a table using the CreateTable\n request will always be applied to all requests for that table.
The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The resources you can specify include tables and streams.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The\n resources you can specify include tables and streams.
", "smithy.api#required": {} } } @@ -5954,7 +5954,7 @@ "Policy": { "target": "com.amazonaws.dynamodb#ResourcePolicy", "traits": { - "smithy.api#documentation": "The resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
" + "smithy.api#documentation": "The resource-based policy document attached to the resource, which can be a table or\n stream, in JSON format.
" } }, "RevisionId": { @@ -7214,7 +7214,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.
", "smithy.api#required": {} } }, @@ -7306,7 +7306,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. \n To list these backups for a given table, specify TableName. ListBackups returns a\n paginated list of results with at most 1 MB worth of items in a page. You can also\n specify a maximum number of entries to be returned in a page.
In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.
\nYou can call ListBackups a maximum of five times per second.
If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the \n Amazon Web Services Backup list API.\n
" + "smithy.api#documentation": "List DynamoDB backups that are associated with an Amazon Web Services account and\n weren't made with Amazon Web Services Backup. To list these backups for a given table,\n specify TableName. ListBackups returns a paginated list of\n results with at most 1 MB worth of items in a page. You can also specify a maximum\n number of entries to be returned in a page.
In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.
\nYou can call ListBackups a maximum of five times per second.
If you want to retrieve the complete list of backups made with Amazon Web Services\n Backup, use the Amazon Web Services Backup\n list API.\n
" } }, "com.amazonaws.dynamodb#ListBackupsInput": { @@ -7315,7 +7315,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "Lists the backups from the table specified in TableName. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Lists the backups from the table specified in TableName. You can also\n provide the Amazon Resource Name (ARN) of the table in this parameter.
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
" + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
" } }, "NextToken": { @@ -8490,7 +8490,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.
When you add an item, the primary key attributes are the only required attributes.\n
\nEmpty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.
\nInvalid Requests with empty values will be rejected with a\n ValidationException exception.
To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.
For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.
Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.
When you add an item, the primary key attributes are the only required attributes.
\nEmpty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.
\nInvalid Requests with empty values will be rejected with a\n ValidationException exception.
To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.
For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.
The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.
", "smithy.api#required": {} } }, @@ -8615,7 +8615,7 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "The capacity units consumed by the PutItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by the PutItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is \n eventually consistent\n .
\n\n PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
\n PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
Attaches a resource-based policy document to the resource, which can be a table or\n stream. When you attach a resource-based policy using this API, the policy application\n is \n eventually consistent\n .
\n\n PutResourcePolicy is an idempotent operation; running it multiple times\n on the same resource using the same policy document will return the same revision ID. If\n you specify an ExpectedRevisionId that doesn't match the current policy's\n RevisionId, the PolicyNotFoundException will be\n returned.
\n PutResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after a\n PutResourcePolicy request, DynamoDB might return your\n previous policy, if there was one, or return the\n PolicyNotFoundException. This is because\n GetResourcePolicy uses an eventually consistent query, and the\n metadata for your policy or table might not be available at that moment. Wait for a\n few seconds, and then try the GetResourcePolicy request again.
The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached. The resources you can specify include tables and streams.
\nYou can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.
The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached.\n The resources you can specify include tables and streams.
\nYou can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.
An Amazon Web Services resource-based policy document in JSON format.
\nThe maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.
\nWithin a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.
\nFor a full list of all considerations that apply while attaching a resource-based policy, see Resource-based policy considerations.
", + "smithy.api#documentation": "An Amazon Web Services resource-based policy document in JSON format.
\nThe maximum size supported for a resource-based policy document is 20 KB.\n DynamoDB counts whitespaces when calculating the size of a policy\n against this limit.
\nWithin a resource-based policy, if the action for a DynamoDB\n service-linked role (SLR) to replicate data for a global table is denied, adding\n or deleting a replica will fail with an error.
\nFor a full list of all considerations that apply while attaching a resource-based\n policy, see Resource-based\n policy considerations.
", "smithy.api#required": {} } }, "ExpectedRevisionId": { "target": "com.amazonaws.dynamodb#PolicyRevisionId", "traits": { - "smithy.api#documentation": "A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.
\nWhen you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.
To conditionally attach a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.
A string value that you can use to conditionally update your policy. You can provide\n the revision ID of your existing policy to make mutating requests against that\n policy.
\nWhen you provide an expected revision ID, if the revision ID of the existing\n policy on the resource doesn't match or if there's no policy attached to the\n resource, your request will be rejected with a\n PolicyNotFoundException.
To conditionally attach a policy when no policy exists for the resource, specify\n NO_POLICY for the revision ID.
Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future.
Set this parameter to true to confirm that you want to remove your\n permissions to change the policy of this resource in the future.
The name of the table containing the requested items. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table containing the requested items. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, @@ -8818,7 +8818,7 @@ "Select": { "target": "com.amazonaws.dynamodb#Select", "traits": { - "smithy.api#documentation": "The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.
\n\n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.
\n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.
\n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read capacity units \n as getting the items, and is subject to the same item size calculations.
\n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.
If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation will read only the index and not\n the table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.
\nIf you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.
\nIf neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)
If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.
The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.
\n\n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.
\n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.
\n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read\n capacity units as getting the items, and is subject to the same item size\n calculations.
\n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.
If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation will read only the index and not\n the table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.
\nIf you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.
\nIf neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)
If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.
A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.
" } }, "KeyConditionExpression": { @@ -8928,7 +8928,7 @@ "target": "com.amazonaws.dynamodb#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.
If you did not use a filter in the request, then ScannedCount is the same\n as Count.
The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.
If you did not use a filter in the request, then ScannedCount is the same\n as Count.
The capacity units consumed by the Query operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by the Query operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.
Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time during the last 35 days. Any number of\n users can execute up to 50 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.
\nAlong with data, the following are also included on the new restored table using\n point in time recovery:
\nGlobal secondary indexes (GSIs)
\nLocal secondary indexes (LSIs)
\nProvisioned read and write capacity
\nEncryption settings
\nAll these settings come from the current settings of the source table at\n the time of restore.
\nYou must manually set up the following on the restored table:
\nAuto scaling policies
\nIAM policies
\nAmazon CloudWatch metrics and alarms
\nTags
\nStream settings
\nTime to Live (TTL) settings
\nPoint in time recovery settings
\nRestores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time during the last 35 days. Any number of\n users can execute up to 50 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.
\nAlong with data, the following are also included on the new restored table using point\n in time recovery:
\nGlobal secondary indexes (GSIs)
\nLocal secondary indexes (LSIs)
\nProvisioned read and write capacity
\nEncryption settings
\nAll these settings come from the current settings of the source table at\n the time of restore.
\nYou must manually set up the following on the restored table:
\nAuto scaling policies
\nIAM policies
\nAmazon CloudWatch metrics and alarms
\nTags
\nStream settings
\nTime to Live (TTL) settings
\nPoint in time recovery settings
\nThe Scan operation returns one or more items and item attributes by\n accessing every item in a table or a secondary index. To have DynamoDB return fewer\n items, you can provide a FilterExpression operation.
If the total size of scanned items exceeds the maximum dataset size limit of 1 MB,\n the scan completes and results are returned to the user. The LastEvaluatedKey \n value is also returned and the requestor can use the LastEvaluatedKey to continue \n the scan in a subsequent operation. Each scan response also includes number of items that were \n scanned (ScannedCount) as part of the request. If using a FilterExpression, a scan result \n can result in no items meeting the criteria and the Count will result in zero. If \n you did not use a FilterExpression in the scan request, then Count is \n the same as ScannedCount.
\n Count and ScannedCount only return the count of items specific to a \n single scan request and, unless the table is less than 1MB, do not represent the total number \n of items in the table.\n
A single Scan operation first reads up to the maximum number of items set (if\n using the Limit parameter) or a maximum of 1 MB of data and then applies any\n filtering to the results if a FilterExpression is provided. If\n LastEvaluatedKey is present in the response, pagination is required to complete the\n full table scan. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.
\n Scan operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan\n operation by providing the Segment and TotalSegments\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.
By default, a Scan uses eventually consistent reads when accessing the items in a table. \n Therefore, the results from an eventually consistent Scan may not include the latest item \n changes at the time the scan iterates through each item in the table. If you require a strongly consistent \n read of each item as the scan iterates through the items in the table, you can set the ConsistentRead \n parameter to true. Strong consistency only relates to the consistency of the read at the item level.
\n DynamoDB does not provide snapshot isolation for a scan operation when the ConsistentRead \n parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan \n see a consistent snapshot of the table when the scan operation was requested.\n
The Scan operation returns one or more items and item attributes by\n accessing every item in a table or a secondary index. To have DynamoDB return fewer\n items, you can provide a FilterExpression operation.
If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan completes and results are returned to the user. The LastEvaluatedKey\n value is also returned and the requestor can use the LastEvaluatedKey to\n continue the scan in a subsequent operation. Each scan response also includes number of\n items that were scanned (ScannedCount) as part of the request. If using a\n FilterExpression, a scan result can result in no items meeting the\n criteria and the Count will result in zero. If you did not use a\n FilterExpression in the scan request, then Count is the\n same as ScannedCount.
\n Count and ScannedCount only return the count of items\n specific to a single scan request and, unless the table is less than 1MB, do not\n represent the total number of items in the table.
A single Scan operation first reads up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then\n applies any filtering to the results if a FilterExpression is provided. If\n LastEvaluatedKey is present in the response, pagination is required to\n complete the full table scan. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.
\n Scan operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan\n operation by providing the Segment and TotalSegments\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.
By default, a Scan uses eventually consistent reads when accessing the\n items in a table. Therefore, the results from an eventually consistent Scan\n may not include the latest item changes at the time the scan iterates through each item\n in the table. If you require a strongly consistent read of each item as the scan\n iterates through the items in the table, you can set the ConsistentRead\n parameter to true. Strong consistency only relates to the consistency of the read at the\n item level.
DynamoDB does not provide snapshot isolation for a scan operation when the\n ConsistentRead parameter is set to true. Thus, a DynamoDB scan\n operation does not guarantee that all reads in a scan see a consistent snapshot of\n the table when the scan operation was requested.
The name of the table containing the requested items or if you provide\n IndexName, the name of the table to which that index belongs.
You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table containing the requested items or if you provide\n IndexName, the name of the table to which that index belongs.
You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, @@ -10337,7 +10337,7 @@ "Select": { "target": "com.amazonaws.dynamodb#Select", "traits": { - "smithy.api#documentation": "The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.
\n\n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.
\n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.
\n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read capacity units \n as getting the items, and is subject to the same item size calculations.
\n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.
If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation reads only the index and not the\n table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.
\nIf you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.
\nIf neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)
If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.
The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.
\n\n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.
\n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.
\n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read\n capacity units as getting the items, and is subject to the same item size\n calculations.
\n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.
If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation reads only the index and not the\n table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.
\nIf you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.
\nIf neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)
If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.
A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeNames": { @@ -10441,7 +10441,7 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "The capacity units consumed by the Scan operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see \n Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
The capacity units consumed by the Scan operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
", "smithy.api#required": {} } }, @@ -11744,7 +11744,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
", "smithy.api#required": {} } }, @@ -11854,7 +11854,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Adds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.
\nThis documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
\nTo determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
\n\n For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version\n 2019.11.21 you can use UpdateTable instead.\n
\n\n Although you can use UpdateGlobalTable to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.\n
If global secondary indexes are specified, then the following conditions must also be\n met:
\nThe global secondary indexes must have the same name.
\nThe global secondary indexes must have the same hash key and sort key (if\n present).
\nThe global secondary indexes must have the same provisioned and maximum write\n capacity units.
\nAdds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.
\nThis documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
\nTo determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version). If you are using global tables Version\n 2019.11.21 you can use UpdateTable instead.
\n Although you can use UpdateGlobalTable to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be\n met:
\nThe global secondary indexes must have the same name.
\nThe global secondary indexes must have the same hash key and sort key (if\n present).
\nThe global secondary indexes must have the same provisioned and maximum write\n capacity units.
\nThe name of the table containing the item to update. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table containing the item to update. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, @@ -12122,7 +12122,7 @@ "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "Use ReturnValues if you want to get the item attributes as they appear\n before or after they are successfully updated. For UpdateItem, the valid values\n are:
\n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)
\n ALL_OLD - Returns all of the attributes of the item, as they\n appeared before the UpdateItem operation.
\n UPDATED_OLD - Returns only the updated attributes, as they appeared\n before the UpdateItem operation.
\n ALL_NEW - Returns all of the attributes of the item, as they appear\n after the UpdateItem operation.
\n UPDATED_NEW - Returns only the updated attributes, as they appear\n after the UpdateItem operation.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
\nThe values returned are strongly consistent.
" + "smithy.api#documentation": "Use ReturnValues if you want to get the item attributes as they appear\n before or after they are successfully updated. For UpdateItem, the valid\n values are:
\n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)
\n ALL_OLD - Returns all of the attributes of the item, as they\n appeared before the UpdateItem operation.
\n UPDATED_OLD - Returns only the updated attributes, as they appeared\n before the UpdateItem operation.
\n ALL_NEW - Returns all of the attributes of the item, as they appear\n after the UpdateItem operation.
\n UPDATED_NEW - Returns only the updated attributes, as they appear\n after the UpdateItem operation.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
\nThe values returned are strongly consistent.
" } }, "ReturnConsumedCapacity": { @@ -12161,7 +12161,7 @@ "ReturnValuesOnConditionCheckFailure": { "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { - "smithy.api#documentation": "An optional parameter that returns the item attributes for an UpdateItem operation that failed a\n condition check.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" + "smithy.api#documentation": "An optional parameter that returns the item attributes for an UpdateItem\n operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" } } }, @@ -12176,13 +12176,13 @@ "Attributes": { "target": "com.amazonaws.dynamodb#AttributeMap", "traits": { - "smithy.api#documentation": "A map of attribute values as they appear before or after the UpdateItem\n operation, as determined by the ReturnValues parameter.
The Attributes map is only present if the update was successful and ReturnValues was\n specified as something other than NONE in the request. Each element\n represents one attribute.
A map of attribute values as they appear before or after the UpdateItem\n operation, as determined by the ReturnValues parameter.
The Attributes map is only present if the update was successful and\n ReturnValues was specified as something other than NONE in\n the request. Each element represents one attribute.
The capacity units consumed by the UpdateItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by the UpdateItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.
The table name for the Kinesis streaming destination input. You can also provide the ARN of the table in this parameter.
", + "smithy.api#documentation": "The table name for the Kinesis streaming destination input. You can also provide the\n ARN of the table in this parameter.
", "smithy.api#required": {} } }, @@ -12377,7 +12377,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.
\nFor global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).\n
\nYou can only perform one of the following operations at once:
\nModify the provisioned throughput settings of the table.
\nRemove a global secondary index from the table.
\nCreate a new global secondary index on the table. After the index begins\n backfilling, you can use UpdateTable to perform other\n operations.
\n UpdateTable is an asynchronous operation; while it's executing, the table\n status changes from ACTIVE to UPDATING. While it's\n UPDATING, you can't issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).
\nYou can only perform one of the following operations at once:
\nModify the provisioned throughput settings of the table.
\nRemove a global secondary index from the table.
\nCreate a new global secondary index on the table. After the index begins\n backfilling, you can use UpdateTable to perform other\n operations.
\n UpdateTable is an asynchronous operation; while it's executing, the table\n status changes from ACTIVE to UPDATING. While it's\n UPDATING, you can't issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.
", "smithy.api#required": {} } }, @@ -12429,7 +12429,7 @@ "ReplicaUpdates": { "target": "com.amazonaws.dynamodb#ReplicationGroupUpdateList", "traits": { - "smithy.api#documentation": "A list of replica update actions (create, delete, or update) for the table.
\nFor global tables, this property only applies to global tables using Version 2019.11.21 (Current version). \n
\nA list of replica update actions (create, delete, or update) for the table.
\nFor global tables, this property only applies to global tables using Version\n 2019.11.21 (Current version).
\nIndicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
" + "smithy.api#documentation": "Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.
" } }, "OnDemandThroughput": { "target": "com.amazonaws.dynamodb#OnDemandThroughput", "traits": { - "smithy.api#documentation": "Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Updates the maximum number of read and write units for the specified table in\n on-demand capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Updates auto scaling settings on your global tables at once.
\nFor global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).\n
\nUpdates auto scaling settings on your global tables at once.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).
\nThe name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.
", "smithy.api#required": {} } }, @@ -12579,7 +12579,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#documentation": "The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/iotsitewise.json b/codegen/sdk-codegen/aws-models/iotsitewise.json index f890604ec69..08b07a73f06 100644 --- a/codegen/sdk-codegen/aws-models/iotsitewise.json +++ b/codegen/sdk-codegen/aws-models/iotsitewise.json @@ -1489,7 +1489,7 @@ "id": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "\n The ID of the asset composite model.\n
" + "smithy.api#documentation": "The ID of the asset composite model.
" } }, "externalId": { @@ -1548,7 +1548,7 @@ "externalId": { "target": "com.amazonaws.iotsitewise#ExternalId", "traits": { - "smithy.api#documentation": "An external ID to assign to the asset model.
\nIf the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using \n UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
An external ID to assign to the asset model.
\nIf the composite model is a derived composite model, or one nested inside a component\n model, you can only set the external ID using UpdateAssetModelCompositeModel and\n specifying the derived ID of the model or property from the created model it's a part\n of.
The external ID of the hierarchy, if it has one. When you update an asset hierarchy,\n you may assign an external ID if it doesn't already have one. You can't change the external ID\n of an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + "smithy.api#documentation": "The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you\n may assign an external ID if it doesn't already have one. You can't change the external ID of\n an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } } }, @@ -1724,7 +1724,7 @@ "id": { "target": "com.amazonaws.iotsitewise#CustomID", "traits": { - "smithy.api#documentation": "\n The ID of the asset model composite model.\n
" + "smithy.api#documentation": "The ID of the asset model composite model.
" } }, "externalId": { @@ -1828,7 +1828,7 @@ "id": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "The ID of the the composite model that this summary describes..
", + "smithy.api#documentation": "The ID of the composite model that this summary describes..
", "smithy.api#required": {} } }, @@ -1841,21 +1841,21 @@ "name": { "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "The name of the the composite model that this summary describes..
", + "smithy.api#documentation": "The name of the composite model that this summary describes..
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "The type of asset model.
\n\n ASSET_MODEL – (default) An asset model that you can use to create assets.\n Can't be included as a component in another asset model.
\n\n COMPONENT_MODEL – A reusable component that you can include in the composite\n models of other asset models. You can't create assets directly from this type of asset model.
\nThe composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
The description of the the composite model that this summary describes..
" + "smithy.api#documentation": "The description of the composite model that this summary describes..
" } }, "path": { @@ -1887,7 +1887,7 @@ "id": { "target": "com.amazonaws.iotsitewise#CustomID", "traits": { - "smithy.api#documentation": "The ID of the asset model hierarchy. This ID is a hierarchyId.
If you are callling UpdateAssetModel\n to create a new hierarchy: You can specify its ID here, if desired.\n IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.\n However, if you prefer to supply your own ID instead, you can specify it here in UUID format.\n If you specify your own ID, it must be globally unique.
\nIf you are calling UpdateAssetModel to modify an existing\n hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The ID of the asset model hierarchy. This ID is a hierarchyId.
If you are callling UpdateAssetModel to create a\n new hierarchy: You can specify its ID here, if desired.\n IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.\n However, if you prefer to supply your own ID instead, you can specify it here in UUID format.\n If you specify your own ID, it must be globally unique.
\nIf you are calling UpdateAssetModel to modify an existing\n hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the\n childAssetModelId asset model. IoT SiteWise will always return the actual\n asset model ID for this value. However, when you are specifying this value as part of a call to\n UpdateAssetModel, you may provide either the asset model ID or else externalId:\n followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.\n
The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the\n childAssetModelId asset model. IoT SiteWise will always return the actual\n asset model ID for this value. However, when you are specifying this value as part of a call to\n UpdateAssetModel, you may provide either the asset model ID or else externalId:\n followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.\n
An external ID to assign to the asset model hierarchy. The external ID must be unique among\n asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + "smithy.api#documentation": "An external ID to assign to the asset model hierarchy. The external ID must be unique\n among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } } }, @@ -1967,7 +1967,7 @@ "id": { "target": "com.amazonaws.iotsitewise#CustomID", "traits": { - "smithy.api#documentation": "The ID of the asset model property.
\nIf you are callling UpdateAssetModel\n to create a new property: You can specify its ID here, if desired.\n IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.\n However, if you prefer to supply your own ID instead, you can specify it here in UUID format.\n If you specify your own ID, it must be globally unique.
\nIf you are calling UpdateAssetModel to modify an existing\n property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The ID of the asset model property.
\nIf you are callling UpdateAssetModel to create a\n new property: You can specify its ID here, if desired.\n IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.\n However, if you prefer to supply your own ID instead, you can specify it here in UUID format.\n If you specify your own ID, it must be globally unique.
\nIf you are calling UpdateAssetModel to modify an existing\n property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
\n The ID of the composite model that contains the asset model property.\n
" + "smithy.api#documentation": "The ID of the composite model that contains the asset model property.
" } }, "path": { @@ -2461,7 +2461,7 @@ "unit": { "target": "com.amazonaws.iotsitewise#PropertyUnit", "traits": { - "smithy.api#documentation": "\n The unit of measure (such as Newtons or RPM) of the asset property.\n
" + "smithy.api#documentation": "The unit of measure (such as Newtons or RPM) of the asset property.
" } }, "notification": { @@ -2470,7 +2470,7 @@ "assetCompositeModelId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "\n The ID of the composite model that contains the asset property.\n
" + "smithy.api#documentation": "The ID of the composite model that contains the asset property.
" } }, "path": { @@ -2763,7 +2763,7 @@ "hierarchyId": { "target": "com.amazonaws.iotsitewise#CustomID", "traits": { - "smithy.api#documentation": "The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow different groupings\n of assets to be formed that all come from the same asset model. For more information, see\n Asset hierarchies in the IoT SiteWise User Guide.
The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow\n different groupings of assets to be formed that all come from the same asset model. For more\n information, see Asset hierarchies in the IoT SiteWise User Guide.
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs\n first.
\nThe size of the result set is equal to 1 MB.
\nThe number of data points in the result set is equal to the value of\n maxResults. The maximum value of maxResults is 4000.
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs\n first.
\nThe size of the result set is equal to 1 MB.
\nThe number of data points in the result set is equal to the value of\n maxResults. The maximum value of maxResults is 4000.
\n The ID of the composite model that contains the property.\n
" + "smithy.api#documentation": "The ID of the composite model that contains the property.
" } }, "externalId": { @@ -4490,7 +4496,7 @@ } }, "traits": { - "smithy.api#documentation": "Metadata for the composition relationship established by using composedAssetModelId in \n CreateAssetModelCompositeModel\n .
Metadata for the composition relationship established by using\n composedAssetModelId in \n CreateAssetModelCompositeModel\n .
Represents a composite model that composed an asset model of type COMPONENT_MODEL.
Represents a composite model that composed an asset model of type\n COMPONENT_MODEL.
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
The composite model type. Valid values are AWS/ALARM, CUSTOM, or\n AWS/L4E_ANOMALY.
Creates an asset model from specified property and hierarchy definitions. You create\n assets from asset models. With asset models, you can easily create assets of the same type\n that have standardized definitions. Each asset created from a model inherits the asset model's\n property and hierarchy definitions. For more information, see Defining asset models in the\n IoT SiteWise User Guide.
\nYou can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL.
\n ASSET_MODEL – (default) An asset model that you can use to create assets.\n Can't be included as a component in another asset model.
\n\n COMPONENT_MODEL – A reusable component that you can include in the composite\n models of other asset models. You can't create assets directly from this type of asset model.
\nCreates an asset model from specified property and hierarchy definitions. You create\n assets from asset models. With asset models, you can easily create assets of the same type\n that have standardized definitions. Each asset created from a model inherits the asset model's\n property and hierarchy definitions. For more information, see Defining asset models in the\n IoT SiteWise User Guide.
\nYou can create two types of asset models, ASSET_MODEL or\n COMPONENT_MODEL.
\n ASSET_MODEL – (default) An asset model that\n you can use to create assets. Can't be included as a component in another asset\n model.
\n\n COMPONENT_MODEL – A reusable component that\n you can include in the composite models of other asset models. You can't create\n assets directly from this type of asset model.
\nCreates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models,\n inline and component-model-based.
Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name,\n a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced\n component model provides its associated properties to any created assets. For more information, see\n Custom composite models (Components) in the\n IoT SiteWise User Guide.
\nUse inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are\n included and can't be used to create multiple assets.
\nTo create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.
To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.
Creates a custom composite model from specified property and hierarchy definitions. There\n are two types of custom composite models, inline and\n component-model-based.
Use component-model-based custom composite models to define standard, reusable components.\n A component-model-based custom composite model consists of a name, a description, and the ID\n of the component model it references. A component-model-based custom composite model has no\n properties of its own; its referenced component model provides its associated properties to\n any created assets. For more information, see Custom composite models (Components)\n in the IoT SiteWise User Guide.
\nUse inline custom composite models to organize the properties of an asset model. The\n properties of inline custom composite models are local to the asset model where they are\n included and can't be used to create multiple assets.
\nTo create a component-model-based model, specify the composedAssetModelId of\n an existing asset model with assetModelType of\n COMPONENT_MODEL.
To create an inline model, specify the assetModelCompositeModelProperties and\n don't include an composedAssetModelId.
An external ID to assign to the composite model.
\nIf the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using \n UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
An external ID to assign to the composite model.
\nIf the composite model is a derived composite model, or one nested inside a component\n model, you can only set the external ID using UpdateAssetModelCompositeModel and\n specifying the derived ID of the model or property from the created model it's a part\n of.
The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, \n if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
" + "smithy.api#documentation": "The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this\n parameter is never required. However, if you prefer to supply your own ID instead, you can\n specify it here in UUID format. If you specify your own ID, it must be globally unique.
" } }, "assetModelCompositeModelDescription": { @@ -4938,7 +4945,7 @@ "assetModelCompositeModelName": { "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "A unique, friendly name for the composite model.
", + "smithy.api#documentation": "A unique name for the composite model.
", "smithy.api#required": {} } }, @@ -4959,13 +4966,13 @@ "composedAssetModelId": { "target": "com.amazonaws.iotsitewise#CustomID", "traits": { - "smithy.api#documentation": "The ID of a composite model on this asset.
" + "smithy.api#documentation": "The ID of a component model which is reused to create this composite model.
" } }, "assetModelCompositeModelProperties": { "target": "com.amazonaws.iotsitewise#AssetModelPropertyDefinitions", "traits": { - "smithy.api#documentation": "The property definitions of the composite model. For more information, see .
\nYou can specify up to 200 properties per composite model. For more\n information, see Quotas in the IoT SiteWise User Guide.
" + "smithy.api#documentation": "The property definitions of the composite model. For more information, see \n Inline custom composite models in the IoT SiteWise User Guide.
\nYou can specify up to 200 properties per composite model. For more\n information, see Quotas in the IoT SiteWise User Guide.
" } } }, @@ -4979,7 +4986,7 @@ "assetModelCompositeModelId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.
", + "smithy.api#documentation": "The ID of the composed asset model. You can use this ID when you call other IoT SiteWise\n APIs.
", "smithy.api#required": {} } }, @@ -5007,7 +5014,7 @@ "assetModelName": { "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "A unique, friendly name for the asset model.
", + "smithy.api#documentation": "A unique name for the asset model.
", "smithy.api#required": {} } }, @@ -5032,7 +5039,7 @@ "assetModelCompositeModels": { "target": "com.amazonaws.iotsitewise#AssetModelCompositeModelDefinitions", "traits": { - "smithy.api#documentation": "The composite models that are part of this asset model. It groups properties\n (such as attributes, measurements, transforms, and metrics) and child composite models that\n model parts of your industrial equipment. Each composite model has a type that defines the\n properties that the composite model supports. Use composite models to define alarms on this asset model.
\nWhen creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information,\n see .
\nThe composite models that are part of this asset model. It groups properties\n (such as attributes, measurements, transforms, and metrics) and child composite models that\n model parts of your industrial equipment. Each composite model has a type that defines the\n properties that the composite model supports. Use composite models to define alarms on this asset model.
\nWhen creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information,\n see Creating custom composite models (Components) in the\n IoT SiteWise User Guide.
\nDefines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a\n bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
\nBefore you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier.\n For more information about how to configure storage settings, see PutStorageConfiguration.
\nBulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on \n IoT SiteWise warm or cold tier storage.
\nDefines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a\n bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
\nBefore you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier.\n For more information about how to configure storage settings, see PutStorageConfiguration.
\nBulk import is designed to store historical data to IoT SiteWise. It does not trigger\n computations or notifications on IoT SiteWise warm or cold tier storage.
\nA unique, friendly name for the gateway.
", + "smithy.api#documentation": "A unique name for the gateway.
", "smithy.api#required": {} } }, @@ -5864,7 +5871,7 @@ "scalarValue": { "target": "com.amazonaws.iotsitewise#ScalarValue", "traits": { - "smithy.api#documentation": "Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
" + "smithy.api#documentation": "Indicates if the data point is a scalar value such as integer, string, double, or Boolean.\n
" } }, "arrayValue": { @@ -6067,7 +6074,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a composite model. This action can't be undone. You must delete all assets created\n from a composite model before you can delete the model. Also, you can't delete a composite model if\n a parent asset model exists that contains a property formula expression that depends on the\n asset model that you want to delete. For more information, see Deleting assets and models in the\n IoT SiteWise User Guide.
", + "smithy.api#documentation": "Deletes a composite model. This action can't be undone. You must delete all assets created\n from a composite model before you can delete the model. Also, you can't delete a composite\n model if a parent asset model exists that contains a property formula expression that depends\n on the asset model that you want to delete. For more information, see Deleting assets and\n models in the IoT SiteWise User Guide.
", "smithy.api#endpoint": { "hostPrefix": "api." }, @@ -6279,6 +6286,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, { "target": "com.amazonaws.iotsitewise#InternalFailureException" }, @@ -6829,7 +6839,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call \n DescribeAssetModelCompositeModel.
Retrieves information about an asset composite model (also known as an asset component).\n An AssetCompositeModel is an instance of an\n AssetModelCompositeModel. If you want to see information about the model this is\n based on, call DescribeAssetModelCompositeModel.
An external ID to assign to the asset model.
\nIf the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using \n UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
An external ID to assign to the asset model.
\nIf the composite model is a component-based composite model, or one nested inside a\n component model, you can only set the external ID using\n UpdateAssetModelCompositeModel and specifying the derived ID of the model or\n property from the created model it's a part of.
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
The composite model type. Valid values are AWS/ALARM, CUSTOM, or\n AWS/L4E_ANOMALY.
Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
", + "smithy.api#documentation": "Retrieves information about an asset model composite model (also known as an asset model\n component). For more information, see Custom composite models\n (Components) in the IoT SiteWise User Guide.
", "smithy.api#endpoint": { "hostPrefix": "api." }, @@ -7117,7 +7127,7 @@ "assetModelCompositeModelType": { "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
The composite model type. Valid values are AWS/ALARM, CUSTOM, or\n AWS/L4E_ANOMALY.
Metadata for the composition relationship established by using composedAssetModelId in \n CreateAssetModelCompositeModel\n .\n For instance, an array detailing the path of the composition relationship for this composite model.
Metadata for the composition relationship established by using\n composedAssetModelId in \n CreateAssetModelCompositeModel\n . For instance, an array detailing the\n path of the composition relationship for this composite model.
\n Whether or not to exclude asset model properties from the response.\n
", + "smithy.api#documentation": "Whether or not to exclude asset model properties from the response.
", "smithy.api#httpQuery": "excludeProperties" } } @@ -7224,7 +7234,7 @@ "assetModelCompositeModels": { "target": "com.amazonaws.iotsitewise#AssetModelCompositeModels", "traits": { - "smithy.api#documentation": "The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
The list of built-in composite models for the asset model, such as those with those of\n type AWS/ALARMS.
The list of the immediate child custom composite model summaries for the asset model.
" + "smithy.api#documentation": "The list of the immediate child custom composite model summaries for the asset\n model.
" } }, "assetModelExternalId": { @@ -7362,7 +7372,7 @@ "compositeModel": { "target": "com.amazonaws.iotsitewise#CompositeModelProperty", "traits": { - "smithy.api#documentation": "The composite model that declares this asset property, if this asset property exists\n in a composite model.
" + "smithy.api#documentation": "The composite model that declares this asset property, if this asset property exists in a\n composite model.
" } }, "assetExternalId": { @@ -7391,7 +7401,7 @@ "target": "com.amazonaws.iotsitewise#ExcludeProperties", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "\n Whether or not to exclude asset properties from the response.\n
", + "smithy.api#documentation": "Whether or not to exclude asset properties from the response.
", "smithy.api#httpQuery": "excludeProperties" } } @@ -7962,7 +7972,7 @@ } }, "gatewayName": { - "target": "com.amazonaws.iotsitewise#Name", + "target": "com.amazonaws.iotsitewise#GatewayName", "traits": { "smithy.api#documentation": "The name of the gateway.
", "smithy.api#required": {} @@ -8689,7 +8699,7 @@ "assetId": { "target": "com.amazonaws.iotsitewise#CustomID", "traits": { - "smithy.api#documentation": "The ID of the parent asset from which to disassociate the child asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The ID of the parent asset from which to disassociate the child asset.\n This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow different groupings\n of assets to be formed that all come from the same asset model. You can use the hierarchy ID\n to identify the correct asset to disassociate. For more information, see\n Asset hierarchies in the IoT SiteWise User Guide.
The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow\n different groupings of assets to be formed that all come from the same asset model. You can\n use the hierarchy ID to identify the correct asset to disassociate. For more information, see\n Asset hierarchies in the IoT SiteWise User Guide.
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
", + "smithy.api#documentation": "Run SQL queries to retrieve metadata and time-series data from asset models, assets,\n measurements, metrics, transforms, and aggregates.
", "smithy.api#endpoint": { "hostPrefix": "data." }, @@ -9299,6 +9309,16 @@ "smithy.api#documentation": "Contains a summary of a gateway capability configuration.
" } }, + "com.amazonaws.iotsitewise#GatewayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[^\\u0000-\\u001F\\u007F]+$" + } + }, "com.amazonaws.iotsitewise#GatewayPlatform": { "type": "structure", "members": { @@ -9313,6 +9333,12 @@ "traits": { "smithy.api#documentation": "A gateway that runs on IoT Greengrass V2.
" } + }, + "siemensIE": { + "target": "com.amazonaws.iotsitewise#SiemensIE", + "traits": { + "smithy.api#documentation": "A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
" + } } }, "traits": { @@ -9336,9 +9362,9 @@ } }, "gatewayName": { - "target": "com.amazonaws.iotsitewise#Name", + "target": "com.amazonaws.iotsitewise#GatewayName", "traits": { - "smithy.api#documentation": "The name of the asset.
", + "smithy.api#documentation": "The name of the gateway.
", "smithy.api#required": {} } }, @@ -9493,7 +9519,7 @@ "maxResults": { "target": "com.amazonaws.iotsitewise#GetAssetPropertyValueAggregatesMaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs\n first.
\nThe size of the result set is equal to 1 MB.
\nThe number of data points in the result set is equal to the value of\n maxResults. The maximum value of maxResults is 2500.
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs\n first.
\nThe size of the result set is equal to 1 MB.
\nThe number of data points in the result set is equal to the value of\n maxResults. The maximum value of maxResults is 2500.
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs\n first.
\nThe size of the result set is equal to 4 MB.
\nThe number of data points in the result set is equal to the value of\n maxResults. The maximum value of maxResults is 20000.
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs\n first.
\nThe size of the result set is equal to 4 MB.
\nThe number of data points in the result set is equal to the value of\n maxResults. The maximum value of maxResults is 20000.
The ARN of the Greengrass group. For more information about how to find a group's\n ARN, see ListGroups and GetGroup in the\n IoT Greengrass API Reference.
", + "smithy.api#documentation": "The ARN of the Greengrass group. For more information about how to find a group's\n ARN, see ListGroups and GetGroup in the IoT Greengrass V1\n API Reference.
", "smithy.api#required": {} } } @@ -9949,7 +9975,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass\n V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass\n device role must use the AWSIoTSiteWiseEdgeAccess policy. For more\n information, see Using IoT SiteWise at the edge in the\n IoT SiteWise User Guide.
Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2,\n you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass\n device role must use the AWSIoTSiteWiseEdgeAccess policy. For more\n information, see Using IoT SiteWise at the edge in the\n IoT SiteWise User Guide.
Contains an identity that can access an IoT SiteWise Monitor resource.
\nCurrently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can find the\n IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
\nContains an identity that can access an IoT SiteWise Monitor resource.
\nCurrently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can\n find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
\nFilters the requested list of asset properties. You can choose one of the following\n options:
\n\n ALL – The list includes all asset properties for a given asset\n model ID.
\n BASE – The list includes only base asset properties for a given\n asset model ID.
Default: BASE\n
Filters the requested list of asset properties. You can choose one of the following\n options:
\n\n ALL – The list includes all asset properties for a given asset model ID.\n
\n BASE – The list includes only base asset properties for a given asset\n model ID.
Default: BASE\n
The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) To find a\n hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This\n parameter is required if you choose CHILD for\n traversalDirection.
For more information, see Asset hierarchies in the IoT SiteWise User Guide.
", + "smithy.api#documentation": "The ID of the hierarchy by which child assets are associated to the asset.\n (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose\n CHILD for traversalDirection.
For more information, see Asset hierarchies in the IoT SiteWise User Guide.
", "smithy.api#httpQuery": "hierarchyId" } }, @@ -11476,7 +11512,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
Retrieves a paginated list of composition relationships for an asset model of type\n COMPONENT_MODEL.
The name of the IoT Thing for your SiteWise Edge gateway.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
" + } + }, "com.amazonaws.iotsitewise#StorageType": { "type": "enum", "members": { @@ -14135,7 +14186,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an asset model and all of the assets that were created from the model. Each asset\n created from the model inherits the updated asset model's property and hierarchy definitions.\n For more information, see Updating assets and models in the\n IoT SiteWise User Guide.
\nThis operation overwrites the existing model with the provided model. To avoid deleting\n your asset model's properties or hierarchies, you must include their IDs and definitions in\n the updated asset model payload. For more information, see DescribeAssetModel.
\nIf you remove a property from an asset model, IoT SiteWise deletes all previous data for that\n property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every\n asset associated with that hierarchy. You can't change the type or data type of an existing\n property.
\nUpdates an asset model and all of the assets that were created from the model. Each asset\n created from the model inherits the updated asset model's property and hierarchy definitions.\n For more information, see Updating assets and models in the\n IoT SiteWise User Guide.
\nIf you remove a property from an asset model, IoT SiteWise deletes all previous data for that\n property. You can’t change the type or data type of an existing property.
\nTo replace an existing asset model property with a new one with the same\n name, do the following:
Submit an UpdateAssetModel request with the entire existing property\n removed.
Submit a second UpdateAssetModel request that includes the new\n property. The new asset property will have the same name as the previous\n one and IoT SiteWise will generate a new unique id.
Updates a composite model and all of the assets that were created from the model. Each asset\n created from the model inherits the updated asset model's property and hierarchy definitions.\n For more information, see Updating assets and models in the\n IoT SiteWise User Guide.
\nIf you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.
\nTo replace an existing composite asset model property with a new one with the same name, do the following:
Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.
Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same\n name as the previous one and IoT SiteWise will generate a new unique id.
Updates a composite model and all of the assets that were created from the model. Each\n asset created from the model inherits the updated asset model's property and hierarchy\n definitions. For more information, see Updating assets and models in the\n IoT SiteWise User Guide.
\nIf you remove a property from a composite asset model, IoT SiteWise deletes all previous data\n for that property. You can’t change the type or data type of an existing property.
\nTo replace an existing composite asset model property with a new one with the same\n name, do the following:
Submit an UpdateAssetModelCompositeModel request with the entire\n existing property removed.
Submit a second UpdateAssetModelCompositeModel request that includes\n the new property. The new asset property will have the same name as the\n previous one and IoT SiteWise will generate a new unique id.
An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to \n the exact same thing as when it was created.
" + "smithy.api#documentation": "An external ID to assign to the asset model. You can only set the external ID of the asset\n model if it wasn't set when it was created, or you're setting it to the exact same thing as\n when it was created.
" } }, "assetModelCompositeModelDescription": { @@ -14223,7 +14274,7 @@ "assetModelCompositeModelName": { "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "A unique, friendly name for the composite model.
", + "smithy.api#documentation": "A unique name for the composite model.
", "smithy.api#required": {} } }, @@ -14237,7 +14288,7 @@ "assetModelCompositeModelProperties": { "target": "com.amazonaws.iotsitewise#AssetModelProperties", "traits": { - "smithy.api#documentation": "The property definitions of the composite model. For more information, see .
\nYou can specify up to 200 properties per composite model. For more\n information, see Quotas in the IoT SiteWise User Guide.
" + "smithy.api#documentation": "The property definitions of the composite model. For more information, see \n Inline custom composite models in the IoT SiteWise User Guide.
\nYou can specify up to 200 properties per composite model. For more\n information, see Quotas in the IoT SiteWise User Guide.
" } } }, @@ -14280,7 +14331,7 @@ "assetModelName": { "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "A unique, friendly name for the asset model.
", + "smithy.api#documentation": "A unique name for the asset model.
", "smithy.api#required": {} } }, @@ -14305,7 +14356,7 @@ "assetModelCompositeModels": { "target": "com.amazonaws.iotsitewise#AssetModelCompositeModels", "traits": { - "smithy.api#documentation": "The composite models that are part of this asset model. It groups properties\n (such as attributes, measurements, transforms, and metrics) and child composite models that\n model parts of your industrial equipment. Each composite model has a type that defines the\n properties that the composite model supports. Use composite models to define alarms on this asset model.
\nWhen creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information,\n see .
\nThe composite models that are part of this asset model. It groups properties\n (such as attributes, measurements, transforms, and metrics) and child composite models that\n model parts of your industrial equipment. Each composite model has a type that defines the\n properties that the composite model supports. Use composite models to define alarms on this asset model.
\nWhen creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information,\n see Creating custom composite models (Components) in the\n IoT SiteWise User Guide.
\nAn external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + "smithy.api#documentation": "An external ID to assign to the asset model. The asset model must not already have an\n external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } } }, @@ -14461,7 +14512,7 @@ "assetExternalId": { "target": "com.amazonaws.iotsitewise#ExternalId", "traits": { - "smithy.api#documentation": "An external ID to assign to the asset. The asset must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + "smithy.api#documentation": "An external ID to assign to the asset. The asset must not already have an external ID.\n The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } } }, @@ -14709,9 +14760,9 @@ } }, "gatewayName": { - "target": "com.amazonaws.iotsitewise#Name", + "target": "com.amazonaws.iotsitewise#GatewayName", "traits": { - "smithy.api#documentation": "A unique, friendly name for the gateway.
", + "smithy.api#documentation": "A unique name for the gateway.
", "smithy.api#required": {} } } @@ -14968,13 +15019,13 @@ "propertyId": { "target": "com.amazonaws.iotsitewise#Macro", "traits": { - "smithy.api#documentation": "The ID of the property to use as the variable. You can use the property name\n if it's from the same asset model. If the property has an external ID, you can specify\n externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
The ID of the property to use as the variable. You can use the property name\n if it's from the same asset model. If the property has an external ID, you can specify\n externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name\n instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify\n externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies\n using the same model and therefore the same propertyId. For example, you might\n have separately grouped assets that come from the same asset model. For more information, see\n Asset hierarchies in the IoT SiteWise User Guide.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name\n instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify\n externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies\n using the same model and therefore the same propertyId. For example, you might\n have separately grouped assets that come from the same asset model. For more information, see\n Asset hierarchies in the IoT SiteWise User Guide.
Asset property data of type integer (number that's greater than or equal to zero).
" + "smithy.api#documentation": "Asset property data of type integer (whole number).
" } }, "doubleValue": { diff --git a/codegen/sdk-codegen/aws-models/mediapackagev2.json b/codegen/sdk-codegen/aws-models/mediapackagev2.json index 74d29edc6f2..86781cc506c 100644 --- a/codegen/sdk-codegen/aws-models/mediapackagev2.json +++ b/codegen/sdk-codegen/aws-models/mediapackagev2.json @@ -2191,6 +2191,12 @@ "traits": { "smithy.api#enumValue": "WIDEVINE" } + }, + "IRDETO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IRDETO" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/medical-imaging.json b/codegen/sdk-codegen/aws-models/medical-imaging.json index 4d0db1b204c..26553e0db3c 100644 --- a/codegen/sdk-codegen/aws-models/medical-imaging.json +++ b/codegen/sdk-codegen/aws-models/medical-imaging.json @@ -806,6 +806,16 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.medicalimaging#CopiableAttributes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 260000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.medicalimaging#CopyDestinationImageSet": { "type": "structure", "members": { @@ -969,6 +979,13 @@ "smithy.api#httpPayload": {}, "smithy.api#required": {} } + }, + "force": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Setting this flag will force the CopyImageSet operation, even if Patient, Study, or Series level\n metadata are mismatched across the sourceImageSet and destinationImageSet.
The latest version identifier for the source image set.
", "smithy.api#required": {} } + }, + "DICOMCopies": { + "target": "com.amazonaws.medicalimaging#MetadataCopies", + "traits": { + "smithy.api#documentation": "Contains MetadataCopies structure and wraps information related to specific copy use cases.\n For example, when copying subsets.
The Amazon Resource Name (ARN) assigned to the image set.
" } + }, + "overrides": { + "target": "com.amazonaws.medicalimaging#Overrides", + "traits": { + "smithy.api#documentation": "This object contains the details of any overrides used while creating a specific image set version.\n If an image set was copied or updated using the force flag, this object will contain the\n forced flag.
The error message thrown if an image set action fails.
" } + }, + "overrides": { + "target": "com.amazonaws.medicalimaging#Overrides", + "traits": { + "smithy.api#documentation": "Contains details on overrides used when creating the returned version of an image set.\n For example, if forced exists, the forced flag was used when \n creating the image set.
The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains copiable Attributes structure and wraps information related to specific copy use cases.\n For example, when copying subsets.
The object containing removableAttributes and updatableAttributes.
Specifies the previous image set version ID to revert the current image set back to.
\nYou must provide either revertToVersionId or DICOMUpdates in your request. A \n ValidationException error is thrown if both parameters are provided at the same time.
Setting this flag will force the CopyImageSet and UpdateImageSetMetadata\n operations, even if Patient, Study, or Series level metadata are mismatched.
Specifies the overrides used in image set modification calls to CopyImageSet and \n UpdateImageSetMetadata.
Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:
\n Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and Tag.StudyID\n
Adding, removing, or updating private tags for an individual SOP Instance
\nCreates a new event destination in a configuration set.
\nAn event destination is a location where you send message events. The event options\n are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example,\n when a message is delivered successfully, you can send information about that event to\n an event destination, or send notifications to endpoints that are subscribed to an\n Amazon SNS topic.
\nEach configuration set can contain between 0 and 5 event destinations. Each event\n destination can contain a reference to a single destination, such as a CloudWatch\n or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Creates a new event destination in a configuration set.
\nAn event destination is a location where you send message events. The event options\n are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example,\n when a message is delivered successfully, you can send information about that event to\n an event destination, or send notifications to endpoints that are subscribed to an\n Amazon SNS topic.
\nEach configuration set can contain between 0 and 5 event destinations. Each event\n destination can contain a reference to a single destination, such as a CloudWatch\n or Firehose destination.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateEventDestinationRequest": { @@ -956,7 +956,7 @@ "MatchingEventTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", "traits": { - "smithy.api#documentation": "An array of event types that determine which events to log. If \"ALL\" is used, then\n Amazon Pinpoint logs every event type.
\nThe TEXT_SENT event type is not supported.
An array of event types that determine which events to log. If \"ALL\" is used, then\n AWS End User Messaging SMS and Voice logs every event type.
\nThe TEXT_SENT event type is not supported.
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
" + "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon Data Firehose.
" } }, "SnsDestination": { @@ -1045,7 +1045,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new opt-out list.
\nIf the opt-out list name already exists, an error is returned.
\nAn opt-out list is a list of phone numbers that are opted out, meaning you can't send\n SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for\n the phone number is added to the opt-out list. In addition to STOP, your recipients can\n use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported\n opt-out keywords, see \n SMS opt out in the Amazon Pinpoint User\n Guide.
" + "smithy.api#documentation": "Creates a new opt-out list.
\nIf the opt-out list name already exists, an error is returned.
\nAn opt-out list is a list of phone numbers that are opted out, meaning you can't send\n SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for\n the phone number is added to the opt-out list. In addition to STOP, your recipients can\n use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported\n opt-out keywords, see \n SMS opt out in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateOptOutListRequest": { @@ -1149,7 +1149,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nAfter the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.
", "smithy.api#required": {} } }, @@ -1163,7 +1163,7 @@ "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive. After the pool is created the MessageType can't be changed.
", "smithy.api#required": {} } }, @@ -1241,7 +1241,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -1254,7 +1254,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" + "smithy.api#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": { @@ -2330,7 +2330,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing keyword from an origination phone number or pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nKeywords \"HELP\" and \"STOP\" can't be deleted or modified.
" + "smithy.api#documentation": "Deletes an existing keyword from an origination phone number or pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable\n message.
\nKeywords \"HELP\" and \"STOP\" can't be deleted or modified.
" } }, "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest": { @@ -2703,7 +2703,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -3157,7 +3157,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an account-level monthly spending limit override for sending text messages.\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Amazon Pinpoint quotas \n in the Amazon Pinpoint Developer Guide.
Deletes an account-level monthly spending limit override for sending text messages.\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Quotas \n in the AWS End User Messaging SMS User Guide.
Deletes an account level monthly spend limit override for sending voice messages.\n Deleting a spend limit override sets the EnforcedLimit equal to the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spending limits (quotas) see Amazon Pinpoint quotas\n in the Amazon Pinpoint Developer Guide.
Deletes an account level monthly spend limit override for sending voice messages.\n Deleting a spend limit override sets the EnforcedLimit equal to the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spending limits (quotas) see Quotas \n in the AWS End User Messaging SMS User Guide.
Describes attributes of your Amazon Web Services account. The supported account\n attributes include account tier, which indicates whether your account is in the sandbox\n or production environment. When you're ready to move your account out of the sandbox,\n create an Amazon Web Services Support case for a service limit increase request.
\nNew Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox\n protects both Amazon Web Services end recipients and SMS or voice recipients from fraud\n and abuse.
", + "smithy.api#documentation": "Describes attributes of your Amazon Web Services account. The supported account\n attributes include account tier, which indicates whether your account is in the sandbox\n or production environment. When you're ready to move your account out of the sandbox,\n create an Amazon Web Services Support case for a service limit increase request.
\nNew accounts are placed into an SMS or voice sandbox. The sandbox\n protects both Amazon Web Services end recipients and SMS or voice recipients from fraud\n and abuse.
", "smithy.api#paginated": { "items": "AccountAttributes" } @@ -3413,7 +3413,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your\n account. The description for a quota includes the quota name, current usage toward that\n quota, and the quota's maximum value.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on\n the maximum number of configuration sets, opt-out lists, phone numbers, and pools that\n you can create in a given Region. For more information see \n Amazon Pinpoint quotas in the Amazon Pinpoint Developer\n Guide.
", + "smithy.api#documentation": "Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your\n account. The description for a quota includes the quota name, current usage toward that\n quota, and the quota's maximum value.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on\n the maximum number of configuration sets, opt-out lists, phone numbers, and pools that\n you can create in a given Region. For more information see Quotas \n in the AWS End User Messaging SMS User Guide.
", "smithy.api#paginated": { "items": "AccountLimits" } @@ -3569,7 +3569,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified keywords or all keywords on your origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
", + "smithy.api#documentation": "Describes the specified keywords or all keywords on your origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
", "smithy.api#paginated": { "items": "Keywords" } @@ -4849,7 +4849,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages.
\nWhen you establish an Amazon Web Services account, the account has initial monthly\n spend limit in a given Region. For more information on increasing your monthly spend\n limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
", + "smithy.api#documentation": "Describes the current monthly spend limits for sending voice and\n text messages.
\nWhen you establish an Amazon Web Services account, the account has initial monthly\n spend limit in a given Region. For more information on increasing your monthly spend\n limit, see \n Requesting increases to your monthly SMS, MMS, or Voice spending quota\n in the AWS End User Messaging SMS User Guide.
", "smithy.api#paginated": { "items": "SpendLimits" } @@ -5355,7 +5355,7 @@ "KinesisFirehoseDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
" + "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon Data Firehose.
" } }, "SnsDestination": { @@ -5366,7 +5366,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about an event destination.
\nEvent destinations are associated with configuration sets, which enable you to publish\n message sending events to CloudWatch, Kinesis Data Firehose, or Amazon SNS.
" + "smithy.api#documentation": "Contains information about an event destination.
\nEvent destinations are associated with configuration sets, which enable you to publish\n message sending events to CloudWatch, Firehose, or Amazon SNS.
" } }, "com.amazonaws.pinpointsmsvoicev2#EventDestinationList": { @@ -5731,7 +5731,7 @@ "CountryRuleSet": { "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet", "traits": { - "smithy.api#documentation": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.
", + "smithy.api#documentation": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
", "smithy.api#required": {} } } @@ -5914,7 +5914,7 @@ "IamRoleArn": { "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", "traits": { - "smithy.api#documentation": "The ARN of an Identity and Access Management role that is able to write\n event data to an Amazon Kinesis Data Firehose destination.
", + "smithy.api#documentation": "The ARN of an Identity and Access Management role that is able to write\n event data to an Amazon Data Firehose destination.
", "smithy.api#required": {} } }, @@ -5927,7 +5927,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Kinesis Data Firehose event\n destination.
\nEvent destinations, such as Kinesis Data Firehose, are associated with configuration\n sets, which enable you to publish message sending events.
" + "smithy.api#documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Firehose event\n destination.
\nEvent destinations, such as Firehose, are associated with configuration\n sets, which enable you to publish message sending events.
" } }, "com.amazonaws.pinpointsmsvoicev2#LanguageCode": { @@ -6865,7 +6865,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out request. For more information see Self-managed opt-outs\n
", + "smithy.api#documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out request. For more information see Self-managed opt-outs\n
", "smithy.api#required": {} } }, @@ -7195,7 +7195,7 @@ "name": "sms-voice" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.\n This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.
\nAmazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The Amazon Pinpoint SMS and\n Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels. Amazon Pinpoint SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
\nIf you're new to Amazon Pinpoint SMS, it's also helpful to review the \n Amazon Pinpoint SMS User Guide. The Amazon Pinpoint\n Developer Guide provides tutorials, code samples, and procedures that\n demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate\n Amazon Pinpoint functionality into mobile apps and other types of applications.\n The guide also provides key information, such as Amazon Pinpoint integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.
\n\n Regional availability\n
\nThe Amazon Pinpoint SMS and Voice, version 2 API Reference is\n available in several Amazon Web Services Regions and it provides an endpoint for each of\n these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see Amazon Web Services Service Endpoints and Amazon Pinpoint\n endpoints and quotas in the Amazon Web Services General Reference. To\n learn more about Amazon Web Services Regions, see Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.
\nIn each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These\n Availability Zones enable us to provide very high levels of availability and redundancy,\n while also minimizing latency. To learn more about the number of Availability Zones that\n are available in each Region, see Amazon Web Services\n Global Infrastructure.\n
", + "smithy.api#documentation": "Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference.\n This guide provides information about AWS End User Messaging SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.
\nAmazon Pinpoint is an Amazon Web Services service that you can use to engage with\n 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\n 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.
\nIf you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the \n AWS End User Messaging SMS User Guide. The AWS End User Messaging SMS User Guide\n provides tutorials, code samples, and procedures that\n demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate\n functionality into mobile apps and other types of applications.\n The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.
\n\n Regional availability\n
\nThe AWS End User Messaging SMS and Voice version 2 API Reference is\n available in several Amazon Web Services Regions and it provides an endpoint for each of\n these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see Amazon Web Services Service Endpoints and Amazon Pinpoint\n endpoints and quotas in the Amazon Web Services General Reference. To\n learn more about Amazon Web Services Regions, see Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.
\nIn each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These\n Availability Zones enable us to provide very high levels of availability and redundancy,\n while also minimizing latency. To learn more about the number of Availability Zones that\n are available in each Region, see Amazon Web Services\n Global Infrastructure.\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8110,7 +8110,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to false, an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out requests. For more information see Self-managed opt-outs\n
", + "smithy.api#documentation": "When set to false, an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out requests. For more information see Self-managed opt-outs\n
", "smithy.api#required": {} } }, @@ -8125,7 +8125,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Allows you to enable shared routes on your pool.
\nBy default, this is set to False. If you set this value to\n True, your messages are sent using phone numbers or sender IDs\n (depending on the country) that are shared with other Amazon Pinpoint users. In some\n countries, such as the United States, senders aren't allowed to use shared routes and\n must use a dedicated phone number or short code.
Allows you to enable shared routes on your pool.
\nBy default, this is set to False. If you set this value to\n True, your messages are sent using phone numbers or sender IDs\n (depending on the country) that are shared with other users. In some\n countries, such as the United States, senders aren't allowed to use shared routes and\n must use a dedicated phone number or short code.
Creates or updates a keyword configuration on an origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
" + "smithy.api#documentation": "Creates or updates a keyword configuration on an origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest": { @@ -9913,7 +9913,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -10082,7 +10082,7 @@ } ], "traits": { - "smithy.api#documentation": "Request an origination phone number for use in your account. For more information on\n phone number request see Requesting a\n number in the Amazon Pinpoint User Guide.
" + "smithy.api#documentation": "Request an origination phone number for use in your account. For more information on\n phone number request see Request a phone number in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest": { @@ -10238,7 +10238,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -10900,7 +10900,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new text message and sends it to a recipient's phone number.
\nSMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit\n depends on the destination country of your messages, as well as the type of phone number\n (origination number) that you use to send the message. For more information, see Message Parts per\n Second (MPS) limits in the Amazon Pinpoint User\n Guide.
" + "smithy.api#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.
\nSMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit\n depends on the destination country of your messages, as well as the type of phone number\n (origination number) that you use to send the message. For more information about MPS, see Message Parts per\n Second (MPS) limits in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest": { @@ -10946,13 +10946,13 @@ "MaxPrice": { "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", "traits": { - "smithy.api#documentation": "The maximum amount that you want to spend, in US dollars, per each text message part.\n A text message can contain multiple parts.
" + "smithy.api#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.
How long the text message is valid for. By default this is 72 hours.
" + "smithy.api#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.
This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
" + "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
\n\n IN_ENTITY_ID The entity ID or Principal\n Entity (PE) ID that you received after completing the sender ID\n registration process.
\n IN_TEMPLATE_ID The template ID that you\n received after completing the sender ID registration\n process.
Make sure that the Template ID that you specify matches\n your message template exactly. If your message doesn't match\n the template that you provided during the registration\n process, the mobile carriers might reject your\n message.
\nWhen set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient. You are not charged for using DryRun.
The Message Parts per Second (MPS) limit when using DryRun is five. If\n your origination identity has a lower MPS limit then the lower MPS limit is used. For\n more information about MPS limits, see Message Parts per\n Second (MPS) limits in the AWS End User Messaging SMS User Guide..
Allows you to send a request that sends a voice message through Amazon Pinpoint.\n This operation uses Amazon Polly to\n convert a text script into a voice message.
" + "smithy.api#documentation": "Allows you to send a request that sends a voice message.\n This operation uses Amazon Polly to\n convert a text script into a voice message.
" } }, "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest": { @@ -11154,7 +11154,7 @@ } }, "traits": { - "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you want to describe. For more\n information on sender IDs see Requesting\n sender IDs for SMS messaging with Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" + "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you want to describe. For more\n information on sender IDs see Requesting\n sender IDs in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter": { @@ -11872,7 +11872,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages. For more information on increasing your monthly spend limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" + "smithy.api#documentation": "Describes the current monthly spend limits for sending voice and\n text messages. For more information on increasing your monthly spend limit, see \n Requesting a spending quota increase\n in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#SpendLimitList": { @@ -12130,7 +12130,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS\n Voice, version 2 resource. When you specify an existing tag key, the value is\n overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag\n consists of a key and an optional value. Tag keys must be unique per resource. For more\n information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" + "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is\n overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag\n consists of a key and an optional value. Tag keys must be unique per resource. For more\n information about tags, see Tags in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest": { @@ -12289,7 +12289,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2\n resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" + "smithy.api#documentation": "Removes the association of the specified tags from a\n resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest": { @@ -12350,7 +12350,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing event destination in a configuration set. You can update the\n IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can\n also enable or disable the event destination.
\nYou may want to update an event destination to change its matching event types or\n updating the destination resource ARN. You can't change an event destination's type\n between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
" + "smithy.api#documentation": "Updates an existing event destination in a configuration set. You can update the\n IAM role ARN for CloudWatch Logs and Firehose. You can\n also enable or disable the event destination.
\nYou may want to update an event destination to change its matching event types or\n updating the destination resource ARN. You can't change an event destination's type\n between CloudWatch Logs, Firehose, and Amazon SNS.
" } }, "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest": { @@ -12391,7 +12391,7 @@ "KinesisFirehoseDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "An object that contains information about an event destination for logging to Kinesis Data Firehose.
" + "smithy.api#documentation": "An object that contains information about an event destination for logging to Firehose.
" } }, "SnsDestination": { @@ -12494,7 +12494,7 @@ "SelfManagedOptOutsEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -12690,7 +12690,7 @@ "SelfManagedOptOutsEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -12766,7 +12766,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When an end recipient sends a message that begins with HELP or STOP to one of your\n dedicated numbers, Amazon Pinpoint automatically replies with a customizable message\n and adds the end recipient to the OptOutList. When set to true you're responsible for\n responding to HELP and STOP requests. You're also responsible for tracking and honoring\n opt-out requests.
" + "smithy.api#documentation": "When an end recipient sends a message that begins with HELP or STOP to one of your\n dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message\n and adds the end recipient to the OptOutList. When set to true you're responsible for\n responding to HELP and STOP requests. You're also responsible for tracking and honoring\n opt-out requests.
" } }, "OptOutListName": { @@ -12878,7 +12878,7 @@ "CountryRuleSetUpdates": { "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet", "traits": { - "smithy.api#documentation": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.
", + "smithy.api#documentation": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
", "smithy.api#required": {} } }