Creates a new configured table resource.
", "CreateConfiguredTableAnalysisRule": "Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
", "CreateConfiguredTableAssociation": "Creates a configured table association. A configured table association links a configured table with a collaboration.
", + "CreateConfiguredTableAssociationAnalysisRule": "Creates a new analysis rule for an associated configured table.
", "CreateIdMappingTable": "Creates an ID mapping table.
", "CreateIdNamespaceAssociation": "Creates an ID namespace association.
", "CreateMembership": "Creates a membership for a specific collaboration identifier and joins the collaboration.
", @@ -21,6 +22,7 @@ "DeleteConfiguredTable": "Deletes a configured table.
", "DeleteConfiguredTableAnalysisRule": "Deletes a configured table analysis rule.
", "DeleteConfiguredTableAssociation": "Deletes a configured table association.
", + "DeleteConfiguredTableAssociationAnalysisRule": "Deletes an analysis rule for a configured table association.
", "DeleteIdMappingTable": "Deletes an ID mapping table.
", "DeleteIdNamespaceAssociation": "Deletes an ID namespace association.
", "DeleteMember": "Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.
", @@ -36,6 +38,7 @@ "GetConfiguredTable": "Retrieves a configured table.
", "GetConfiguredTableAnalysisRule": "Retrieves a configured table analysis rule.
", "GetConfiguredTableAssociation": "Retrieves a configured table association.
", + "GetConfiguredTableAssociationAnalysisRule": "Retrieves the analysis rule for a configured table association.
", "GetIdMappingTable": "Retrieves an ID mapping table.
", "GetIdNamespaceAssociation": "Retrieves an ID namespace association.
", "GetMembership": "Retrieves a specified membership for an identifier.
", @@ -73,6 +76,7 @@ "UpdateConfiguredTable": "Updates a configured table.
", "UpdateConfiguredTableAnalysisRule": "Updates a configured table analysis rule.
", "UpdateConfiguredTableAssociation": "Updates a configured table association.
", + "UpdateConfiguredTableAssociationAnalysisRule": "Updates the analysis rule for a configured table association.
", "UpdateIdMappingTable": "Provides the details that are necessary to update an ID mapping table.
", "UpdateIdNamespaceAssociation": "Provides the details that are necessary to update an ID namespace association.
", "UpdateMembership": "Updates a membership.
", @@ -94,12 +98,13 @@ "AccountId": { "base": null, "refs": { + "AllowedResultReceivers$member": null, "AnalysisRuleCustomAllowedAnalysisProvidersList$member": null, "Collaboration$creatorAccountId": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "CollaborationAnalysisTemplate$creatorAccountId": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "CollaborationAnalysisTemplateSummary$creatorAccountId": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", - "CollaborationConfiguredAudienceModelAssociation$creatorAccountId": "The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.
", - "CollaborationConfiguredAudienceModelAssociationSummary$creatorAccountId": "The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.
", + "CollaborationConfiguredAudienceModelAssociation$creatorAccountId": "The identifier used to reference members of the collaboration. Only supports AWS account ID.
", + "CollaborationConfiguredAudienceModelAssociationSummary$creatorAccountId": "The identifier used to reference members of the collaboration. Only supports AWS account ID.
", "CollaborationIdNamespaceAssociation$creatorAccountId": "The unique identifier of the Amazon Web Services account that created the collaboration ID namespace association.
", "CollaborationIdNamespaceAssociationSummary$creatorAccountId": "The Amazon Web Services account that created this collaboration ID namespace association.
", "CollaborationPrivacyBudgetSummary$creatorAccountId": "The unique identifier of the account that created this privacy budget.
", @@ -111,11 +116,27 @@ "MemberSummary$accountId": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "Membership$collaborationCreatorAccountId": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "MembershipSummary$collaborationCreatorAccountId": "The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.
", + "ProtectedQueryMemberOutputConfiguration$accountId": "The unique identifier for the account.
", "ProtectedQuerySingleMemberOutput$accountId": "The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
", + "ReceiverAccountIds$member": null, "Schema$creatorAccountId": "The unique account ID for the Amazon Web Services account that owns the schema.
", "SchemaSummary$creatorAccountId": "The unique account ID for the Amazon Web Services account that owns the schema.
" } }, + "AdditionalAnalyses": { + "base": null, + "refs": { + "AnalysisRuleAggregation$additionalAnalyses": "An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
The additionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).
An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
", + "AnalysisRuleList$additionalAnalyses": "An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
" + } + }, + "AdditionalAnalysesResourceArn": { + "base": null, + "refs": { + "AllowedAdditionalAnalyses$member": null + } + }, "AggregateColumn": { "base": "Column in configured table that can be used in aggregate function in query.
", "refs": { @@ -158,6 +179,14 @@ "AggregationConstraint$type": "The type of aggregation the constraint allows. The only valid value is currently `COUNT_DISTINCT`.
" } }, + "AllowedAdditionalAnalyses": { + "base": null, + "refs": { + "ConfiguredTableAssociationAnalysisRuleAggregation$allowedAdditionalAnalyses": "The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
The allowedAdditionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).
The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
", + "ConfiguredTableAssociationAnalysisRuleList$allowedAdditionalAnalyses": "The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
" + } + }, "AllowedColumnList": { "base": null, "refs": { @@ -165,6 +194,14 @@ "CreateConfiguredTableInput$allowedColumns": "The columns of the underlying table that can be used by collaborations or analysis rules.
" } }, + "AllowedResultReceivers": { + "base": null, + "refs": { + "ConfiguredTableAssociationAnalysisRuleAggregation$allowedResultReceivers": "The list of collaboration members who are allowed to receive results of queries run with this configured table.
", + "ConfiguredTableAssociationAnalysisRuleCustom$allowedResultReceivers": "The list of collaboration members who are allowed to receive results of queries run with this configured table.
", + "ConfiguredTableAssociationAnalysisRuleList$allowedResultReceivers": "The list of collaboration members who are allowed to receive results of queries run with this configured table.
" + } + }, "AnalysisFormat": { "base": null, "refs": { @@ -179,7 +216,7 @@ "ConfiguredTable$analysisMethod": "The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.
", "ConfiguredTableSummary$analysisMethod": "The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
", "CreateConfiguredTableInput$analysisMethod": "The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
", - "Schema$analysisMethod": "The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
", "SchemaSummary$analysisMethod": "The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.
" } }, @@ -222,6 +259,7 @@ "refs": { "AnalysisRuleAggregation$joinColumns": "Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
", "AnalysisRuleAggregation$dimensionColumns": "The columns that query runners are allowed to select, group by, or filter by.
", + "AnalysisRuleCustom$disallowedOutputColumns": "A list of columns that aren't allowed to be shown in the query output.
", "AnalysisRuleIdMappingTable$dimensionColumns": "The columns that query runners are allowed to select, group by, or filter by.
", "AnalysisRuleList$listColumns": "Columns that can be listed in the output.
", "QueryConstraintRequireOverlap$columns": "The columns that are required to overlap.
" @@ -307,7 +345,7 @@ "AnalysisRuleTypeList": { "base": null, "refs": { - "Schema$analysisRuleTypes": "The analysis rule types that are associated with the schema. Currently, only one entry is present.
", + "Schema$analysisRuleTypes": "The analysis rule types associated with the schema. Currently, only one entry is present.
", "SchemaSummary$analysisRuleTypes": "The types of analysis rules that are associated with this schema object.
" } }, @@ -426,6 +464,13 @@ "AnalysisTemplateValidationStatusDetail$type": "The type of validation that was performed.
" } }, + "AnalysisType": { + "base": null, + "refs": { + "ReceiverConfiguration$analysisType": " 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 type of analysis that can be performed on the schema.
A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.
Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.
", "refs": { @@ -519,7 +564,7 @@ "Collaboration": { "base": "The multi-party data share environment. The collaboration contains metadata about its purpose and participants.
", "refs": { - "CreateCollaborationOutput$collaboration": "The entire created collaboration object.
", + "CreateCollaborationOutput$collaboration": "The collaboration.
", "GetCollaborationOutput$collaboration": "The entire collaboration for this identifier.
", "UpdateCollaborationOutput$collaboration": "The entire collaboration that has been updated.
" } @@ -576,7 +621,7 @@ "PrivacyBudgetSummary$collaborationArn": "The ARN of the collaboration that contains this privacy budget.
", "PrivacyBudgetTemplate$collaborationArn": "The ARN of the collaboration that contains this privacy budget template.
", "PrivacyBudgetTemplateSummary$collaborationArn": "The ARN of the collaboration that contains this privacy budget template.
", - "Schema$collaborationArn": "The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
", + "Schema$collaborationArn": "The unique ARN for the collaboration that the schema belongs to.
", "SchemaSummary$collaborationArn": "The unique ARN for the collaboration that the schema belongs to.
" } }, @@ -721,7 +766,7 @@ "ColumnList": { "base": null, "refs": { - "Schema$columns": "The columns for the relation that this schema represents.
", + "Schema$columns": "The columns for the relation this schema represents.
", "Schema$partitionKeys": "The partition keys for the dataset underlying this schema.
" } }, @@ -738,6 +783,12 @@ "Column$type": "The type of the column.
" } }, + "ConfigurationDetails": { + "base": "The configuration details.
", + "refs": { + "ReceiverConfiguration$configurationDetails": "The configuration details of the receiver configuration.
" + } + }, "ConfiguredAudienceModelArn": { "base": null, "refs": { @@ -810,7 +861,7 @@ "ConfiguredTableAnalysisRule": { "base": "A configured table analysis rule, which limits how data for this table can be used.
", "refs": { - "CreateConfiguredTableAnalysisRuleOutput$analysisRule": "The entire created analysis rule.
", + "CreateConfiguredTableAnalysisRuleOutput$analysisRule": "The analysis rule that was created for the configured table.
", "GetConfiguredTableAnalysisRuleOutput$analysisRule": "The entire analysis rule output.
", "UpdateConfiguredTableAnalysisRuleOutput$analysisRule": "The entire updated analysis rule.
" } @@ -819,7 +870,7 @@ "base": "Controls on the query specifications that can be run on a configured table.
", "refs": { "ConfiguredTableAnalysisRule$policy": "The policy that controls SQL query rules.
", - "CreateConfiguredTableAnalysisRuleInput$analysisRulePolicy": "The entire created configured table analysis rule object.
", + "CreateConfiguredTableAnalysisRuleInput$analysisRulePolicy": "The analysis rule policy that was created for the configured table.
", "UpdateConfiguredTableAnalysisRuleInput$analysisRulePolicy": "The new analysis rule policy for the configured table analysis rule.
" } }, @@ -859,23 +910,86 @@ "ConfiguredTableAssociation": { "base": "A configured table association links a configured table to a collaboration.
", "refs": { - "CreateConfiguredTableAssociationOutput$configuredTableAssociation": "The entire configured table association object.
", + "CreateConfiguredTableAssociationOutput$configuredTableAssociation": "The configured table association.
", "GetConfiguredTableAssociationOutput$configuredTableAssociation": "The entire configured table association object.
", "UpdateConfiguredTableAssociationOutput$configuredTableAssociation": "The entire updated configured table association.
" } }, + "ConfiguredTableAssociationAnalysisRule": { + "base": "An analysis rule for a configured table association. This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The updated analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The configured table association analysis rule applied to a configured table with the aggregation analysis rule.
", + "refs": { + "ConfiguredTableAssociationAnalysisRulePolicyV1$aggregation": "Analysis rule type that enables only aggregation queries on a configured table.
" + } + }, + "ConfiguredTableAssociationAnalysisRuleCustom": { + "base": "The configured table association analysis rule applied to a configured table with the custom analysis rule.
", + "refs": { + "ConfiguredTableAssociationAnalysisRulePolicyV1$custom": "Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.
" + } + }, + "ConfiguredTableAssociationAnalysisRuleList": { + "base": "The configured table association analysis rule applied to a configured table with the list analysis rule.
", + "refs": { + "ConfiguredTableAssociationAnalysisRulePolicyV1$list": "Analysis rule type that enables only list queries on a configured table.
" + } + }, + "ConfiguredTableAssociationAnalysisRulePolicy": { + "base": "Controls on the query specifications that can be run on an associated configured table.
", + "refs": { + "ConfiguredTableAssociationAnalysisRule$policy": "The policy of the configured table association analysis rule.
", + "CreateConfiguredTableAssociationAnalysisRuleInput$analysisRulePolicy": "The analysis rule policy that was created for the configured table association.
", + "UpdateConfiguredTableAssociationAnalysisRuleInput$analysisRulePolicy": "The updated analysis rule policy for the configured table association.
" + } + }, + "ConfiguredTableAssociationAnalysisRulePolicyV1": { + "base": "Controls on the query specifications that can be run on an associated configured table.
", + "refs": { + "ConfiguredTableAssociationAnalysisRulePolicy$v1": "The policy for the configured table association analysis rule.
" + } + }, + "ConfiguredTableAssociationAnalysisRuleType": { + "base": null, + "refs": { + "ConfiguredTableAssociationAnalysisRule$type": "The type of the configured table association analysis rule.
", + "ConfiguredTableAssociationAnalysisRuleTypeList$member": null, + "CreateConfiguredTableAssociationAnalysisRuleInput$analysisRuleType": "The type of analysis rule.
", + "DeleteConfiguredTableAssociationAnalysisRuleInput$analysisRuleType": "The type of the analysis rule that you want to delete.
", + "GetConfiguredTableAssociationAnalysisRuleInput$analysisRuleType": "The type of analysis rule that you want to retrieve.
", + "UpdateConfiguredTableAssociationAnalysisRuleInput$analysisRuleType": "The analysis rule type that you want to update.
" + } + }, + "ConfiguredTableAssociationAnalysisRuleTypeList": { + "base": null, + "refs": { + "ConfiguredTableAssociation$analysisRuleTypes": "The analysis rule types for the configured table association.
" + } + }, "ConfiguredTableAssociationArn": { "base": null, "refs": { "ConfiguredTableAssociation$arn": "The unique ARN for the configured table association.
", + "ConfiguredTableAssociationAnalysisRule$configuredTableAssociationArn": "The Amazon Resource Name (ARN) of the configured table association.
", "ConfiguredTableAssociationSummary$arn": "The unique ARN for the configured table association.
" } }, "ConfiguredTableAssociationIdentifier": { "base": null, "refs": { + "ConfiguredTableAssociationAnalysisRule$configuredTableAssociationId": "The unique identifier for the configured table association.
", + "CreateConfiguredTableAssociationAnalysisRuleInput$configuredTableAssociationIdentifier": "The unique ID for the configured table association. Currently accepts the configured table association ID.
", + "DeleteConfiguredTableAssociationAnalysisRuleInput$configuredTableAssociationIdentifier": "The identifier for the configured table association that's related to the analysis rule that you want to delete.
", "DeleteConfiguredTableAssociationInput$configuredTableAssociationIdentifier": "The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.
", + "GetConfiguredTableAssociationAnalysisRuleInput$configuredTableAssociationIdentifier": "The identifier for the configured table association that's related to the analysis rule.
", "GetConfiguredTableAssociationInput$configuredTableAssociationIdentifier": "The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.
", + "UpdateConfiguredTableAssociationAnalysisRuleInput$configuredTableAssociationIdentifier": "The identifier for the configured table association to update.
", "UpdateConfiguredTableAssociationInput$configuredTableAssociationIdentifier": "The unique identifier for the configured table association to update. Currently accepts the configured table association ID.
" } }, @@ -968,6 +1082,16 @@ "refs": { } }, + "CreateConfiguredTableAssociationAnalysisRuleInput": { + "base": null, + "refs": { + } + }, + "CreateConfiguredTableAssociationAnalysisRuleOutput": { + "base": null, + "refs": { + } + }, "CreateConfiguredTableAssociationInput": { "base": null, "refs": { @@ -1075,6 +1199,16 @@ "refs": { } }, + "DeleteConfiguredTableAssociationAnalysisRuleInput": { + "base": null, + "refs": { + } + }, + "DeleteConfiguredTableAssociationAnalysisRuleOutput": { + "base": null, + "refs": { + } + }, "DeleteConfiguredTableAssociationInput": { "base": null, "refs": { @@ -1279,6 +1413,12 @@ "PrivacyBudgetTemplateUpdateParameters$differentialPrivacy": "An object that specifies the new values for the epsilon and noise parameters.
" } }, + "DirectAnalysisConfigurationDetails": { + "base": "The direct analysis configuration details.
", + "refs": { + "ConfigurationDetails$directAnalysisConfigurationDetails": "The direct analysis configuration details.
" + } + }, "DisplayName": { "base": null, "refs": { @@ -1421,6 +1561,16 @@ "refs": { } }, + "GetConfiguredTableAssociationAnalysisRuleInput": { + "base": null, + "refs": { + } + }, + "GetConfiguredTableAssociationAnalysisRuleOutput": { + "base": null, + "refs": { + } + }, "GetConfiguredTableAssociationInput": { "base": null, "refs": { @@ -1920,30 +2070,30 @@ "Long": { "base": null, "refs": { - "ProtectedQueryStatistics$totalDurationInMillis": "The duration of the Protected Query, from creation until query completion.
" + "ProtectedQueryStatistics$totalDurationInMillis": "The duration of the protected query, from creation until query completion.
" } }, "MaxResults": { "base": null, "refs": { - "ListAnalysisTemplatesInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListCollaborationAnalysisTemplatesInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListCollaborationConfiguredAudienceModelAssociationsInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", + "ListAnalysisTemplatesInput$maxResults": "The maximum size of the results that is returned per call.
", + "ListCollaborationAnalysisTemplatesInput$maxResults": "The maximum size of the results that is returned per call.
", + "ListCollaborationConfiguredAudienceModelAssociationsInput$maxResults": "The maximum size of the results that is returned per call.
", "ListCollaborationIdNamespaceAssociationsInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.>
", - "ListCollaborationPrivacyBudgetTemplatesInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListCollaborationPrivacyBudgetsInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListCollaborationsInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListConfiguredAudienceModelAssociationsInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListConfiguredTableAssociationsInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListConfiguredTablesInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", + "ListCollaborationPrivacyBudgetTemplatesInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "ListCollaborationPrivacyBudgetsInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "ListCollaborationsInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "ListConfiguredAudienceModelAssociationsInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "ListConfiguredTableAssociationsInput$maxResults": "The maximum size of the results that is returned per call.
", + "ListConfiguredTablesInput$maxResults": "The maximum size of the results that is returned per call.
", "ListIdMappingTablesInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", "ListIdNamespaceAssociationsInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", - "ListMembersInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListMembershipsInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListPrivacyBudgetTemplatesInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListPrivacyBudgetsInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListProtectedQueriesInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", - "ListSchemasInput$maxResults": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
" + "ListMembersInput$maxResults": "The maximum size of the results that is returned per call.
", + "ListMembershipsInput$maxResults": "The maximum size of the results that is returned per call.
", + "ListPrivacyBudgetTemplatesInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "ListPrivacyBudgetsInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "ListProtectedQueriesInput$maxResults": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.
", + "ListSchemasInput$maxResults": "The maximum size of the results that is returned per call.
" } }, "MemberAbilities": { @@ -2031,15 +2181,18 @@ "base": null, "refs": { "ConfiguredAudienceModelAssociationSummary$membershipId": "A unique identifier of the membership that contains the configured audience model association.
", + "ConfiguredTableAssociationAnalysisRule$membershipIdentifier": "The membership identifier for the configured table association analysis rule.
", "ConfiguredTableAssociationSummary$membershipId": "The unique ID for the membership that the configured table association belongs to.
", "CreateAnalysisTemplateInput$membershipIdentifier": "The identifier for a membership resource.
", "CreateConfiguredAudienceModelAssociationInput$membershipIdentifier": "A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.
", + "CreateConfiguredTableAssociationAnalysisRuleInput$membershipIdentifier": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "CreateConfiguredTableAssociationInput$membershipIdentifier": "A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.
", "CreateIdMappingTableInput$membershipIdentifier": "The unique identifier of the membership that contains the ID mapping table.
", "CreateIdNamespaceAssociationInput$membershipIdentifier": "The unique identifier of the membership that contains the ID namespace association.
", "CreatePrivacyBudgetTemplateInput$membershipIdentifier": "A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.
", "DeleteAnalysisTemplateInput$membershipIdentifier": "The identifier for a membership resource.
", "DeleteConfiguredAudienceModelAssociationInput$membershipIdentifier": "A unique identifier of the membership that contains the audience model association that you want to delete.
", + "DeleteConfiguredTableAssociationAnalysisRuleInput$membershipIdentifier": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "DeleteConfiguredTableAssociationInput$membershipIdentifier": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "DeleteIdMappingTableInput$membershipIdentifier": "The unique identifier of the membership that contains the ID mapping table that you want to delete.
", "DeleteIdNamespaceAssociationInput$membershipIdentifier": "The unique identifier of the membership that contains the ID namespace association that you want to delete.
", @@ -2047,6 +2200,7 @@ "DeletePrivacyBudgetTemplateInput$membershipIdentifier": "A unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID.
", "GetAnalysisTemplateInput$membershipIdentifier": "The identifier for a membership resource.
", "GetConfiguredAudienceModelAssociationInput$membershipIdentifier": "A unique identifier for the membership that contains the configured audience model association that you want to retrieve.
", + "GetConfiguredTableAssociationAnalysisRuleInput$membershipIdentifier": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "GetConfiguredTableAssociationInput$membershipIdentifier": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "GetIdMappingTableInput$membershipIdentifier": "The unique identifier of the membership that contains the ID mapping table that you want to retrieve.
", "GetIdNamespaceAssociationInput$membershipIdentifier": "The unique identifier of the membership that contains the ID namespace association that you want to retrieve.
", @@ -2069,6 +2223,7 @@ "StartProtectedQueryInput$membershipIdentifier": "A unique identifier for the membership to run this query against. Currently accepts a membership ID.
", "UpdateAnalysisTemplateInput$membershipIdentifier": "The identifier for a membership resource.
", "UpdateConfiguredAudienceModelAssociationInput$membershipIdentifier": "A unique identifier of the membership that contains the configured audience model association that you want to update.
", + "UpdateConfiguredTableAssociationAnalysisRuleInput$membershipIdentifier": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "UpdateConfiguredTableAssociationInput$membershipIdentifier": "The unique ID for the membership that the configured table association belongs to.
", "UpdateIdMappingTableInput$membershipIdentifier": "The unique identifier of the membership that contains the ID mapping table that you want to update.
", "UpdateIdNamespaceAssociationInput$membershipIdentifier": "The unique identifier of the membership that contains the ID namespace association that you want to update.
", @@ -2136,42 +2291,42 @@ "PaginationToken": { "base": null, "refs": { - "ListAnalysisTemplatesInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListAnalysisTemplatesOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListCollaborationAnalysisTemplatesInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListCollaborationAnalysisTemplatesOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListCollaborationConfiguredAudienceModelAssociationsInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListCollaborationConfiguredAudienceModelAssociationsOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", + "ListAnalysisTemplatesInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListAnalysisTemplatesOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListCollaborationAnalysisTemplatesInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListCollaborationAnalysisTemplatesOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListCollaborationConfiguredAudienceModelAssociationsInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListCollaborationConfiguredAudienceModelAssociationsOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", "ListCollaborationIdNamespaceAssociationsInput$nextToken": "The pagination token that's used to fetch the next set of results.
", "ListCollaborationIdNamespaceAssociationsOutput$nextToken": "The token value provided to access the next page of results.
", - "ListCollaborationPrivacyBudgetTemplatesInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListCollaborationPrivacyBudgetTemplatesOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListCollaborationPrivacyBudgetsInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListCollaborationPrivacyBudgetsOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListCollaborationsInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListCollaborationsOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListConfiguredAudienceModelAssociationsInput$nextToken": "The pagination token that's used to fetch the next set of results.
", + "ListCollaborationPrivacyBudgetTemplatesInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListCollaborationPrivacyBudgetTemplatesOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListCollaborationPrivacyBudgetsInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListCollaborationPrivacyBudgetsOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListCollaborationsInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListCollaborationsOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListConfiguredAudienceModelAssociationsInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", "ListConfiguredAudienceModelAssociationsOutput$nextToken": "The token value provided to access the next page of results.
", - "ListConfiguredTableAssociationsInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListConfiguredTableAssociationsOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListConfiguredTablesInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListConfiguredTablesOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", + "ListConfiguredTableAssociationsInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListConfiguredTableAssociationsOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListConfiguredTablesInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListConfiguredTablesOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", "ListIdMappingTablesInput$nextToken": "The pagination token that's used to fetch the next set of results.
", "ListIdMappingTablesOutput$nextToken": "The token value provided to access the next page of results.
", "ListIdNamespaceAssociationsInput$nextToken": "The pagination token that's used to fetch the next set of results.
", "ListIdNamespaceAssociationsOutput$nextToken": "The token value provided to access the next page of results.
", - "ListMembersInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListMembersOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListMembershipsInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListMembershipsOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListPrivacyBudgetTemplatesInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListPrivacyBudgetTemplatesOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListPrivacyBudgetsInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListPrivacyBudgetsOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListProtectedQueriesInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListProtectedQueriesOutput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListSchemasInput$nextToken": "The pagination token that's used to fetch the next set of results.
", - "ListSchemasOutput$nextToken": "The pagination token that's used to fetch the next set of results.
" + "ListMembersInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListMembersOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListMembershipsInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListMembershipsOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListPrivacyBudgetTemplatesInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListPrivacyBudgetTemplatesOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListPrivacyBudgetsInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListPrivacyBudgetsOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListProtectedQueriesInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListProtectedQueriesOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListSchemasInput$nextToken": "The token value retrieved from a previous call to access the next page of results.
", + "ListSchemasOutput$nextToken": "The token value retrieved from a previous call to access the next page of results.
" } }, "ParameterMap": { @@ -2368,6 +2523,12 @@ "UpdateProtectedQueryInput$protectedQueryIdentifier": "The identifier for a protected query instance.
" } }, + "ProtectedQueryMemberOutputConfiguration": { + "base": "Contains configuration details for the protected query member output.
", + "refs": { + "ProtectedQueryOutputConfiguration$member": " Required configuration for a protected query with a member output type.
Contains the configuration to write the query results to S3.
", "refs": { "MembershipProtectedQueryOutputConfiguration$s3": null, - "ProtectedQueryOutputConfiguration$s3": "Required configuration for a protected query with an `S3` output type.
" + "ProtectedQueryOutputConfiguration$s3": "Required configuration for a protected query with an s3 output type.
The tables referenced in the analysis schema.
" } }, + "ReceiverAccountIds": { + "base": null, + "refs": { + "DirectAnalysisConfigurationDetails$receiverAccountIds": "The account IDs for the member who received the results of a protected query.
" + } + }, + "ReceiverConfiguration": { + "base": "The receiver configuration for a protected query.
", + "refs": { + "ReceiverConfigurationsList$member": null + } + }, + "ReceiverConfigurationsList": { + "base": null, + "refs": { + "ProtectedQuerySummary$receiverConfigurations": "The receiver configuration.
" + } + }, "ResourceAlias": { "base": null, "refs": { @@ -2623,7 +2802,7 @@ "SchemaStatus": { "base": null, "refs": { - "SchemaStatusDetail$status": "The status of the schema.
" + "SchemaStatusDetail$status": "The status of the schema, indicating if it is ready to query.
" } }, "SchemaStatusDetail": { @@ -2671,9 +2850,9 @@ "SchemaType": { "base": null, "refs": { - "ListSchemasInput$schemaType": "If present, filter schemas by schema type.
", - "Schema$type": "The type of schema.
", - "SchemaSummary$type": "The type of schema object.
" + "ListSchemasInput$schemaType": "If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.
", + "Schema$type": "The type of schema. The only valid value is currently `TABLE`.
", + "SchemaSummary$type": "The type of schema object. The only valid schema type is currently `TABLE`.
" } }, "SchemaTypeProperties": { @@ -2868,6 +3047,8 @@ "ConfiguredTableAnalysisRule$updateTime": "The time the configured table analysis rule was last updated.
", "ConfiguredTableAssociation$createTime": "The time the configured table association was created.
", "ConfiguredTableAssociation$updateTime": "The time the configured table association was last updated.
", + "ConfiguredTableAssociationAnalysisRule$createTime": "The creation time of the configured table association analysis rule.
", + "ConfiguredTableAssociationAnalysisRule$updateTime": "The update time of the configured table association analysis rule.
", "ConfiguredTableAssociationSummary$createTime": "The time the configured table association was created.
", "ConfiguredTableAssociationSummary$updateTime": "The time the configured table association was last updated.
", "ConfiguredTableSummary$createTime": "The time the configured table was created.
", @@ -2894,8 +3075,8 @@ "PrivacyBudgetTemplateSummary$updateTime": "The most recent time at which the privacy budget template was updated.
", "ProtectedQuery$createTime": "The time at which the protected query was created.
", "ProtectedQuerySummary$createTime": "The time the protected query was created.
", - "Schema$createTime": "The time at which the schema was created.
", - "Schema$updateTime": "The most recent time at which the schema was updated.
", + "Schema$createTime": "The time the schema was created.
", + "Schema$updateTime": "The time the schema was last updated.
", "SchemaSummary$createTime": "The time the schema object was created.
", "SchemaSummary$updateTime": "The time the schema object was last updated.
" } @@ -3014,6 +3195,16 @@ "refs": { } }, + "UpdateConfiguredTableAssociationAnalysisRuleInput": { + "base": null, + "refs": { + } + }, + "UpdateConfiguredTableAssociationAnalysisRuleOutput": { + "base": null, + "refs": { + } + }, "UpdateConfiguredTableAssociationInput": { "base": null, "refs": { diff --git a/models/apis/dynamodb/2012-08-10/docs-2.json b/models/apis/dynamodb/2012-08-10/docs-2.json index 42ebea0d339..872fd2430a1 100644 --- a/models/apis/dynamodb/2012-08-10/docs-2.json +++ b/models/apis/dynamodb/2012-08-10/docs-2.json @@ -2,16 +2,16 @@ "version": "2.0", "service": "Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.
With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the Amazon Web Services Management Console to monitor resource utilization and performance metrics.
DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an Amazon Web Services Region, providing built-in high availability and data durability.
", "operations": { - "BatchExecuteStatement": "This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.
The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.
A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.
This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB .
The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.
A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.
The BatchGetItem operation returns the attributes of one or more items 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 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.
If you request more than 100 items, BatchGetItem returns a ValidationException with the message \"Too many items requested for the BatchGetItem call.\"
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem may retrieve items in parallel.
When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values 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 nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
", - "BatchWriteItem": "The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.
BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.
BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
For tables and indexes with provisioned capacity, if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. For all tables and indexes, if none of the items can be processed due to other throttling scenarios (such as exceeding partition level limits), then BatchWriteItem returns a ThrottlingException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
Creates a backup for an existing table.
Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.
When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.
You can call CreateBackup at a maximum rate of 50 times per second.
All backups in DynamoDB work without consuming any provisioned throughput on the table.
If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.
Along with data, the following are also included on the backups:
Global secondary indexes (GSIs)
Local secondary indexes (LSIs)
Streams
Provisioned read and write capacity
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
This 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).
To 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.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.
CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.
You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.
You can use the DescribeTable action to check the table status.
Deletes an existing backup of a table.
You can call DeleteBackup at a maximum rate of 10 times per second.
Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.
In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.
Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
", "DeleteResourcePolicy": "Deletes the resource-based policy attached to the resource, which can be a table or stream.
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.
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.
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. For the full list of table states, see TableStatus.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
Describes an existing backup of a table.
You can call DescribeBackup at a maximum rate of 10 times per second.
Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.
After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.
LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.
You can call DescribeContinuousBackups at a maximum rate of 10 times per second.
Returns information about contributor insights for a given table or global secondary index.
", @@ -1610,7 +1610,7 @@ "base": null, "refs": { "QueryOutput$Count": "The number of items in the response.
If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the same.
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
The number of items in the response.
If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as ScannedCount.
The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
Removes a tag from an IoT SiteWise resource.
", "UpdateAccessPolicy": "Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
", "UpdateAsset": "Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
", - "UpdateAssetModel": "Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.
If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.
To replace an existing asset model property with a new one with the same name, do the following:
Submit an UpdateAssetModel request with the entire existing property removed.
Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.
Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
If you remove a property from 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.
To 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 name as the previous one and IoT SiteWise will generate a new unique id.
Updates an asset property's alias and notification state.
This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
Updates an IoT SiteWise Monitor dashboard.
", @@ -118,7 +118,7 @@ "DescribePortalResponse$roleArn": "The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
", "DescribeProjectResponse$projectArn": "The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference.
", + "Greengrass$groupArn": "The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass V1 API Reference.
", "IAMRoleIdentity$arn": "The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide.
", "IAMUserIdentity$arn": "The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide.
If you delete the IAM user, access policies that contain this identity include an empty arn. You can delete the access policy for the IAM user that no longer exists.
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.
The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.
The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.
The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.
The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.
The asset property definitions for this composite model.
", "DescribeAssetModelCompositeModelResponse$assetModelCompositeModelProperties": "The property definitions of the composite model.
", "DescribeAssetModelResponse$assetModelProperties": "The list of asset properties for the asset model.
This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.
The property definitions of the composite model. For more information, see <LINK>.
You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
", + "UpdateAssetModelCompositeModelRequest$assetModelCompositeModelProperties": "The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.
You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
", "UpdateAssetModelRequest$assetModelProperties": "The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
" } }, @@ -438,7 +438,7 @@ "base": null, "refs": { "AssetModelCompositeModelDefinition$properties": "The asset property definitions for this composite model.
", - "CreateAssetModelCompositeModelRequest$assetModelCompositeModelProperties": "The property definitions of the composite model. For more information, see <LINK>.
You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
", + "CreateAssetModelCompositeModelRequest$assetModelCompositeModelProperties": "The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.
You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
", "CreateAssetModelRequest$assetModelProperties": "The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
" } }, @@ -1253,7 +1253,7 @@ "AssociateTimeSeriesToAssetPropertyRequest$propertyId": "The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The ID of the asset model this composite model is a part of.
", "CreateAssetModelCompositeModelRequest$parentAssetModelCompositeModelId": "The ID of the parent composite model in this asset model relationship.
", - "CreateAssetModelCompositeModelRequest$composedAssetModelId": "The ID of a composite model on this asset.
", + "CreateAssetModelCompositeModelRequest$composedAssetModelId": "The ID of a component model which is reused to create this composite model.
", "CreateAssetRequest$assetModelId": "The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The ID of the asset model, in UUID format.
", "DeleteAssetModelCompositeModelRequest$assetModelCompositeModelId": "The ID of a composite model on this asset model.
", @@ -1603,7 +1603,7 @@ "AssetCompositeModelSummary$description": "A description of the composite model that this summary describes.
", "AssetModelCompositeModel$description": "The description of the composite model.
", "AssetModelCompositeModelDefinition$description": "The description of the composite model.
", - "AssetModelCompositeModelSummary$description": "The description of the the composite model that this summary describes..
", + "AssetModelCompositeModelSummary$description": "The description of the composite model that this summary describes..
", "AssetModelSummary$description": "The asset model description.
", "AssetSummary$description": "A description for the asset.
", "AssociatedAssetsSummary$description": "A description for the asset.
", @@ -1897,6 +1897,15 @@ "GatewayCapabilitySummaries$member": null } }, + "GatewayName": { + "base": null, + "refs": { + "CreateGatewayRequest$gatewayName": "A unique name for the gateway.
", + "DescribeGatewayResponse$gatewayName": "The name of the gateway.
", + "GatewaySummary$gatewayName": "The name of the gateway.
", + "UpdateGatewayRequest$gatewayName": "A unique name for the gateway.
" + } + }, "GatewayPlatform": { "base": "Contains a gateway's platform information.
", "refs": { @@ -2016,7 +2025,7 @@ "AssetIDs$member": null, "AssetModelCompositeModelDefinition$id": "The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, 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.
", "AssetModelCompositeModelPathSegment$id": "The ID of the path segment.
", - "AssetModelCompositeModelSummary$id": "The ID of the the composite model that this summary describes..
", + "AssetModelCompositeModelSummary$id": "The ID of the composite model that this summary describes..
", "AssetModelHierarchyDefinition$id": "The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, 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.
", "AssetModelPropertyDefinition$id": "The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, 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.
", "AssetModelPropertyPathSegment$id": "The ID of the path segment.
", @@ -2237,6 +2246,12 @@ "refs": { } }, + "IotCoreThingName": { + "base": null, + "refs": { + "SiemensIE$iotCoreThingName": "The name of the IoT Thing for your SiteWise Edge gateway.
" + } + }, "JobConfiguration": { "base": "Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
", "refs": { @@ -2611,8 +2626,8 @@ "AssetModelCompositeModelDefinition$name": "The name of the composite model.
", "AssetModelCompositeModelDefinition$type": "The type of the composite model. For alarm composite models, this type is AWS/ALARM.
The name of the path segment.
", - "AssetModelCompositeModelSummary$name": "The name of the the composite model that this summary describes..
", - "AssetModelCompositeModelSummary$type": "The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
The name of the composite model that this summary describes..
", + "AssetModelCompositeModelSummary$type": "The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
", "AssetModelHierarchyDefinition$name": "The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
", "AssetModelProperty$name": "The name of the asset model property.
", @@ -2631,14 +2646,13 @@ "CompositeModelProperty$name": "The name of the property.
", "CompositeModelProperty$type": "The type of the composite model that defines this property.
", "CompositionRelationshipSummary$assetModelCompositeModelType": "The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
A unique, friendly name for the composite model.
", + "CreateAssetModelCompositeModelRequest$assetModelCompositeModelName": "A unique name for the composite model.
", "CreateAssetModelCompositeModelRequest$assetModelCompositeModelType": "The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
A unique, friendly name for the asset model.
", + "CreateAssetModelRequest$assetModelName": "A unique name for the asset model.
", "CreateAssetRequest$assetName": "A friendly name for the asset.
", "CreateBulkImportJobRequest$jobName": "The unique name that helps identify the job request.
", "CreateBulkImportJobResponse$jobName": "The unique name that helps identify the job request.
", "CreateDashboardRequest$dashboardName": "A friendly name for the dashboard.
", - "CreateGatewayRequest$gatewayName": "A unique, friendly name for the gateway.
", "CreatePortalRequest$portalName": "A friendly name for the portal.
", "CreateProjectRequest$projectName": "A friendly name for the project.
", "DashboardSummary$name": "The name of the dashboard
", @@ -2651,21 +2665,18 @@ "DescribeAssetResponse$assetName": "The name of the asset.
", "DescribeBulkImportJobResponse$jobName": "The unique name that helps identify the job request.
", "DescribeDashboardResponse$dashboardName": "The name of the dashboard.
", - "DescribeGatewayResponse$gatewayName": "The name of the gateway.
", "DescribePortalResponse$portalName": "The name of the portal.
", "DescribeProjectResponse$projectName": "The name of the project.
", "DescribeTimeSeriesResponse$dataTypeSpec": "The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.
The name of the asset.
", "JobSummary$name": "The unique name that helps identify the job request.
", "PortalSummary$name": "The name of the portal.
", "ProjectSummary$name": "The name of the project.
", "Property$name": "The name of the property.
", "TimeSeriesSummary$dataTypeSpec": "The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.
A unique, friendly name for the composite model.
", - "UpdateAssetModelRequest$assetModelName": "A unique, friendly name for the asset model.
", + "UpdateAssetModelCompositeModelRequest$assetModelCompositeModelName": "A unique name for the composite model.
", + "UpdateAssetModelRequest$assetModelName": "A unique name for the asset model.
", "UpdateAssetRequest$assetName": "A friendly name for the asset.
", "UpdateDashboardRequest$dashboardName": "A new friendly name for the dashboard.
", - "UpdateGatewayRequest$gatewayName": "A unique, friendly name for the gateway.
", "UpdatePortalRequest$portalName": "A new friendly name for the portal.
", "UpdateProjectRequest$projectName": "A new friendly name for the project.
" } @@ -2913,7 +2924,7 @@ "PropertyValueIntegerValue": { "base": null, "refs": { - "Variant$integerValue": "Asset property data of type integer (number that's greater than or equal to zero).
" + "Variant$integerValue": "Asset property data of type integer (whole number).
" } }, "PropertyValueStringValue": { @@ -3083,6 +3094,12 @@ "refs": { } }, + "SiemensIE": { + "base": "Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
", + "refs": { + "GatewayPlatform$siemensIE": "A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
" + } + }, "StorageType": { "base": null, "refs": { diff --git a/models/apis/mediapackagev2/2022-12-25/api-2.json b/models/apis/mediapackagev2/2022-12-25/api-2.json index 9f8d44ae583..115c205bec5 100644 --- a/models/apis/mediapackagev2/2022-12-25/api-2.json +++ b/models/apis/mediapackagev2/2022-12-25/api-2.json @@ -2,7 +2,6 @@ "version":"2.0", "metadata":{ "apiVersion":"2022-12-25", - "auth":["aws.auth#sigv4"], "endpointPrefix":"mediapackagev2", "protocol":"rest-json", "protocols":["rest-json"], @@ -975,7 +974,8 @@ "CLEAR_KEY_AES_128", "FAIRPLAY", "PLAYREADY", - "WIDEVINE" + "WIDEVINE", + "IRDETO" ] }, "Encryption":{ diff --git a/models/apis/medical-imaging/2023-07-19/api-2.json b/models/apis/medical-imaging/2023-07-19/api-2.json index 552ee7138fb..8bd53d8b9fa 100644 --- a/models/apis/medical-imaging/2023-07-19/api-2.json +++ b/models/apis/medical-imaging/2023-07-19/api-2.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2023-07-19", + "auth":["aws.auth#sigv4"], "endpointPrefix":"medical-imaging", "protocol":"rest-json", "protocols":["rest-json"], @@ -371,6 +372,10 @@ "min":12, "pattern":"\\d+" }, + "Boolean":{ + "type":"boolean", + "box":true + }, "ClientToken":{ "type":"string", "max":64, @@ -389,6 +394,12 @@ }, "exception":true }, + "CopiableAttributes":{ + "type":"string", + "max":260000, + "min":1, + "sensitive":true + }, "CopyDestinationImageSet":{ "type":"structure", "required":[ @@ -442,7 +453,12 @@ "location":"uri", "locationName":"sourceImageSetId" }, - "copyImageSetInformation":{"shape":"CopyImageSetInformation"} + "copyImageSetInformation":{"shape":"CopyImageSetInformation"}, + "force":{ + "shape":"Boolean", + "location":"querystring", + "locationName":"force" + } }, "payload":"copyImageSetInformation" }, @@ -463,7 +479,8 @@ "type":"structure", "required":["latestVersionId"], "members":{ - "latestVersionId":{"shape":"ImageSetExternalVersionId"} + "latestVersionId":{"shape":"ImageSetExternalVersionId"}, + "DICOMCopies":{"shape":"MetadataCopies"} } }, "CopySourceImageSetProperties":{ @@ -508,7 +525,7 @@ }, "DICOMAccessionNumber":{ "type":"string", - "max":16, + "max":256, "min":0, "sensitive":true }, @@ -572,7 +589,7 @@ }, "DICOMNumberOfStudyRelatedSeries":{ "type":"integer", - "max":10000, + "max":1000000, "min":0 }, "DICOMPatientBirthDate":{ @@ -583,7 +600,7 @@ }, "DICOMPatientId":{ "type":"string", - "max":64, + "max":256, "min":0, "sensitive":true }, @@ -607,9 +624,9 @@ }, "DICOMSeriesInstanceUID":{ "type":"string", - "max":64, + "max":256, "min":0, - "pattern":"(?:[1-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", + "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", "sensitive":true }, "DICOMSeriesModality":{ @@ -653,9 +670,9 @@ }, "DICOMStudyInstanceUID":{ "type":"string", - "max":64, + "max":256, "min":0, - "pattern":"(?:[1-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", + "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", "sensitive":true }, "DICOMStudyTime":{ @@ -969,7 +986,8 @@ "updatedAt":{"shape":"Date"}, "deletedAt":{"shape":"Date"}, "message":{"shape":"Message"}, - "imageSetArn":{"shape":"Arn"} + "imageSetArn":{"shape":"Arn"}, + "overrides":{"shape":"Overrides"} } }, "ImageFrameId":{ @@ -1010,7 +1028,8 @@ "createdAt":{"shape":"Date"}, "updatedAt":{"shape":"Date"}, "deletedAt":{"shape":"Date"}, - "message":{"shape":"Message"} + "message":{"shape":"Message"}, + "overrides":{"shape":"Overrides"} } }, "ImageSetPropertiesList":{ @@ -1236,10 +1255,18 @@ "min":1, "pattern":"[\\w -:]+" }, + "MetadataCopies":{ + "type":"structure", + "required":["copiableAttributes"], + "members":{ + "copiableAttributes":{"shape":"CopiableAttributes"} + } + }, "MetadataUpdates":{ "type":"structure", "members":{ - "DICOMUpdates":{"shape":"DICOMUpdates"} + "DICOMUpdates":{"shape":"DICOMUpdates"}, + "revertToVersionId":{"shape":"ImageSetExternalVersionId"} }, "union":true }, @@ -1256,6 +1283,12 @@ "BETWEEN" ] }, + "Overrides":{ + "type":"structure", + "members":{ + "forced":{"shape":"Boolean"} + } + }, "PayloadBlob":{ "type":"blob", "streaming":true @@ -1549,6 +1582,11 @@ "location":"querystring", "locationName":"latestVersion" }, + "force":{ + "shape":"Boolean", + "location":"querystring", + "locationName":"force" + }, "updateImageSetMetadataUpdates":{"shape":"MetadataUpdates"} }, "payload":"updateImageSetMetadataUpdates" diff --git a/models/apis/medical-imaging/2023-07-19/docs-2.json b/models/apis/medical-imaging/2023-07-19/docs-2.json index 29cd9ec70b2..dff18e7409e 100644 --- a/models/apis/medical-imaging/2023-07-19/docs-2.json +++ b/models/apis/medical-imaging/2023-07-19/docs-2.json @@ -46,6 +46,14 @@ "StartDICOMImportJobRequest$inputOwnerAccountId": "The account ID of the source S3 bucket owner.
" } }, + "Boolean": { + "base": null, + "refs": { + "CopyImageSetRequest$force": "Setting this flag will force the CopyImageSet operation, even if Patient, Study, or Series level metadata are mismatched across the sourceImageSet and destinationImageSet.
Setting this flag will force the CopyImageSet and UpdateImageSetMetadata operations, even if Patient, Study, or Series level metadata are mismatched.
Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:
Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and Tag.StudyID
Adding, removing, or updating private tags for an individual SOP Instance
The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.
" + } + }, "CopyDestinationImageSet": { "base": "Copy the destination image set.
", "refs": { @@ -442,6 +456,7 @@ "GetImageSetRequest$versionId": "The image set version identifier.
", "GetImageSetResponse$versionId": "The image set version identifier.
", "ImageSetProperties$versionId": "The image set version identifier.
", + "MetadataUpdates$revertToVersionId": "Specifies the previous image set version ID to revert the current image set back to.
You must provide either revertToVersionId or DICOMUpdates in your request. A ValidationException error is thrown if both parameters are provided at the same time.
The latest image set version identifier.
", "UpdateImageSetMetadataResponse$latestVersionId": "The latest image set version identifier.
" } @@ -630,6 +645,12 @@ "UpdateImageSetMetadataResponse$message": "The error message thrown if an update image set metadata action fails.
" } }, + "MetadataCopies": { + "base": "Contains copiable Attributes structure and wraps information related to specific copy use cases. For example, when copying subsets.
Contains MetadataCopies structure and wraps information related to specific copy use cases. For example, when copying subsets.
Contains DICOMUpdates.
", "refs": { @@ -655,6 +676,13 @@ "SearchFilter$operator": "The search filter operator for imageSetDateTime.
Specifies the overrides used in image set modification calls to CopyImageSet and UpdateImageSetMetadata.
This object contains the details of any overrides used while creating a specific image set version. If an image set was copied or updated using the force flag, this object will contain the forced flag.
Contains details on overrides used when creating the returned version of an image set. For example, if forced exists, the forced flag was used when creating the image set.
Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. Amazon Pinpoint SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint SMS, it's also helpful to review the Amazon Pinpoint SMS User Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.
", + "service": "Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference. This guide provides information about AWS End User Messaging SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the AWS End User Messaging SMS User Guide. The AWS End User Messaging SMS User Guide provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The AWS End User Messaging SMS and Voice version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.
", "operations": { "AssociateOriginationIdentity": "Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an error is returned.
", "AssociateProtectConfiguration": "Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
", "CreateConfigurationSet": "Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
", - "CreateEventDestination": "Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
", - "CreateOptOutList": "Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
", + "CreateEventDestination": "Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.
", + "CreateOptOutList": "Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the AWS End User Messaging SMS User Guide.
", "CreatePool": "Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
", "CreateProtectConfiguration": "Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.
Creates a new registration based on the RegistrationType field.
", @@ -19,7 +19,7 @@ "DeleteDefaultMessageType": "Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
", "DeleteDefaultSenderId": "Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
", "DeleteEventDestination": "Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
", - "DeleteKeyword": "Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
Keywords \"HELP\" and \"STOP\" can't be deleted or modified.
", + "DeleteKeyword": "Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
Keywords \"HELP\" and \"STOP\" can't be deleted or modified.
", "DeleteMediaMessageSpendLimitOverride": "Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas for Server Migration Service in the Server Migration Service User Guide.
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
", "DeleteOptedOutNumber": "Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
", @@ -28,13 +28,13 @@ "DeleteRegistration": "Permanently delete an existing registration from your account.
", "DeleteRegistrationAttachment": "Permanently delete the specified registration attachment.
", "DeleteRegistrationFieldValue": "Delete the value in a registration form field.
", - "DeleteTextMessageSpendLimitOverride": "Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide.
Delete a verified destination phone number.
", - "DeleteVoiceMessageSpendLimitOverride": "Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
", - "DescribeAccountLimits": "Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
", + "DeleteVoiceMessageSpendLimitOverride": "Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide.
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
", + "DescribeAccountLimits": "Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Quotas in the AWS End User Messaging SMS User Guide.
", "DescribeConfigurationSets": "Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
", - "DescribeKeywords": "Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
", + "DescribeKeywords": "Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
", "DescribeOptOutLists": "Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an error is returned.
", "DescribeOptedOutNumbers": "Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an error is returned.
", "DescribePhoneNumbers": "Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an error is returned.
", @@ -48,7 +48,7 @@ "DescribeRegistrationVersions": "Retrieves the specified registration version.
", "DescribeRegistrations": "Retrieves the specified registrations.
", "DescribeSenderIds": "Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an error is returned.
", - "DescribeSpendLimits": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
", + "DescribeSpendLimits": "Describes the current monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS, MMS, or Voice spending quota in the AWS End User Messaging SMS User Guide.
", "DescribeVerifiedDestinationNumbers": "Retrieves the specified verified destiona numbers.
", "DisassociateOriginationIdentity": "Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
", "DisassociateProtectConfiguration": "Disassociate a protect configuration from a configuration set.
", @@ -57,17 +57,17 @@ "ListPoolOriginationIdentities": "Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
", "ListRegistrationAssociations": "Retreive all of the origination identies that are associated with a registration.
", "ListTagsForResource": "List all tags associated with a resource.
", - "PutKeyword": "Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
", + "PutKeyword": "Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
", "PutOptedOutNumber": "Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
", "PutRegistrationFieldValue": "Creates or updates a field value for a registration.
", "ReleasePhoneNumber": "Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
", "ReleaseSenderId": "Releases an existing sender ID in your account.
", - "RequestPhoneNumber": "Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
", + "RequestPhoneNumber": "Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the AWS End User Messaging SMS User Guide.
", "RequestSenderId": "Request a new sender ID that doesn't require registration.
", "SendDestinationNumberVerificationCode": "Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
", "SendMediaMessage": "Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
", - "SendTextMessage": "Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
", - "SendVoiceMessage": "Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
", + "SendTextMessage": "Creates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information about MPS, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide.
", + "SendVoiceMessage": "Allows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.
", "SetAccountDefaultProtectConfiguration": "Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
", "SetDefaultMessageType": "Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
", "SetDefaultSenderId": "Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
", @@ -75,9 +75,9 @@ "SetTextMessageSpendLimitOverride": "Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Submit the specified registration for review and approval.
", - "TagResource": "Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
", - "UntagResource": "Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
", - "UpdateEventDestination": "Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
", + "TagResource": "Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide.
", + "UntagResource": "Removes the association of the specified tags from a resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.
", + "UpdateEventDestination": "Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Firehose, and Amazon SNS.
", "UpdatePhoneNumber": "Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an error is returned.
", "UpdatePool": "Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
Update the setting for an existing protect configuration.
", @@ -199,10 +199,10 @@ "RequestSenderIdRequest$DeletionProtectionEnabled": "By default this is set to false. When set to true the sender ID can't be deleted.
", "UpdateEventDestinationRequest$Enabled": "When set to true logging is enabled.
", "UpdatePhoneNumberRequest$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", - "UpdatePhoneNumberRequest$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", + "UpdatePhoneNumberRequest$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", "UpdatePhoneNumberRequest$DeletionProtectionEnabled": "By default this is set to false. When set to true the phone number can't be deleted.
", "UpdatePoolRequest$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", - "UpdatePoolRequest$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", + "UpdatePoolRequest$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", "UpdatePoolRequest$SharedRoutesEnabled": "Indicates whether shared routes are enabled for the pool.
", "UpdatePoolRequest$DeletionProtectionEnabled": "When set to true the pool can't be deleted.
", "UpdateProtectConfigurationRequest$DeletionProtectionEnabled": "When set to true deletion protection is enabled. By default this is set to false.
", @@ -822,7 +822,7 @@ "base": null, "refs": { "SendDestinationNumberVerificationCodeRequest$DestinationCountryParameters": "This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
", - "SendTextMessageRequest$DestinationCountryParameters": "This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
" + "SendTextMessageRequest$DestinationCountryParameters": "This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.
IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.
Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.
Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose, or Amazon SNS.
", + "base": "Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Firehose, or Amazon SNS.
", "refs": { "CreateEventDestinationResult$EventDestination": "The details of the destination where events are logged.
", "DeleteEventDestinationResult$EventDestination": "The event destination object that was deleted.
", @@ -895,7 +895,7 @@ "EventTypeList": { "base": null, "refs": { - "CreateEventDestinationRequest$MatchingEventTypes": "An array of event types that determine which events to log. If \"ALL\" is used, then Amazon Pinpoint logs every event type.
The TEXT_SENT event type is not supported.
An array of event types that determine which events to log. If \"ALL\" is used, then AWS End User Messaging SMS and Voice logs every event type.
The TEXT_SENT event type is not supported.
An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
", "CreatePoolResult$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "DeletePoolResult$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", - "KinesisFirehoseDestination$IamRoleArn": "The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.
", + "KinesisFirehoseDestination$IamRoleArn": "The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination.
", "PhoneNumberInformation$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "PoolInformation$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "ReleasePhoneNumberResult$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", @@ -1092,11 +1092,11 @@ } }, "KinesisFirehoseDestination": { - "base": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Kinesis Data Firehose event destination.
Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.
", + "base": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Firehose event destination.
Event destinations, such as Firehose, are associated with configuration sets, which enable you to publish message sending events.
", "refs": { - "CreateEventDestinationRequest$KinesisFirehoseDestination": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
", - "EventDestination$KinesisFirehoseDestination": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
", - "UpdateEventDestinationRequest$KinesisFirehoseDestination": "An object that contains information about an event destination for logging to Kinesis Data Firehose.
" + "CreateEventDestinationRequest$KinesisFirehoseDestination": "An object that contains information about an event destination for logging to Amazon Data Firehose.
", + "EventDestination$KinesisFirehoseDestination": "An object that contains information about an event destination for logging to Amazon Data Firehose.
", + "UpdateEventDestinationRequest$KinesisFirehoseDestination": "An object that contains information about an event destination for logging to Firehose.
" } }, "LanguageCode": { @@ -1145,7 +1145,7 @@ "base": null, "refs": { "SendMediaMessageRequest$MaxPrice": "The maximum amount that you want to spend, in US dollars, per each MMS message.
", - "SendTextMessageRequest$MaxPrice": "The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
", + "SendTextMessageRequest$MaxPrice": "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.
The maximum amount to spend per voice message, in US dollars.
" } }, @@ -1197,7 +1197,7 @@ "base": null, "refs": { "ConfigurationSetInformation$DefaultMessageType": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", - "CreatePoolRequest$MessageType": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", + "CreatePoolRequest$MessageType": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed.
", "CreatePoolResult$MessageType": "The type of message for the pool to use.
", "DeleteConfigurationSetResult$DefaultMessageType": "The default message type of the configuration set that was deleted.
", "DeleteDefaultMessageTypeResult$MessageType": "The current message type for the configuration set.
", @@ -1512,7 +1512,7 @@ "base": null, "refs": { "AssociateOriginationIdentityRequest$OriginationIdentity": "The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
", - "CreatePoolRequest$OriginationIdentity": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
", + "CreatePoolRequest$OriginationIdentity": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.
", "DisassociateOriginationIdentityRequest$OriginationIdentity": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
" } }, @@ -1595,38 +1595,38 @@ "base": null, "refs": { "CreatePoolResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", - "CreatePoolResult$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", - "CreatePoolResult$SharedRoutesEnabled": "Indicates whether shared routes are enabled for the pool.
", + "CreatePoolResult$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", + "CreatePoolResult$SharedRoutesEnabled": "Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
", "CreatePoolResult$DeletionProtectionEnabled": "When set to true deletion protection is enabled. By default this is set to false.
", "CreateProtectConfigurationResult$AccountDefault": "This is true if the protect configuration is set as your account default protect configuration.
", "CreateProtectConfigurationResult$DeletionProtectionEnabled": "When set to true deletion protection is enabled. By default this is set to false.
", "DeleteOptedOutNumberResult$EndUserOptedOut": "This is true if it was the end user who requested their phone number be removed.
", "DeletePoolResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", - "DeletePoolResult$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", + "DeletePoolResult$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", "DeletePoolResult$SharedRoutesEnabled": "Indicates whether shared routes are enabled for the pool.
", "DeleteProtectConfigurationResult$AccountDefault": "This is true if the protect configuration is set as your account default protect configuration.
", "DeleteProtectConfigurationResult$DeletionProtectionEnabled": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
", "OptedOutNumberInformation$EndUserOptedOut": "This is set to true if it was the end recipient that opted out.
", "PhoneNumberInformation$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
", - "PhoneNumberInformation$SelfManagedOptOutsEnabled": "When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
", + "PhoneNumberInformation$SelfManagedOptOutsEnabled": "When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
", "PhoneNumberInformation$DeletionProtectionEnabled": "When set to true the phone number can't be deleted.
", "PoolInformation$TwoWayEnabled": "When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
", - "PoolInformation$SelfManagedOptOutsEnabled": "When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
", - "PoolInformation$SharedRoutesEnabled": "Allows you to enable shared routes on your pool.
By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
", + "PoolInformation$SharedRoutesEnabled": "Allows you to enable shared routes on your pool.
By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
When set to true the pool can't be deleted.
", "ProtectConfigurationInformation$AccountDefault": "This is true if the protect configuration is set as your account default protect configuration.
", "ProtectConfigurationInformation$DeletionProtectionEnabled": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
", "PutOptedOutNumberResult$EndUserOptedOut": "This is true if it was the end user who requested their phone number be removed.
", "ReleasePhoneNumberResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", - "ReleasePhoneNumberResult$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", + "ReleasePhoneNumberResult$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", "ReleaseSenderIdResult$Registered": "True if the sender ID is registered.
", "RequestPhoneNumberResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", - "RequestPhoneNumberResult$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", + "RequestPhoneNumberResult$SelfManagedOptOutsEnabled": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", "RequestPhoneNumberResult$DeletionProtectionEnabled": "By default this is set to false. When set to true the phone number can't be deleted.
", "RequestSenderIdResult$DeletionProtectionEnabled": "By default this is set to false. When set to true the sender ID can't be deleted.
", "RequestSenderIdResult$Registered": "True if the sender ID is registered.
", "SendMediaMessageRequest$DryRun": "When set to true, the message is checked and validated, but isn't sent to the end recipient.
", - "SendTextMessageRequest$DryRun": "When set to true, the message is checked and validated, but isn't sent to the end recipient.
", + "SendTextMessageRequest$DryRun": "When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.
The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..
When set to true, the message is checked and validated, but isn't sent to the end recipient.
", "SenderIdInformation$DeletionProtectionEnabled": "By default this is set to false. When set to true the sender ID can't be deleted.
", "SenderIdInformation$Registered": "True if the sender ID is registered.
", @@ -1635,7 +1635,7 @@ "UpdatePhoneNumberResult$SelfManagedOptOutsEnabled": "This is true if self managed opt-out are enabled.
", "UpdatePhoneNumberResult$DeletionProtectionEnabled": "When set to true the phone number can't be deleted.
", "UpdatePoolResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", - "UpdatePoolResult$SelfManagedOptOutsEnabled": "When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", + "UpdatePoolResult$SelfManagedOptOutsEnabled": "When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
", "UpdatePoolResult$SharedRoutesEnabled": "Indicates whether shared routes are enabled for the pool.
", "UpdatePoolResult$DeletionProtectionEnabled": "When set to true the pool can't be deleted.
", "UpdateProtectConfigurationResult$AccountDefault": "This is true if the protect configuration is set as your account default protect configuration.
", @@ -1671,8 +1671,8 @@ "ProtectConfigurationCountryRuleSet": { "base": null, "refs": { - "GetProtectConfigurationCountryRuleSetResult$CountryRuleSet": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.
", - "UpdateProtectConfigurationCountryRuleSetRequest$CountryRuleSetUpdates": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.
", + "GetProtectConfigurationCountryRuleSetResult$CountryRuleSet": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
", + "UpdateProtectConfigurationCountryRuleSetRequest$CountryRuleSetUpdates": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
", "UpdateProtectConfigurationCountryRuleSetResult$CountryRuleSet": "An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.
" } }, @@ -2298,7 +2298,7 @@ } }, "SenderIdAndCountry": { - "base": "The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.
", + "base": "The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs in the AWS End User Messaging SMS User Guide.
", "refs": { "SenderIdList$member": null } @@ -2433,7 +2433,7 @@ } }, "SpendLimit": { - "base": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
", + "base": "Describes the current monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting a spending quota increase in the AWS End User Messaging SMS User Guide.
", "refs": { "SpendLimitList$member": null } @@ -2755,7 +2755,7 @@ "base": null, "refs": { "SendMediaMessageRequest$TimeToLive": "How long the text message is valid for. By default this is 72 hours.
", - "SendTextMessageRequest$TimeToLive": "How long the text message is valid for. By default this is 72 hours.
", + "SendTextMessageRequest$TimeToLive": "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.
How long the voice message is valid for. By default this is 72 hours.
" } }, diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 7ed4272e4de..a91017603cd 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -28325,7 +28325,8 @@ }, "apigateway" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "appconfig" : { @@ -29201,6 +29202,11 @@ "us-isob-east-1" : { } } }, + "apigateway" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, "appconfig" : { "endpoints" : { "us-isob-east-1" : { } diff --git a/service/cleanrooms/api.go b/service/cleanrooms/api.go index 0ab87c19ad0..301dcb22a20 100644 --- a/service/cleanrooms/api.go +++ b/service/cleanrooms/api.go @@ -862,6 +862,100 @@ func (c *CleanRooms) CreateConfiguredTableAssociationWithContext(ctx aws.Context return out, req.Send() } +const opCreateConfiguredTableAssociationAnalysisRule = "CreateConfiguredTableAssociationAnalysisRule" + +// CreateConfiguredTableAssociationAnalysisRuleRequest generates a "aws/request.Request" representing the +// client's request for the CreateConfiguredTableAssociationAnalysisRule operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateConfiguredTableAssociationAnalysisRule for more information on using the CreateConfiguredTableAssociationAnalysisRule +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateConfiguredTableAssociationAnalysisRuleRequest method. +// req, resp := client.CreateConfiguredTableAssociationAnalysisRuleRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule +func (c *CleanRooms) CreateConfiguredTableAssociationAnalysisRuleRequest(input *CreateConfiguredTableAssociationAnalysisRuleInput) (req *request.Request, output *CreateConfiguredTableAssociationAnalysisRuleOutput) { + op := &request.Operation{ + Name: opCreateConfiguredTableAssociationAnalysisRule, + HTTPMethod: "POST", + HTTPPath: "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule", + } + + if input == nil { + input = &CreateConfiguredTableAssociationAnalysisRuleInput{} + } + + output = &CreateConfiguredTableAssociationAnalysisRuleOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateConfiguredTableAssociationAnalysisRule API operation for AWS Clean Rooms Service. +// +// Creates a new analysis rule for an associated configured table. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Clean Rooms Service's +// API operation CreateConfiguredTableAssociationAnalysisRule for usage and error information. +// +// Returned Error Types: +// +// - ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// - ResourceNotFoundException +// Request references a resource which does not exist. +// +// - InternalServerException +// Unexpected error during processing of request. +// +// - ValidationException +// The input fails to satisfy the specified constraints. +// +// - ThrottlingException +// Request was denied due to request throttling. +// +// - AccessDeniedException +// Caller does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule +func (c *CleanRooms) CreateConfiguredTableAssociationAnalysisRule(input *CreateConfiguredTableAssociationAnalysisRuleInput) (*CreateConfiguredTableAssociationAnalysisRuleOutput, error) { + req, out := c.CreateConfiguredTableAssociationAnalysisRuleRequest(input) + return out, req.Send() +} + +// CreateConfiguredTableAssociationAnalysisRuleWithContext is the same as CreateConfiguredTableAssociationAnalysisRule with the addition of +// the ability to pass a context and additional request options. +// +// See CreateConfiguredTableAssociationAnalysisRule for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *CleanRooms) CreateConfiguredTableAssociationAnalysisRuleWithContext(ctx aws.Context, input *CreateConfiguredTableAssociationAnalysisRuleInput, opts ...request.Option) (*CreateConfiguredTableAssociationAnalysisRuleOutput, error) { + req, out := c.CreateConfiguredTableAssociationAnalysisRuleRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateIdMappingTable = "CreateIdMappingTable" // CreateIdMappingTableRequest generates a "aws/request.Request" representing the @@ -1713,6 +1807,101 @@ func (c *CleanRooms) DeleteConfiguredTableAssociationWithContext(ctx aws.Context return out, req.Send() } +const opDeleteConfiguredTableAssociationAnalysisRule = "DeleteConfiguredTableAssociationAnalysisRule" + +// DeleteConfiguredTableAssociationAnalysisRuleRequest generates a "aws/request.Request" representing the +// client's request for the DeleteConfiguredTableAssociationAnalysisRule operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteConfiguredTableAssociationAnalysisRule for more information on using the DeleteConfiguredTableAssociationAnalysisRule +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteConfiguredTableAssociationAnalysisRuleRequest method. +// req, resp := client.DeleteConfiguredTableAssociationAnalysisRuleRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule +func (c *CleanRooms) DeleteConfiguredTableAssociationAnalysisRuleRequest(input *DeleteConfiguredTableAssociationAnalysisRuleInput) (req *request.Request, output *DeleteConfiguredTableAssociationAnalysisRuleOutput) { + op := &request.Operation{ + Name: opDeleteConfiguredTableAssociationAnalysisRule, + HTTPMethod: "DELETE", + HTTPPath: "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}", + } + + if input == nil { + input = &DeleteConfiguredTableAssociationAnalysisRuleInput{} + } + + output = &DeleteConfiguredTableAssociationAnalysisRuleOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteConfiguredTableAssociationAnalysisRule API operation for AWS Clean Rooms Service. +// +// Deletes an analysis rule for a configured table association. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Clean Rooms Service's +// API operation DeleteConfiguredTableAssociationAnalysisRule for usage and error information. +// +// Returned Error Types: +// +// - ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// - ResourceNotFoundException +// Request references a resource which does not exist. +// +// - InternalServerException +// Unexpected error during processing of request. +// +// - ValidationException +// The input fails to satisfy the specified constraints. +// +// - ThrottlingException +// Request was denied due to request throttling. +// +// - AccessDeniedException +// Caller does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule +func (c *CleanRooms) DeleteConfiguredTableAssociationAnalysisRule(input *DeleteConfiguredTableAssociationAnalysisRuleInput) (*DeleteConfiguredTableAssociationAnalysisRuleOutput, error) { + req, out := c.DeleteConfiguredTableAssociationAnalysisRuleRequest(input) + return out, req.Send() +} + +// DeleteConfiguredTableAssociationAnalysisRuleWithContext is the same as DeleteConfiguredTableAssociationAnalysisRule with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteConfiguredTableAssociationAnalysisRule for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *CleanRooms) DeleteConfiguredTableAssociationAnalysisRuleWithContext(ctx aws.Context, input *DeleteConfiguredTableAssociationAnalysisRuleInput, opts ...request.Option) (*DeleteConfiguredTableAssociationAnalysisRuleOutput, error) { + req, out := c.DeleteConfiguredTableAssociationAnalysisRuleRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteIdMappingTable = "DeleteIdMappingTable" // DeleteIdMappingTableRequest generates a "aws/request.Request" representing the @@ -2998,6 +3187,97 @@ func (c *CleanRooms) GetConfiguredTableAssociationWithContext(ctx aws.Context, i return out, req.Send() } +const opGetConfiguredTableAssociationAnalysisRule = "GetConfiguredTableAssociationAnalysisRule" + +// GetConfiguredTableAssociationAnalysisRuleRequest generates a "aws/request.Request" representing the +// client's request for the GetConfiguredTableAssociationAnalysisRule operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetConfiguredTableAssociationAnalysisRule for more information on using the GetConfiguredTableAssociationAnalysisRule +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetConfiguredTableAssociationAnalysisRuleRequest method. +// req, resp := client.GetConfiguredTableAssociationAnalysisRuleRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule +func (c *CleanRooms) GetConfiguredTableAssociationAnalysisRuleRequest(input *GetConfiguredTableAssociationAnalysisRuleInput) (req *request.Request, output *GetConfiguredTableAssociationAnalysisRuleOutput) { + op := &request.Operation{ + Name: opGetConfiguredTableAssociationAnalysisRule, + HTTPMethod: "GET", + HTTPPath: "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}", + } + + if input == nil { + input = &GetConfiguredTableAssociationAnalysisRuleInput{} + } + + output = &GetConfiguredTableAssociationAnalysisRuleOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetConfiguredTableAssociationAnalysisRule API operation for AWS Clean Rooms Service. +// +// Retrieves the analysis rule for a configured table association. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Clean Rooms Service's +// API operation GetConfiguredTableAssociationAnalysisRule for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// Request references a resource which does not exist. +// +// - InternalServerException +// Unexpected error during processing of request. +// +// - ValidationException +// The input fails to satisfy the specified constraints. +// +// - ThrottlingException +// Request was denied due to request throttling. +// +// - AccessDeniedException +// Caller does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule +func (c *CleanRooms) GetConfiguredTableAssociationAnalysisRule(input *GetConfiguredTableAssociationAnalysisRuleInput) (*GetConfiguredTableAssociationAnalysisRuleOutput, error) { + req, out := c.GetConfiguredTableAssociationAnalysisRuleRequest(input) + return out, req.Send() +} + +// GetConfiguredTableAssociationAnalysisRuleWithContext is the same as GetConfiguredTableAssociationAnalysisRule with the addition of +// the ability to pass a context and additional request options. +// +// See GetConfiguredTableAssociationAnalysisRule for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *CleanRooms) GetConfiguredTableAssociationAnalysisRuleWithContext(ctx aws.Context, input *GetConfiguredTableAssociationAnalysisRuleInput, opts ...request.Option) (*GetConfiguredTableAssociationAnalysisRuleOutput, error) { + req, out := c.GetConfiguredTableAssociationAnalysisRuleRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetIdMappingTable = "GetIdMappingTable" // GetIdMappingTableRequest generates a "aws/request.Request" representing the @@ -7284,60 +7564,63 @@ func (c *CleanRooms) UpdateConfiguredTableAssociationWithContext(ctx aws.Context return out, req.Send() } -const opUpdateIdMappingTable = "UpdateIdMappingTable" +const opUpdateConfiguredTableAssociationAnalysisRule = "UpdateConfiguredTableAssociationAnalysisRule" -// UpdateIdMappingTableRequest generates a "aws/request.Request" representing the -// client's request for the UpdateIdMappingTable operation. The "output" return +// UpdateConfiguredTableAssociationAnalysisRuleRequest generates a "aws/request.Request" representing the +// client's request for the UpdateConfiguredTableAssociationAnalysisRule operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateIdMappingTable for more information on using the UpdateIdMappingTable +// See UpdateConfiguredTableAssociationAnalysisRule for more information on using the UpdateConfiguredTableAssociationAnalysisRule // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the UpdateIdMappingTableRequest method. -// req, resp := client.UpdateIdMappingTableRequest(params) +// // Example sending a request using the UpdateConfiguredTableAssociationAnalysisRuleRequest method. +// req, resp := client.UpdateConfiguredTableAssociationAnalysisRuleRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateIdMappingTable -func (c *CleanRooms) UpdateIdMappingTableRequest(input *UpdateIdMappingTableInput) (req *request.Request, output *UpdateIdMappingTableOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule +func (c *CleanRooms) UpdateConfiguredTableAssociationAnalysisRuleRequest(input *UpdateConfiguredTableAssociationAnalysisRuleInput) (req *request.Request, output *UpdateConfiguredTableAssociationAnalysisRuleOutput) { op := &request.Operation{ - Name: opUpdateIdMappingTable, + Name: opUpdateConfiguredTableAssociationAnalysisRule, HTTPMethod: "PATCH", - HTTPPath: "/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}", + HTTPPath: "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}", } if input == nil { - input = &UpdateIdMappingTableInput{} + input = &UpdateConfiguredTableAssociationAnalysisRuleInput{} } - output = &UpdateIdMappingTableOutput{} + output = &UpdateConfiguredTableAssociationAnalysisRuleOutput{} req = c.newRequest(op, input, output) return } -// UpdateIdMappingTable API operation for AWS Clean Rooms Service. +// UpdateConfiguredTableAssociationAnalysisRule API operation for AWS Clean Rooms Service. // -// Provides the details that are necessary to update an ID mapping table. +// Updates the analysis rule for a configured table association. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Clean Rooms Service's -// API operation UpdateIdMappingTable for usage and error information. +// API operation UpdateConfiguredTableAssociationAnalysisRule for usage and error information. // // Returned Error Types: // +// - ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// // - ResourceNotFoundException // Request references a resource which does not exist. // @@ -7353,56 +7636,147 @@ func (c *CleanRooms) UpdateIdMappingTableRequest(input *UpdateIdMappingTableInpu // - AccessDeniedException // Caller does not have sufficient access to perform this action. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateIdMappingTable -func (c *CleanRooms) UpdateIdMappingTable(input *UpdateIdMappingTableInput) (*UpdateIdMappingTableOutput, error) { - req, out := c.UpdateIdMappingTableRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule +func (c *CleanRooms) UpdateConfiguredTableAssociationAnalysisRule(input *UpdateConfiguredTableAssociationAnalysisRuleInput) (*UpdateConfiguredTableAssociationAnalysisRuleOutput, error) { + req, out := c.UpdateConfiguredTableAssociationAnalysisRuleRequest(input) return out, req.Send() } -// UpdateIdMappingTableWithContext is the same as UpdateIdMappingTable with the addition of +// UpdateConfiguredTableAssociationAnalysisRuleWithContext is the same as UpdateConfiguredTableAssociationAnalysisRule with the addition of // the ability to pass a context and additional request options. // -// See UpdateIdMappingTable for details on how to use this API operation. +// See UpdateConfiguredTableAssociationAnalysisRule for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *CleanRooms) UpdateIdMappingTableWithContext(ctx aws.Context, input *UpdateIdMappingTableInput, opts ...request.Option) (*UpdateIdMappingTableOutput, error) { - req, out := c.UpdateIdMappingTableRequest(input) +func (c *CleanRooms) UpdateConfiguredTableAssociationAnalysisRuleWithContext(ctx aws.Context, input *UpdateConfiguredTableAssociationAnalysisRuleInput, opts ...request.Option) (*UpdateConfiguredTableAssociationAnalysisRuleOutput, error) { + req, out := c.UpdateConfiguredTableAssociationAnalysisRuleRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateMembership = "UpdateMembership" +const opUpdateIdMappingTable = "UpdateIdMappingTable" -// UpdateMembershipRequest generates a "aws/request.Request" representing the -// client's request for the UpdateMembership operation. The "output" return +// UpdateIdMappingTableRequest generates a "aws/request.Request" representing the +// client's request for the UpdateIdMappingTable operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateMembership for more information on using the UpdateMembership +// See UpdateIdMappingTable for more information on using the UpdateIdMappingTable // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the UpdateMembershipRequest method. -// req, resp := client.UpdateMembershipRequest(params) +// // Example sending a request using the UpdateIdMappingTableRequest method. +// req, resp := client.UpdateIdMappingTableRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateMembership -func (c *CleanRooms) UpdateMembershipRequest(input *UpdateMembershipInput) (req *request.Request, output *UpdateMembershipOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateIdMappingTable +func (c *CleanRooms) UpdateIdMappingTableRequest(input *UpdateIdMappingTableInput) (req *request.Request, output *UpdateIdMappingTableOutput) { op := &request.Operation{ - Name: opUpdateMembership, + Name: opUpdateIdMappingTable, + HTTPMethod: "PATCH", + HTTPPath: "/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}", + } + + if input == nil { + input = &UpdateIdMappingTableInput{} + } + + output = &UpdateIdMappingTableOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateIdMappingTable API operation for AWS Clean Rooms Service. +// +// Provides the details that are necessary to update an ID mapping table. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Clean Rooms Service's +// API operation UpdateIdMappingTable for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// Request references a resource which does not exist. +// +// - InternalServerException +// Unexpected error during processing of request. +// +// - ValidationException +// The input fails to satisfy the specified constraints. +// +// - ThrottlingException +// Request was denied due to request throttling. +// +// - AccessDeniedException +// Caller does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateIdMappingTable +func (c *CleanRooms) UpdateIdMappingTable(input *UpdateIdMappingTableInput) (*UpdateIdMappingTableOutput, error) { + req, out := c.UpdateIdMappingTableRequest(input) + return out, req.Send() +} + +// UpdateIdMappingTableWithContext is the same as UpdateIdMappingTable with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateIdMappingTable for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *CleanRooms) UpdateIdMappingTableWithContext(ctx aws.Context, input *UpdateIdMappingTableInput, opts ...request.Option) (*UpdateIdMappingTableOutput, error) { + req, out := c.UpdateIdMappingTableRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateMembership = "UpdateMembership" + +// UpdateMembershipRequest generates a "aws/request.Request" representing the +// client's request for the UpdateMembership operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateMembership for more information on using the UpdateMembership +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateMembershipRequest method. +// req, resp := client.UpdateMembershipRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateMembership +func (c *CleanRooms) UpdateMembershipRequest(input *UpdateMembershipInput) (req *request.Request, output *UpdateMembershipOutput) { + op := &request.Operation{ + Name: opUpdateMembership, HTTPMethod: "PATCH", HTTPPath: "/memberships/{membershipIdentifier}", } @@ -8045,6 +8419,13 @@ func (s *AnalysisRule) SetUpdateTime(v time.Time) *AnalysisRule { type AnalysisRuleAggregation struct { _ struct{} `type:"structure"` + // An indicator as to whether additional analyses (such as Clean Rooms ML) can + // be applied to the output of the direct query. + // + // The additionalAnalyses parameter is currently supported for the list analysis + // rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom). + AdditionalAnalyses *string `locationName:"additionalAnalyses" type:"string" enum:"AdditionalAnalyses"` + // The columns that query runners are allowed to use in aggregation queries. // // AggregateColumns is a required field @@ -8152,6 +8533,12 @@ func (s *AnalysisRuleAggregation) Validate() error { return nil } +// SetAdditionalAnalyses sets the AdditionalAnalyses field's value. +func (s *AnalysisRuleAggregation) SetAdditionalAnalyses(v string) *AnalysisRuleAggregation { + s.AdditionalAnalyses = &v + return s +} + // SetAggregateColumns sets the AggregateColumns field's value. func (s *AnalysisRuleAggregation) SetAggregateColumns(v []*AggregateColumn) *AnalysisRuleAggregation { s.AggregateColumns = v @@ -8199,6 +8586,10 @@ func (s *AnalysisRuleAggregation) SetScalarFunctions(v []*string) *AnalysisRuleA type AnalysisRuleCustom struct { _ struct{} `type:"structure"` + // An indicator as to whether additional analyses (such as Clean Rooms ML) can + // be applied to the output of the direct query. + AdditionalAnalyses *string `locationName:"additionalAnalyses" type:"string" enum:"AdditionalAnalyses"` + // The ARN of the analysis templates that are allowed by the custom analysis // rule. // @@ -8211,6 +8602,9 @@ type AnalysisRuleCustom struct { // The differential privacy configuration. DifferentialPrivacy *DifferentialPrivacyConfiguration `locationName:"differentialPrivacy" type:"structure"` + + // A list of columns that aren't allowed to be shown in the query output. + DisallowedOutputColumns []*string `locationName:"disallowedOutputColumns" type:"list"` } // String returns the string representation. @@ -8249,6 +8643,12 @@ func (s *AnalysisRuleCustom) Validate() error { return nil } +// SetAdditionalAnalyses sets the AdditionalAnalyses field's value. +func (s *AnalysisRuleCustom) SetAdditionalAnalyses(v string) *AnalysisRuleCustom { + s.AdditionalAnalyses = &v + return s +} + // SetAllowedAnalyses sets the AllowedAnalyses field's value. func (s *AnalysisRuleCustom) SetAllowedAnalyses(v []*string) *AnalysisRuleCustom { s.AllowedAnalyses = v @@ -8267,6 +8667,12 @@ func (s *AnalysisRuleCustom) SetDifferentialPrivacy(v *DifferentialPrivacyConfig return s } +// SetDisallowedOutputColumns sets the DisallowedOutputColumns field's value. +func (s *AnalysisRuleCustom) SetDisallowedOutputColumns(v []*string) *AnalysisRuleCustom { + s.DisallowedOutputColumns = v + return s +} + // Defines details for the analysis rule ID mapping table. type AnalysisRuleIdMappingTable struct { _ struct{} `type:"structure"` @@ -8326,6 +8732,10 @@ func (s *AnalysisRuleIdMappingTable) SetQueryConstraints(v []*QueryConstraint) * type AnalysisRuleList struct { _ struct{} `type:"structure"` + // An indicator as to whether additional analyses (such as Clean Rooms ML) can + // be applied to the output of the direct query. + AdditionalAnalyses *string `locationName:"additionalAnalyses" type:"string" enum:"AdditionalAnalyses"` + // The logical operators (if any) that are to be used in an INNER JOIN match // condition. Default is AND. AllowedJoinOperators []*string `locationName:"allowedJoinOperators" type:"list" enum:"JoinOperator"` @@ -8379,6 +8789,12 @@ func (s *AnalysisRuleList) Validate() error { return nil } +// SetAdditionalAnalyses sets the AdditionalAnalyses field's value. +func (s *AnalysisRuleList) SetAdditionalAnalyses(v string) *AnalysisRuleList { + s.AdditionalAnalyses = &v + return s +} + // SetAllowedJoinOperators sets the AllowedJoinOperators field's value. func (s *AnalysisRuleList) SetAllowedJoinOperators(v []*string) *AnalysisRuleList { s.AllowedJoinOperators = v @@ -9990,7 +10406,7 @@ type CollaborationConfiguredAudienceModelAssociation struct { CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"` // The identifier used to reference members of the collaboration. Only supports - // Amazon Web Services account ID. + // AWS account ID. // // CreatorAccountId is a required field CreatorAccountId *string `locationName:"creatorAccountId" min:"12" type:"string" required:"true"` @@ -10119,7 +10535,7 @@ type CollaborationConfiguredAudienceModelAssociationSummary struct { CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"` // The identifier used to reference members of the collaboration. Only supports - // Amazon Web Services account ID. + // AWS account ID. // // CreatorAccountId is a required field CreatorAccountId *string `locationName:"creatorAccountId" min:"12" type:"string" required:"true"` @@ -10937,6 +11353,38 @@ func (s *Column) SetType(v string) *Column { return s } +// The configuration details. +type ConfigurationDetails struct { + _ struct{} `type:"structure"` + + // The direct analysis configuration details. + DirectAnalysisConfigurationDetails *DirectAnalysisConfigurationDetails `locationName:"directAnalysisConfigurationDetails" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfigurationDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfigurationDetails) GoString() string { + return s.String() +} + +// SetDirectAnalysisConfigurationDetails sets the DirectAnalysisConfigurationDetails field's value. +func (s *ConfigurationDetails) SetDirectAnalysisConfigurationDetails(v *DirectAnalysisConfigurationDetails) *ConfigurationDetails { + s.DirectAnalysisConfigurationDetails = v + return s +} + // Details about the configured audience model association. type ConfiguredAudienceModelAssociation struct { _ struct{} `type:"structure"` @@ -11600,6 +12048,9 @@ func (s *ConfiguredTableAnalysisRulePolicyV1) SetList(v *AnalysisRuleList) *Conf type ConfiguredTableAssociation struct { _ struct{} `type:"structure"` + // The analysis rule types for the configured table association. + AnalysisRuleTypes []*string `locationName:"analysisRuleTypes" type:"list" enum:"ConfiguredTableAssociationAnalysisRuleType"` + // The unique ARN for the configured table association. // // Arn is a required field @@ -11677,6 +12128,12 @@ func (s ConfiguredTableAssociation) GoString() string { return s.String() } +// SetAnalysisRuleTypes sets the AnalysisRuleTypes field's value. +func (s *ConfiguredTableAssociation) SetAnalysisRuleTypes(v []*string) *ConfiguredTableAssociation { + s.AnalysisRuleTypes = v + return s +} + // SetArn sets the Arn field's value. func (s *ConfiguredTableAssociation) SetArn(v string) *ConfiguredTableAssociation { s.Arn = &v @@ -11743,50 +12200,44 @@ func (s *ConfiguredTableAssociation) SetUpdateTime(v time.Time) *ConfiguredTable return s } -// The configured table association summary for the objects listed by the request. -type ConfiguredTableAssociationSummary struct { +// An analysis rule for a configured table association. This analysis rule specifies +// how data from the table can be used within its associated collaboration. +// In the console, the ConfiguredTableAssociationAnalysisRule is referred to +// as the collaboration analysis rule. +type ConfiguredTableAssociationAnalysisRule struct { _ struct{} `type:"structure"` - // The unique ARN for the configured table association. + // The Amazon Resource Name (ARN) of the configured table association. // - // Arn is a required field - Arn *string `locationName:"arn" type:"string" required:"true"` + // ConfiguredTableAssociationArn is a required field + ConfiguredTableAssociationArn *string `locationName:"configuredTableAssociationArn" type:"string" required:"true"` - // The unique configured table ID that this configured table association refers - // to. + // The unique identifier for the configured table association. // - // ConfiguredTableId is a required field - ConfiguredTableId *string `locationName:"configuredTableId" min:"36" type:"string" required:"true"` + // ConfiguredTableAssociationId is a required field + ConfiguredTableAssociationId *string `locationName:"configuredTableAssociationId" min:"36" type:"string" required:"true"` - // The time the configured table association was created. + // The creation time of the configured table association analysis rule. // // CreateTime is a required field CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"` - // The unique ID for the configured table association. - // - // Id is a required field - Id *string `locationName:"id" min:"36" type:"string" required:"true"` - - // The unique ARN for the membership that the configured table association belongs - // to. + // The membership identifier for the configured table association analysis rule. // - // MembershipArn is a required field - MembershipArn *string `locationName:"membershipArn" type:"string" required:"true"` + // MembershipIdentifier is a required field + MembershipIdentifier *string `locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` - // The unique ID for the membership that the configured table association belongs - // to. + // The policy of the configured table association analysis rule. // - // MembershipId is a required field - MembershipId *string `locationName:"membershipId" min:"36" type:"string" required:"true"` + // Policy is a required field + Policy *ConfiguredTableAssociationAnalysisRulePolicy `locationName:"policy" type:"structure" required:"true"` - // The name of the configured table association. The table is identified by - // this name when running Protected Queries against the underlying data. + // The type of the configured table association analysis rule. // - // Name is a required field - Name *string `locationName:"name" type:"string" required:"true"` + // Type is a required field + Type *string `locationName:"type" type:"string" required:"true" enum:"ConfiguredTableAssociationAnalysisRuleType"` - // The time the configured table association was last updated. + // The update time of the configured table association analysis rule. // // UpdateTime is a required field UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" required:"true"` @@ -11797,7 +12248,7 @@ type ConfiguredTableAssociationSummary struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ConfiguredTableAssociationSummary) String() string { +func (s ConfiguredTableAssociationAnalysisRule) String() string { return awsutil.Prettify(s) } @@ -11806,97 +12257,67 @@ func (s ConfiguredTableAssociationSummary) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ConfiguredTableAssociationSummary) GoString() string { +func (s ConfiguredTableAssociationAnalysisRule) GoString() string { return s.String() } -// SetArn sets the Arn field's value. -func (s *ConfiguredTableAssociationSummary) SetArn(v string) *ConfiguredTableAssociationSummary { - s.Arn = &v +// SetConfiguredTableAssociationArn sets the ConfiguredTableAssociationArn field's value. +func (s *ConfiguredTableAssociationAnalysisRule) SetConfiguredTableAssociationArn(v string) *ConfiguredTableAssociationAnalysisRule { + s.ConfiguredTableAssociationArn = &v return s } -// SetConfiguredTableId sets the ConfiguredTableId field's value. -func (s *ConfiguredTableAssociationSummary) SetConfiguredTableId(v string) *ConfiguredTableAssociationSummary { - s.ConfiguredTableId = &v +// SetConfiguredTableAssociationId sets the ConfiguredTableAssociationId field's value. +func (s *ConfiguredTableAssociationAnalysisRule) SetConfiguredTableAssociationId(v string) *ConfiguredTableAssociationAnalysisRule { + s.ConfiguredTableAssociationId = &v return s } // SetCreateTime sets the CreateTime field's value. -func (s *ConfiguredTableAssociationSummary) SetCreateTime(v time.Time) *ConfiguredTableAssociationSummary { +func (s *ConfiguredTableAssociationAnalysisRule) SetCreateTime(v time.Time) *ConfiguredTableAssociationAnalysisRule { s.CreateTime = &v return s } -// SetId sets the Id field's value. -func (s *ConfiguredTableAssociationSummary) SetId(v string) *ConfiguredTableAssociationSummary { - s.Id = &v - return s -} - -// SetMembershipArn sets the MembershipArn field's value. -func (s *ConfiguredTableAssociationSummary) SetMembershipArn(v string) *ConfiguredTableAssociationSummary { - s.MembershipArn = &v +// SetMembershipIdentifier sets the MembershipIdentifier field's value. +func (s *ConfiguredTableAssociationAnalysisRule) SetMembershipIdentifier(v string) *ConfiguredTableAssociationAnalysisRule { + s.MembershipIdentifier = &v return s } -// SetMembershipId sets the MembershipId field's value. -func (s *ConfiguredTableAssociationSummary) SetMembershipId(v string) *ConfiguredTableAssociationSummary { - s.MembershipId = &v +// SetPolicy sets the Policy field's value. +func (s *ConfiguredTableAssociationAnalysisRule) SetPolicy(v *ConfiguredTableAssociationAnalysisRulePolicy) *ConfiguredTableAssociationAnalysisRule { + s.Policy = v return s } -// SetName sets the Name field's value. -func (s *ConfiguredTableAssociationSummary) SetName(v string) *ConfiguredTableAssociationSummary { - s.Name = &v +// SetType sets the Type field's value. +func (s *ConfiguredTableAssociationAnalysisRule) SetType(v string) *ConfiguredTableAssociationAnalysisRule { + s.Type = &v return s } // SetUpdateTime sets the UpdateTime field's value. -func (s *ConfiguredTableAssociationSummary) SetUpdateTime(v time.Time) *ConfiguredTableAssociationSummary { +func (s *ConfiguredTableAssociationAnalysisRule) SetUpdateTime(v time.Time) *ConfiguredTableAssociationAnalysisRule { s.UpdateTime = &v return s } -// The configured table summary for the objects listed by the request. -type ConfiguredTableSummary struct { +// The configured table association analysis rule applied to a configured table +// with the aggregation analysis rule. +type ConfiguredTableAssociationAnalysisRuleAggregation struct { _ struct{} `type:"structure"` - // The analysis method for the configured tables. The only valid value is currently - // `DIRECT_QUERY`. - // - // AnalysisMethod is a required field - AnalysisMethod *string `locationName:"analysisMethod" type:"string" required:"true" enum:"AnalysisMethod"` - - // The types of analysis rules associated with this configured table. - // - // AnalysisRuleTypes is a required field - AnalysisRuleTypes []*string `locationName:"analysisRuleTypes" type:"list" required:"true" enum:"ConfiguredTableAnalysisRuleType"` - - // The unique ARN of the configured table. - // - // Arn is a required field - Arn *string `locationName:"arn" type:"string" required:"true"` - - // The time the configured table was created. - // - // CreateTime is a required field - CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"` - - // The unique ID of the configured table. - // - // Id is a required field - Id *string `locationName:"id" min:"36" type:"string" required:"true"` - - // The name of the configured table. + // The list of resources or wildcards (ARNs) that are allowed to perform additional + // analysis on query output. // - // Name is a required field - Name *string `locationName:"name" min:"1" type:"string" required:"true"` + // The allowedAdditionalAnalyses parameter is currently supported for the list + // analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom). + AllowedAdditionalAnalyses []*string `locationName:"allowedAdditionalAnalyses" type:"list"` - // The time the configured table was last updated. - // - // UpdateTime is a required field - UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" required:"true"` + // The list of collaboration members who are allowed to receive results of queries + // run with this configured table. + AllowedResultReceivers []*string `locationName:"allowedResultReceivers" type:"list"` } // String returns the string representation. @@ -11904,7 +12325,7 @@ type ConfiguredTableSummary struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ConfiguredTableSummary) String() string { +func (s ConfiguredTableAssociationAnalysisRuleAggregation) String() string { return awsutil.Prettify(s) } @@ -11913,36 +12334,396 @@ func (s ConfiguredTableSummary) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ConfiguredTableSummary) GoString() string { +func (s ConfiguredTableAssociationAnalysisRuleAggregation) GoString() string { return s.String() } -// SetAnalysisMethod sets the AnalysisMethod field's value. -func (s *ConfiguredTableSummary) SetAnalysisMethod(v string) *ConfiguredTableSummary { - s.AnalysisMethod = &v +// SetAllowedAdditionalAnalyses sets the AllowedAdditionalAnalyses field's value. +func (s *ConfiguredTableAssociationAnalysisRuleAggregation) SetAllowedAdditionalAnalyses(v []*string) *ConfiguredTableAssociationAnalysisRuleAggregation { + s.AllowedAdditionalAnalyses = v return s } -// SetAnalysisRuleTypes sets the AnalysisRuleTypes field's value. -func (s *ConfiguredTableSummary) SetAnalysisRuleTypes(v []*string) *ConfiguredTableSummary { - s.AnalysisRuleTypes = v +// SetAllowedResultReceivers sets the AllowedResultReceivers field's value. +func (s *ConfiguredTableAssociationAnalysisRuleAggregation) SetAllowedResultReceivers(v []*string) *ConfiguredTableAssociationAnalysisRuleAggregation { + s.AllowedResultReceivers = v return s } -// SetArn sets the Arn field's value. -func (s *ConfiguredTableSummary) SetArn(v string) *ConfiguredTableSummary { - s.Arn = &v - return s -} +// The configured table association analysis rule applied to a configured table +// with the custom analysis rule. +type ConfiguredTableAssociationAnalysisRuleCustom struct { + _ struct{} `type:"structure"` -// SetCreateTime sets the CreateTime field's value. -func (s *ConfiguredTableSummary) SetCreateTime(v time.Time) *ConfiguredTableSummary { - s.CreateTime = &v - return s + // The list of resources or wildcards (ARNs) that are allowed to perform additional + // analysis on query output. + AllowedAdditionalAnalyses []*string `locationName:"allowedAdditionalAnalyses" type:"list"` + + // The list of collaboration members who are allowed to receive results of queries + // run with this configured table. + AllowedResultReceivers []*string `locationName:"allowedResultReceivers" type:"list"` } -// SetId sets the Id field's value. -func (s *ConfiguredTableSummary) SetId(v string) *ConfiguredTableSummary { +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationAnalysisRuleCustom) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationAnalysisRuleCustom) GoString() string { + return s.String() +} + +// SetAllowedAdditionalAnalyses sets the AllowedAdditionalAnalyses field's value. +func (s *ConfiguredTableAssociationAnalysisRuleCustom) SetAllowedAdditionalAnalyses(v []*string) *ConfiguredTableAssociationAnalysisRuleCustom { + s.AllowedAdditionalAnalyses = v + return s +} + +// SetAllowedResultReceivers sets the AllowedResultReceivers field's value. +func (s *ConfiguredTableAssociationAnalysisRuleCustom) SetAllowedResultReceivers(v []*string) *ConfiguredTableAssociationAnalysisRuleCustom { + s.AllowedResultReceivers = v + return s +} + +// The configured table association analysis rule applied to a configured table +// with the list analysis rule. +type ConfiguredTableAssociationAnalysisRuleList struct { + _ struct{} `type:"structure"` + + // The list of resources or wildcards (ARNs) that are allowed to perform additional + // analysis on query output. + AllowedAdditionalAnalyses []*string `locationName:"allowedAdditionalAnalyses" type:"list"` + + // The list of collaboration members who are allowed to receive results of queries + // run with this configured table. + AllowedResultReceivers []*string `locationName:"allowedResultReceivers" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationAnalysisRuleList) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationAnalysisRuleList) GoString() string { + return s.String() +} + +// SetAllowedAdditionalAnalyses sets the AllowedAdditionalAnalyses field's value. +func (s *ConfiguredTableAssociationAnalysisRuleList) SetAllowedAdditionalAnalyses(v []*string) *ConfiguredTableAssociationAnalysisRuleList { + s.AllowedAdditionalAnalyses = v + return s +} + +// SetAllowedResultReceivers sets the AllowedResultReceivers field's value. +func (s *ConfiguredTableAssociationAnalysisRuleList) SetAllowedResultReceivers(v []*string) *ConfiguredTableAssociationAnalysisRuleList { + s.AllowedResultReceivers = v + return s +} + +// Controls on the query specifications that can be run on an associated configured +// table. +type ConfiguredTableAssociationAnalysisRulePolicy struct { + _ struct{} `type:"structure"` + + // The policy for the configured table association analysis rule. + V1 *ConfiguredTableAssociationAnalysisRulePolicyV1 `locationName:"v1" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationAnalysisRulePolicy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationAnalysisRulePolicy) GoString() string { + return s.String() +} + +// SetV1 sets the V1 field's value. +func (s *ConfiguredTableAssociationAnalysisRulePolicy) SetV1(v *ConfiguredTableAssociationAnalysisRulePolicyV1) *ConfiguredTableAssociationAnalysisRulePolicy { + s.V1 = v + return s +} + +// Controls on the query specifications that can be run on an associated configured +// table. +type ConfiguredTableAssociationAnalysisRulePolicyV1 struct { + _ struct{} `type:"structure"` + + // Analysis rule type that enables only aggregation queries on a configured + // table. + Aggregation *ConfiguredTableAssociationAnalysisRuleAggregation `locationName:"aggregation" type:"structure"` + + // Analysis rule type that enables the table owner to approve custom SQL queries + // on their configured tables. It supports differential privacy. + Custom *ConfiguredTableAssociationAnalysisRuleCustom `locationName:"custom" type:"structure"` + + // Analysis rule type that enables only list queries on a configured table. + List *ConfiguredTableAssociationAnalysisRuleList `locationName:"list" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationAnalysisRulePolicyV1) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationAnalysisRulePolicyV1) GoString() string { + return s.String() +} + +// SetAggregation sets the Aggregation field's value. +func (s *ConfiguredTableAssociationAnalysisRulePolicyV1) SetAggregation(v *ConfiguredTableAssociationAnalysisRuleAggregation) *ConfiguredTableAssociationAnalysisRulePolicyV1 { + s.Aggregation = v + return s +} + +// SetCustom sets the Custom field's value. +func (s *ConfiguredTableAssociationAnalysisRulePolicyV1) SetCustom(v *ConfiguredTableAssociationAnalysisRuleCustom) *ConfiguredTableAssociationAnalysisRulePolicyV1 { + s.Custom = v + return s +} + +// SetList sets the List field's value. +func (s *ConfiguredTableAssociationAnalysisRulePolicyV1) SetList(v *ConfiguredTableAssociationAnalysisRuleList) *ConfiguredTableAssociationAnalysisRulePolicyV1 { + s.List = v + return s +} + +// The configured table association summary for the objects listed by the request. +type ConfiguredTableAssociationSummary struct { + _ struct{} `type:"structure"` + + // The unique ARN for the configured table association. + // + // Arn is a required field + Arn *string `locationName:"arn" type:"string" required:"true"` + + // The unique configured table ID that this configured table association refers + // to. + // + // ConfiguredTableId is a required field + ConfiguredTableId *string `locationName:"configuredTableId" min:"36" type:"string" required:"true"` + + // The time the configured table association was created. + // + // CreateTime is a required field + CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"` + + // The unique ID for the configured table association. + // + // Id is a required field + Id *string `locationName:"id" min:"36" type:"string" required:"true"` + + // The unique ARN for the membership that the configured table association belongs + // to. + // + // MembershipArn is a required field + MembershipArn *string `locationName:"membershipArn" type:"string" required:"true"` + + // The unique ID for the membership that the configured table association belongs + // to. + // + // MembershipId is a required field + MembershipId *string `locationName:"membershipId" min:"36" type:"string" required:"true"` + + // The name of the configured table association. The table is identified by + // this name when running Protected Queries against the underlying data. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // The time the configured table association was last updated. + // + // UpdateTime is a required field + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableAssociationSummary) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *ConfiguredTableAssociationSummary) SetArn(v string) *ConfiguredTableAssociationSummary { + s.Arn = &v + return s +} + +// SetConfiguredTableId sets the ConfiguredTableId field's value. +func (s *ConfiguredTableAssociationSummary) SetConfiguredTableId(v string) *ConfiguredTableAssociationSummary { + s.ConfiguredTableId = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *ConfiguredTableAssociationSummary) SetCreateTime(v time.Time) *ConfiguredTableAssociationSummary { + s.CreateTime = &v + return s +} + +// SetId sets the Id field's value. +func (s *ConfiguredTableAssociationSummary) SetId(v string) *ConfiguredTableAssociationSummary { + s.Id = &v + return s +} + +// SetMembershipArn sets the MembershipArn field's value. +func (s *ConfiguredTableAssociationSummary) SetMembershipArn(v string) *ConfiguredTableAssociationSummary { + s.MembershipArn = &v + return s +} + +// SetMembershipId sets the MembershipId field's value. +func (s *ConfiguredTableAssociationSummary) SetMembershipId(v string) *ConfiguredTableAssociationSummary { + s.MembershipId = &v + return s +} + +// SetName sets the Name field's value. +func (s *ConfiguredTableAssociationSummary) SetName(v string) *ConfiguredTableAssociationSummary { + s.Name = &v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *ConfiguredTableAssociationSummary) SetUpdateTime(v time.Time) *ConfiguredTableAssociationSummary { + s.UpdateTime = &v + return s +} + +// The configured table summary for the objects listed by the request. +type ConfiguredTableSummary struct { + _ struct{} `type:"structure"` + + // The analysis method for the configured tables. The only valid value is currently + // `DIRECT_QUERY`. + // + // AnalysisMethod is a required field + AnalysisMethod *string `locationName:"analysisMethod" type:"string" required:"true" enum:"AnalysisMethod"` + + // The types of analysis rules associated with this configured table. + // + // AnalysisRuleTypes is a required field + AnalysisRuleTypes []*string `locationName:"analysisRuleTypes" type:"list" required:"true" enum:"ConfiguredTableAnalysisRuleType"` + + // The unique ARN of the configured table. + // + // Arn is a required field + Arn *string `locationName:"arn" type:"string" required:"true"` + + // The time the configured table was created. + // + // CreateTime is a required field + CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"` + + // The unique ID of the configured table. + // + // Id is a required field + Id *string `locationName:"id" min:"36" type:"string" required:"true"` + + // The name of the configured table. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The time the configured table was last updated. + // + // UpdateTime is a required field + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfiguredTableSummary) GoString() string { + return s.String() +} + +// SetAnalysisMethod sets the AnalysisMethod field's value. +func (s *ConfiguredTableSummary) SetAnalysisMethod(v string) *ConfiguredTableSummary { + s.AnalysisMethod = &v + return s +} + +// SetAnalysisRuleTypes sets the AnalysisRuleTypes field's value. +func (s *ConfiguredTableSummary) SetAnalysisRuleTypes(v []*string) *ConfiguredTableSummary { + s.AnalysisRuleTypes = v + return s +} + +// SetArn sets the Arn field's value. +func (s *ConfiguredTableSummary) SetArn(v string) *ConfiguredTableSummary { + s.Arn = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *ConfiguredTableSummary) SetCreateTime(v time.Time) *ConfiguredTableSummary { + s.CreateTime = &v + return s +} + +// SetId sets the Id field's value. +func (s *ConfiguredTableSummary) SetId(v string) *ConfiguredTableSummary { s.Id = &v return s } @@ -12385,7 +13166,7 @@ func (s *CreateCollaborationInput) SetTags(v map[string]*string) *CreateCollabor type CreateCollaborationOutput struct { _ struct{} `type:"structure"` - // The entire created collaboration object. + // The collaboration. // // Collaboration is a required field Collaboration *Collaboration `locationName:"collaboration" type:"structure" required:"true"` @@ -12581,7 +13362,7 @@ func (s *CreateConfiguredAudienceModelAssociationOutput) SetConfiguredAudienceMo type CreateConfiguredTableAnalysisRuleInput struct { _ struct{} `type:"structure"` - // The entire created configured table analysis rule object. + // The analysis rule policy that was created for the configured table. // // AnalysisRulePolicy is a required field AnalysisRulePolicy *ConfiguredTableAnalysisRulePolicy `locationName:"analysisRulePolicy" type:"structure" required:"true"` @@ -12664,7 +13445,7 @@ func (s *CreateConfiguredTableAnalysisRuleInput) SetConfiguredTableIdentifier(v type CreateConfiguredTableAnalysisRuleOutput struct { _ struct{} `type:"structure"` - // The entire created analysis rule. + // The analysis rule that was created for the configured table. // // AnalysisRule is a required field AnalysisRule *ConfiguredTableAnalysisRule `locationName:"analysisRule" type:"structure" required:"true"` @@ -12694,6 +13475,137 @@ func (s *CreateConfiguredTableAnalysisRuleOutput) SetAnalysisRule(v *ConfiguredT return s } +type CreateConfiguredTableAssociationAnalysisRuleInput struct { + _ struct{} `type:"structure"` + + // The analysis rule policy that was created for the configured table association. + // + // AnalysisRulePolicy is a required field + AnalysisRulePolicy *ConfiguredTableAssociationAnalysisRulePolicy `locationName:"analysisRulePolicy" type:"structure" required:"true"` + + // The type of analysis rule. + // + // AnalysisRuleType is a required field + AnalysisRuleType *string `locationName:"analysisRuleType" type:"string" required:"true" enum:"ConfiguredTableAssociationAnalysisRuleType"` + + // The unique ID for the configured table association. Currently accepts the + // configured table association ID. + // + // ConfiguredTableAssociationIdentifier is a required field + ConfiguredTableAssociationIdentifier *string `location:"uri" locationName:"configuredTableAssociationIdentifier" min:"36" type:"string" required:"true"` + + // A unique identifier for the membership that the configured table association + // belongs to. Currently accepts the membership ID. + // + // MembershipIdentifier is a required field + MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateConfiguredTableAssociationAnalysisRuleInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateConfiguredTableAssociationAnalysisRuleInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateConfiguredTableAssociationAnalysisRuleInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateConfiguredTableAssociationAnalysisRuleInput"} + if s.AnalysisRulePolicy == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisRulePolicy")) + } + if s.AnalysisRuleType == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisRuleType")) + } + if s.ConfiguredTableAssociationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ConfiguredTableAssociationIdentifier")) + } + if s.ConfiguredTableAssociationIdentifier != nil && len(*s.ConfiguredTableAssociationIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ConfiguredTableAssociationIdentifier", 36)) + } + if s.MembershipIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("MembershipIdentifier")) + } + if s.MembershipIdentifier != nil && len(*s.MembershipIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("MembershipIdentifier", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnalysisRulePolicy sets the AnalysisRulePolicy field's value. +func (s *CreateConfiguredTableAssociationAnalysisRuleInput) SetAnalysisRulePolicy(v *ConfiguredTableAssociationAnalysisRulePolicy) *CreateConfiguredTableAssociationAnalysisRuleInput { + s.AnalysisRulePolicy = v + return s +} + +// SetAnalysisRuleType sets the AnalysisRuleType field's value. +func (s *CreateConfiguredTableAssociationAnalysisRuleInput) SetAnalysisRuleType(v string) *CreateConfiguredTableAssociationAnalysisRuleInput { + s.AnalysisRuleType = &v + return s +} + +// SetConfiguredTableAssociationIdentifier sets the ConfiguredTableAssociationIdentifier field's value. +func (s *CreateConfiguredTableAssociationAnalysisRuleInput) SetConfiguredTableAssociationIdentifier(v string) *CreateConfiguredTableAssociationAnalysisRuleInput { + s.ConfiguredTableAssociationIdentifier = &v + return s +} + +// SetMembershipIdentifier sets the MembershipIdentifier field's value. +func (s *CreateConfiguredTableAssociationAnalysisRuleInput) SetMembershipIdentifier(v string) *CreateConfiguredTableAssociationAnalysisRuleInput { + s.MembershipIdentifier = &v + return s +} + +type CreateConfiguredTableAssociationAnalysisRuleOutput struct { + _ struct{} `type:"structure"` + + // The analysis rule for the configured table association. In the console, + // the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration + // analysis rule. + // + // AnalysisRule is a required field + AnalysisRule *ConfiguredTableAssociationAnalysisRule `locationName:"analysisRule" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateConfiguredTableAssociationAnalysisRuleOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateConfiguredTableAssociationAnalysisRuleOutput) GoString() string { + return s.String() +} + +// SetAnalysisRule sets the AnalysisRule field's value. +func (s *CreateConfiguredTableAssociationAnalysisRuleOutput) SetAnalysisRule(v *ConfiguredTableAssociationAnalysisRule) *CreateConfiguredTableAssociationAnalysisRuleOutput { + s.AnalysisRule = v + return s +} + type CreateConfiguredTableAssociationInput struct { _ struct{} `type:"structure"` @@ -12820,7 +13732,7 @@ func (s *CreateConfiguredTableAssociationInput) SetTags(v map[string]*string) *C type CreateConfiguredTableAssociationOutput struct { _ struct{} `type:"structure"` - // The entire configured table association object. + // The configured table association. // // ConfiguredTableAssociation is a required field ConfiguredTableAssociation *ConfiguredTableAssociation `locationName:"configuredTableAssociation" type:"structure" required:"true"` @@ -13746,8 +14658,99 @@ func (s *DeleteConfiguredAudienceModelAssociationInput) Validate() error { if s.MembershipIdentifier == nil { invalidParams.Add(request.NewErrParamRequired("MembershipIdentifier")) } - if s.MembershipIdentifier != nil && len(*s.MembershipIdentifier) < 36 { - invalidParams.Add(request.NewErrParamMinLen("MembershipIdentifier", 36)) + if s.MembershipIdentifier != nil && len(*s.MembershipIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("MembershipIdentifier", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConfiguredAudienceModelAssociationIdentifier sets the ConfiguredAudienceModelAssociationIdentifier field's value. +func (s *DeleteConfiguredAudienceModelAssociationInput) SetConfiguredAudienceModelAssociationIdentifier(v string) *DeleteConfiguredAudienceModelAssociationInput { + s.ConfiguredAudienceModelAssociationIdentifier = &v + return s +} + +// SetMembershipIdentifier sets the MembershipIdentifier field's value. +func (s *DeleteConfiguredAudienceModelAssociationInput) SetMembershipIdentifier(v string) *DeleteConfiguredAudienceModelAssociationInput { + s.MembershipIdentifier = &v + return s +} + +type DeleteConfiguredAudienceModelAssociationOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteConfiguredAudienceModelAssociationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteConfiguredAudienceModelAssociationOutput) GoString() string { + return s.String() +} + +type DeleteConfiguredTableAnalysisRuleInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The analysis rule type to be deleted. Configured table analysis rules are + // uniquely identified by their configured table identifier and analysis rule + // type. + // + // AnalysisRuleType is a required field + AnalysisRuleType *string `location:"uri" locationName:"analysisRuleType" type:"string" required:"true" enum:"ConfiguredTableAnalysisRuleType"` + + // The unique identifier for the configured table that the analysis rule applies + // to. Currently accepts the configured table ID. + // + // ConfiguredTableIdentifier is a required field + ConfiguredTableIdentifier *string `location:"uri" locationName:"configuredTableIdentifier" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteConfiguredTableAnalysisRuleInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteConfiguredTableAnalysisRuleInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteConfiguredTableAnalysisRuleInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteConfiguredTableAnalysisRuleInput"} + if s.AnalysisRuleType == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisRuleType")) + } + if s.AnalysisRuleType != nil && len(*s.AnalysisRuleType) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisRuleType", 1)) + } + if s.ConfiguredTableIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ConfiguredTableIdentifier")) + } + if s.ConfiguredTableIdentifier != nil && len(*s.ConfiguredTableIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ConfiguredTableIdentifier", 36)) } if invalidParams.Len() > 0 { @@ -13756,19 +14759,20 @@ func (s *DeleteConfiguredAudienceModelAssociationInput) Validate() error { return nil } -// SetConfiguredAudienceModelAssociationIdentifier sets the ConfiguredAudienceModelAssociationIdentifier field's value. -func (s *DeleteConfiguredAudienceModelAssociationInput) SetConfiguredAudienceModelAssociationIdentifier(v string) *DeleteConfiguredAudienceModelAssociationInput { - s.ConfiguredAudienceModelAssociationIdentifier = &v +// SetAnalysisRuleType sets the AnalysisRuleType field's value. +func (s *DeleteConfiguredTableAnalysisRuleInput) SetAnalysisRuleType(v string) *DeleteConfiguredTableAnalysisRuleInput { + s.AnalysisRuleType = &v return s } -// SetMembershipIdentifier sets the MembershipIdentifier field's value. -func (s *DeleteConfiguredAudienceModelAssociationInput) SetMembershipIdentifier(v string) *DeleteConfiguredAudienceModelAssociationInput { - s.MembershipIdentifier = &v +// SetConfiguredTableIdentifier sets the ConfiguredTableIdentifier field's value. +func (s *DeleteConfiguredTableAnalysisRuleInput) SetConfiguredTableIdentifier(v string) *DeleteConfiguredTableAnalysisRuleInput { + s.ConfiguredTableIdentifier = &v return s } -type DeleteConfiguredAudienceModelAssociationOutput struct { +// An empty response that indicates a successful delete. +type DeleteConfiguredTableAnalysisRuleOutput struct { _ struct{} `type:"structure"` } @@ -13777,7 +14781,7 @@ type DeleteConfiguredAudienceModelAssociationOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteConfiguredAudienceModelAssociationOutput) String() string { +func (s DeleteConfiguredTableAnalysisRuleOutput) String() string { return awsutil.Prettify(s) } @@ -13786,25 +14790,29 @@ func (s DeleteConfiguredAudienceModelAssociationOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteConfiguredAudienceModelAssociationOutput) GoString() string { +func (s DeleteConfiguredTableAnalysisRuleOutput) GoString() string { return s.String() } -type DeleteConfiguredTableAnalysisRuleInput struct { +type DeleteConfiguredTableAssociationAnalysisRuleInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The analysis rule type to be deleted. Configured table analysis rules are - // uniquely identified by their configured table identifier and analysis rule - // type. + // The type of the analysis rule that you want to delete. // // AnalysisRuleType is a required field - AnalysisRuleType *string `location:"uri" locationName:"analysisRuleType" type:"string" required:"true" enum:"ConfiguredTableAnalysisRuleType"` + AnalysisRuleType *string `location:"uri" locationName:"analysisRuleType" type:"string" required:"true" enum:"ConfiguredTableAssociationAnalysisRuleType"` - // The unique identifier for the configured table that the analysis rule applies - // to. Currently accepts the configured table ID. + // The identifier for the configured table association that's related to the + // analysis rule that you want to delete. // - // ConfiguredTableIdentifier is a required field - ConfiguredTableIdentifier *string `location:"uri" locationName:"configuredTableIdentifier" min:"36" type:"string" required:"true"` + // ConfiguredTableAssociationIdentifier is a required field + ConfiguredTableAssociationIdentifier *string `location:"uri" locationName:"configuredTableAssociationIdentifier" min:"36" type:"string" required:"true"` + + // A unique identifier for the membership that the configured table association + // belongs to. Currently accepts the membership ID. + // + // MembershipIdentifier is a required field + MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -13812,7 +14820,7 @@ type DeleteConfiguredTableAnalysisRuleInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteConfiguredTableAnalysisRuleInput) String() string { +func (s DeleteConfiguredTableAssociationAnalysisRuleInput) String() string { return awsutil.Prettify(s) } @@ -13821,24 +14829,30 @@ func (s DeleteConfiguredTableAnalysisRuleInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteConfiguredTableAnalysisRuleInput) GoString() string { +func (s DeleteConfiguredTableAssociationAnalysisRuleInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteConfiguredTableAnalysisRuleInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteConfiguredTableAnalysisRuleInput"} +func (s *DeleteConfiguredTableAssociationAnalysisRuleInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteConfiguredTableAssociationAnalysisRuleInput"} if s.AnalysisRuleType == nil { invalidParams.Add(request.NewErrParamRequired("AnalysisRuleType")) } if s.AnalysisRuleType != nil && len(*s.AnalysisRuleType) < 1 { invalidParams.Add(request.NewErrParamMinLen("AnalysisRuleType", 1)) } - if s.ConfiguredTableIdentifier == nil { - invalidParams.Add(request.NewErrParamRequired("ConfiguredTableIdentifier")) + if s.ConfiguredTableAssociationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ConfiguredTableAssociationIdentifier")) } - if s.ConfiguredTableIdentifier != nil && len(*s.ConfiguredTableIdentifier) < 36 { - invalidParams.Add(request.NewErrParamMinLen("ConfiguredTableIdentifier", 36)) + if s.ConfiguredTableAssociationIdentifier != nil && len(*s.ConfiguredTableAssociationIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ConfiguredTableAssociationIdentifier", 36)) + } + if s.MembershipIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("MembershipIdentifier")) + } + if s.MembershipIdentifier != nil && len(*s.MembershipIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("MembershipIdentifier", 36)) } if invalidParams.Len() > 0 { @@ -13848,19 +14862,24 @@ func (s *DeleteConfiguredTableAnalysisRuleInput) Validate() error { } // SetAnalysisRuleType sets the AnalysisRuleType field's value. -func (s *DeleteConfiguredTableAnalysisRuleInput) SetAnalysisRuleType(v string) *DeleteConfiguredTableAnalysisRuleInput { +func (s *DeleteConfiguredTableAssociationAnalysisRuleInput) SetAnalysisRuleType(v string) *DeleteConfiguredTableAssociationAnalysisRuleInput { s.AnalysisRuleType = &v return s } -// SetConfiguredTableIdentifier sets the ConfiguredTableIdentifier field's value. -func (s *DeleteConfiguredTableAnalysisRuleInput) SetConfiguredTableIdentifier(v string) *DeleteConfiguredTableAnalysisRuleInput { - s.ConfiguredTableIdentifier = &v +// SetConfiguredTableAssociationIdentifier sets the ConfiguredTableAssociationIdentifier field's value. +func (s *DeleteConfiguredTableAssociationAnalysisRuleInput) SetConfiguredTableAssociationIdentifier(v string) *DeleteConfiguredTableAssociationAnalysisRuleInput { + s.ConfiguredTableAssociationIdentifier = &v return s } -// An empty response that indicates a successful delete. -type DeleteConfiguredTableAnalysisRuleOutput struct { +// SetMembershipIdentifier sets the MembershipIdentifier field's value. +func (s *DeleteConfiguredTableAssociationAnalysisRuleInput) SetMembershipIdentifier(v string) *DeleteConfiguredTableAssociationAnalysisRuleInput { + s.MembershipIdentifier = &v + return s +} + +type DeleteConfiguredTableAssociationAnalysisRuleOutput struct { _ struct{} `type:"structure"` } @@ -13869,7 +14888,7 @@ type DeleteConfiguredTableAnalysisRuleOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteConfiguredTableAnalysisRuleOutput) String() string { +func (s DeleteConfiguredTableAssociationAnalysisRuleOutput) String() string { return awsutil.Prettify(s) } @@ -13878,7 +14897,7 @@ func (s DeleteConfiguredTableAnalysisRuleOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteConfiguredTableAnalysisRuleOutput) GoString() string { +func (s DeleteConfiguredTableAssociationAnalysisRuleOutput) GoString() string { return s.String() } @@ -15130,6 +16149,38 @@ func (s *DifferentialPrivacyTemplateUpdateParameters) SetUsersNoisePerQuery(v in return s } +// The direct analysis configuration details. +type DirectAnalysisConfigurationDetails struct { + _ struct{} `type:"structure"` + + // The account IDs for the member who received the results of a protected query. + ReceiverAccountIds []*string `locationName:"receiverAccountIds" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DirectAnalysisConfigurationDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DirectAnalysisConfigurationDetails) GoString() string { + return s.String() +} + +// SetReceiverAccountIds sets the ReceiverAccountIds field's value. +func (s *DirectAnalysisConfigurationDetails) SetReceiverAccountIds(v []*string) *DirectAnalysisConfigurationDetails { + s.ReceiverAccountIds = v + return s +} + type GetAnalysisTemplateInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -15814,6 +16865,126 @@ func (s *GetConfiguredTableAnalysisRuleOutput) SetAnalysisRule(v *ConfiguredTabl return s } +type GetConfiguredTableAssociationAnalysisRuleInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The type of analysis rule that you want to retrieve. + // + // AnalysisRuleType is a required field + AnalysisRuleType *string `location:"uri" locationName:"analysisRuleType" type:"string" required:"true" enum:"ConfiguredTableAssociationAnalysisRuleType"` + + // The identifier for the configured table association that's related to the + // analysis rule. + // + // ConfiguredTableAssociationIdentifier is a required field + ConfiguredTableAssociationIdentifier *string `location:"uri" locationName:"configuredTableAssociationIdentifier" min:"36" type:"string" required:"true"` + + // A unique identifier for the membership that the configured table association + // belongs to. Currently accepts the membership ID. + // + // MembershipIdentifier is a required field + MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetConfiguredTableAssociationAnalysisRuleInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetConfiguredTableAssociationAnalysisRuleInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetConfiguredTableAssociationAnalysisRuleInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetConfiguredTableAssociationAnalysisRuleInput"} + if s.AnalysisRuleType == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisRuleType")) + } + if s.AnalysisRuleType != nil && len(*s.AnalysisRuleType) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisRuleType", 1)) + } + if s.ConfiguredTableAssociationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ConfiguredTableAssociationIdentifier")) + } + if s.ConfiguredTableAssociationIdentifier != nil && len(*s.ConfiguredTableAssociationIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ConfiguredTableAssociationIdentifier", 36)) + } + if s.MembershipIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("MembershipIdentifier")) + } + if s.MembershipIdentifier != nil && len(*s.MembershipIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("MembershipIdentifier", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnalysisRuleType sets the AnalysisRuleType field's value. +func (s *GetConfiguredTableAssociationAnalysisRuleInput) SetAnalysisRuleType(v string) *GetConfiguredTableAssociationAnalysisRuleInput { + s.AnalysisRuleType = &v + return s +} + +// SetConfiguredTableAssociationIdentifier sets the ConfiguredTableAssociationIdentifier field's value. +func (s *GetConfiguredTableAssociationAnalysisRuleInput) SetConfiguredTableAssociationIdentifier(v string) *GetConfiguredTableAssociationAnalysisRuleInput { + s.ConfiguredTableAssociationIdentifier = &v + return s +} + +// SetMembershipIdentifier sets the MembershipIdentifier field's value. +func (s *GetConfiguredTableAssociationAnalysisRuleInput) SetMembershipIdentifier(v string) *GetConfiguredTableAssociationAnalysisRuleInput { + s.MembershipIdentifier = &v + return s +} + +type GetConfiguredTableAssociationAnalysisRuleOutput struct { + _ struct{} `type:"structure"` + + // The analysis rule for the configured table association. In the console, + // the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration + // analysis rule. + // + // AnalysisRule is a required field + AnalysisRule *ConfiguredTableAssociationAnalysisRule `locationName:"analysisRule" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetConfiguredTableAssociationAnalysisRuleOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetConfiguredTableAssociationAnalysisRuleOutput) GoString() string { + return s.String() +} + +// SetAnalysisRule sets the AnalysisRule field's value. +func (s *GetConfiguredTableAssociationAnalysisRuleOutput) SetAnalysisRule(v *ConfiguredTableAssociationAnalysisRule) *GetConfiguredTableAssociationAnalysisRuleOutput { + s.AnalysisRule = v + return s +} + type GetConfiguredTableAssociationInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -17461,9 +18632,7 @@ func (s *InternalServerException) RequestID() string { type ListAnalysisTemplatesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The identifier for a membership resource. @@ -17471,7 +18640,8 @@ type ListAnalysisTemplatesInput struct { // MembershipIdentifier is a required field MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -17538,7 +18708,8 @@ type ListAnalysisTemplatesOutput struct { // AnalysisTemplateSummaries is a required field AnalysisTemplateSummaries []*AnalysisTemplateSummary `locationName:"analysisTemplateSummaries" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -17581,12 +18752,11 @@ type ListCollaborationAnalysisTemplatesInput struct { // CollaborationIdentifier is a required field CollaborationIdentifier *string `location:"uri" locationName:"collaborationIdentifier" min:"36" type:"string" required:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -17653,7 +18823,8 @@ type ListCollaborationAnalysisTemplatesOutput struct { // CollaborationAnalysisTemplateSummaries is a required field CollaborationAnalysisTemplateSummaries []*CollaborationAnalysisTemplateSummary `locationName:"collaborationAnalysisTemplateSummaries" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -17696,12 +18867,11 @@ type ListCollaborationConfiguredAudienceModelAssociationsInput struct { // CollaborationIdentifier is a required field CollaborationIdentifier *string `location:"uri" locationName:"collaborationIdentifier" min:"36" type:"string" required:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -17768,7 +18938,8 @@ type ListCollaborationConfiguredAudienceModelAssociationsOutput struct { // CollaborationConfiguredAudienceModelAssociationSummaries is a required field CollaborationConfiguredAudienceModelAssociationSummaries []*CollaborationConfiguredAudienceModelAssociationSummary `locationName:"collaborationConfiguredAudienceModelAssociationSummaries" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -17926,12 +19097,13 @@ type ListCollaborationPrivacyBudgetTemplatesInput struct { // CollaborationIdentifier is a required field CollaborationIdentifier *string `location:"uri" locationName:"collaborationIdentifier" min:"36" type:"string" required:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. Service chooses + // a default if it has not been set. Service may return a nextToken even if + // the maximum results has not been met. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -18000,7 +19172,8 @@ type ListCollaborationPrivacyBudgetTemplatesOutput struct { // CollaborationPrivacyBudgetTemplateSummaries is a required field CollaborationPrivacyBudgetTemplateSummaries []*CollaborationPrivacyBudgetTemplateSummary `locationName:"collaborationPrivacyBudgetTemplateSummaries" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -18042,12 +19215,13 @@ type ListCollaborationPrivacyBudgetsInput struct { // CollaborationIdentifier is a required field CollaborationIdentifier *string `location:"uri" locationName:"collaborationIdentifier" min:"36" type:"string" required:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. Service chooses + // a default if it has not been set. Service may return a nextToken even if + // the maximum results has not been met. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // Specifies the type of the privacy budget. @@ -18128,7 +19302,8 @@ type ListCollaborationPrivacyBudgetsOutput struct { // CollaborationPrivacyBudgetSummaries is a required field CollaborationPrivacyBudgetSummaries []*CollaborationPrivacyBudgetSummary `locationName:"collaborationPrivacyBudgetSummaries" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -18165,15 +19340,16 @@ func (s *ListCollaborationPrivacyBudgetsOutput) SetNextToken(v string) *ListColl type ListCollaborationsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. Service chooses + // a default if it has not been set. Service may return a nextToken even if + // the maximum results has not been met. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The caller's status in a collaboration. MemberStatus *string `location:"querystring" locationName:"memberStatus" type:"string" enum:"FilterableMemberStatus"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -18234,7 +19410,8 @@ type ListCollaborationsOutput struct { // CollaborationList is a required field CollaborationList []*CollaborationSummary `locationName:"collaborationList" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -18271,9 +19448,9 @@ func (s *ListCollaborationsOutput) SetNextToken(v string) *ListCollaborationsOut type ListConfiguredAudienceModelAssociationsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. Service chooses + // a default if it has not been set. Service may return a nextToken even if + // the maximum results has not been met. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // A unique identifier for a membership that contains the configured audience @@ -18282,7 +19459,8 @@ type ListConfiguredAudienceModelAssociationsInput struct { // MembershipIdentifier is a required field MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -18386,9 +19564,7 @@ func (s *ListConfiguredAudienceModelAssociationsOutput) SetNextToken(v string) * type ListConfiguredTableAssociationsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // A unique identifier for the membership to list configured table associations @@ -18397,7 +19573,8 @@ type ListConfiguredTableAssociationsInput struct { // MembershipIdentifier is a required field MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -18464,7 +19641,8 @@ type ListConfiguredTableAssociationsOutput struct { // ConfiguredTableAssociationSummaries is a required field ConfiguredTableAssociationSummaries []*ConfiguredTableAssociationSummary `locationName:"configuredTableAssociationSummaries" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -18501,12 +19679,11 @@ func (s *ListConfiguredTableAssociationsOutput) SetNextToken(v string) *ListConf type ListConfiguredTablesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -18561,7 +19738,8 @@ type ListConfiguredTablesOutput struct { // ConfiguredTableSummaries is a required field ConfiguredTableSummaries []*ConfiguredTableSummary `locationName:"configuredTableSummaries" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -18833,12 +20011,11 @@ type ListMembersInput struct { // CollaborationIdentifier is a required field CollaborationIdentifier *string `location:"uri" locationName:"collaborationIdentifier" min:"36" type:"string" required:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -18905,7 +20082,8 @@ type ListMembersOutput struct { // MemberSummaries is a required field MemberSummaries []*MemberSummary `locationName:"memberSummaries" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -18942,12 +20120,11 @@ func (s *ListMembersOutput) SetNextToken(v string) *ListMembersOutput { type ListMembershipsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // A filter which will return only memberships in the specified status. @@ -19011,7 +20188,8 @@ type ListMembershipsOutput struct { // MembershipSummaries is a required field MembershipSummaries []*MembershipSummary `locationName:"membershipSummaries" type:"list" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -19048,9 +20226,9 @@ func (s *ListMembershipsOutput) SetNextToken(v string) *ListMembershipsOutput { type ListPrivacyBudgetTemplatesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. Service chooses + // a default if it has not been set. Service may return a nextToken even if + // the maximum results has not been met. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // A unique identifier for one of your memberships for a collaboration. The @@ -19060,7 +20238,8 @@ type ListPrivacyBudgetTemplatesInput struct { // MembershipIdentifier is a required field MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -19122,7 +20301,8 @@ func (s *ListPrivacyBudgetTemplatesInput) SetNextToken(v string) *ListPrivacyBud type ListPrivacyBudgetTemplatesOutput struct { _ struct{} `type:"structure"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` // An array that summarizes the privacy budget templates. The summary includes @@ -19165,9 +20345,9 @@ func (s *ListPrivacyBudgetTemplatesOutput) SetPrivacyBudgetTemplateSummaries(v [ type ListPrivacyBudgetsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. Service chooses + // a default if it has not been set. Service may return a nextToken even if + // the maximum results has not been met. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // A unique identifier for one of your memberships for a collaboration. The @@ -19177,7 +20357,8 @@ type ListPrivacyBudgetsInput struct { // MembershipIdentifier is a required field MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // The privacy budget type. @@ -19253,7 +20434,8 @@ func (s *ListPrivacyBudgetsInput) SetPrivacyBudgetType(v string) *ListPrivacyBud type ListPrivacyBudgetsOutput struct { _ struct{} `type:"structure"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` // An array that summarizes the privacy budgets. The summary includes collaboration @@ -19297,9 +20479,9 @@ func (s *ListPrivacyBudgetsOutput) SetPrivacyBudgetSummaries(v []*PrivacyBudgetS type ListProtectedQueriesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. Service chooses + // a default if it has not been set. Service can return a nextToken even if + // the maximum results has not been met. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The identifier for the membership in the collaboration. @@ -19307,7 +20489,8 @@ type ListProtectedQueriesInput struct { // MembershipIdentifier is a required field MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // A filter on the status of the protected query. @@ -19378,7 +20561,8 @@ func (s *ListProtectedQueriesInput) SetStatus(v string) *ListProtectedQueriesInp type ListProtectedQueriesOutput struct { _ struct{} `type:"structure"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` // A list of protected queries. @@ -19426,15 +20610,15 @@ type ListSchemasInput struct { // CollaborationIdentifier is a required field CollaborationIdentifier *string `location:"uri" locationName:"collaborationIdentifier" min:"36" type:"string" required:"true"` - // The maximum number of results that are returned for an API request call. - // The service chooses a default number if you don't set one. The service might - // return a `nextToken` even if the `maxResults` value has not been met. + // The maximum size of the results that is returned per call. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` - // If present, filter schemas by schema type. + // If present, filter schemas by schema type. The only valid schema type is + // currently `TABLE`. SchemaType *string `location:"querystring" locationName:"schemaType" type:"string" enum:"SchemaType"` } @@ -19502,7 +20686,8 @@ func (s *ListSchemasInput) SetSchemaType(v string) *ListSchemasInput { type ListSchemasOutput struct { _ struct{} `type:"structure"` - // The pagination token that's used to fetch the next set of results. + // The token value retrieved from a previous call to access the next page of + // results. NextToken *string `locationName:"nextToken" type:"string"` // The retrieved list of schemas. @@ -21514,11 +22699,64 @@ func (s *ProtectedQueryError) SetMessage(v string) *ProtectedQueryError { return s } +// Contains configuration details for the protected query member output. +type ProtectedQueryMemberOutputConfiguration struct { + _ struct{} `type:"structure"` + + // The unique identifier for the account. + // + // AccountId is a required field + AccountId *string `locationName:"accountId" min:"12" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProtectedQueryMemberOutputConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProtectedQueryMemberOutputConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ProtectedQueryMemberOutputConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ProtectedQueryMemberOutputConfiguration"} + if s.AccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AccountId")) + } + if s.AccountId != nil && len(*s.AccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AccountId", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccountId sets the AccountId field's value. +func (s *ProtectedQueryMemberOutputConfiguration) SetAccountId(v string) *ProtectedQueryMemberOutputConfiguration { + s.AccountId = &v + return s +} + // Contains configuration details for protected query output. type ProtectedQueryOutputConfiguration struct { _ struct{} `type:"structure"` - // Required configuration for a protected query with an `S3` output type. + // Required configuration for a protected query with a member output type. + Member *ProtectedQueryMemberOutputConfiguration `locationName:"member" type:"structure"` + + // Required configuration for a protected query with an s3 output type. S3 *ProtectedQueryS3OutputConfiguration `locationName:"s3" type:"structure"` } @@ -21543,6 +22781,11 @@ func (s ProtectedQueryOutputConfiguration) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ProtectedQueryOutputConfiguration) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ProtectedQueryOutputConfiguration"} + if s.Member != nil { + if err := s.Member.Validate(); err != nil { + invalidParams.AddNested("Member", err.(request.ErrInvalidParams)) + } + } if s.S3 != nil { if err := s.S3.Validate(); err != nil { invalidParams.AddNested("S3", err.(request.ErrInvalidParams)) @@ -21555,6 +22798,12 @@ func (s *ProtectedQueryOutputConfiguration) Validate() error { return nil } +// SetMember sets the Member field's value. +func (s *ProtectedQueryOutputConfiguration) SetMember(v *ProtectedQueryMemberOutputConfiguration) *ProtectedQueryOutputConfiguration { + s.Member = v + return s +} + // SetS3 sets the S3 field's value. func (s *ProtectedQueryOutputConfiguration) SetS3(v *ProtectedQueryS3OutputConfiguration) *ProtectedQueryOutputConfiguration { s.S3 = v @@ -21886,7 +23135,7 @@ func (s *ProtectedQuerySingleMemberOutput_) SetAccountId(v string) *ProtectedQue type ProtectedQueryStatistics struct { _ struct{} `type:"structure"` - // The duration of the Protected Query, from creation until query completion. + // The duration of the protected query, from creation until query completion. TotalDurationInMillis *int64 `locationName:"totalDurationInMillis" type:"long"` } @@ -21938,6 +23187,11 @@ type ProtectedQuerySummary struct { // MembershipId is a required field MembershipId *string `locationName:"membershipId" min:"36" type:"string" required:"true"` + // The receiver configuration. + // + // ReceiverConfigurations is a required field + ReceiverConfigurations []*ReceiverConfiguration `locationName:"receiverConfigurations" type:"list" required:"true"` + // The status of the protected query. Value values are `SUBMITTED`, `STARTED`, // `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`. // @@ -21987,6 +23241,12 @@ func (s *ProtectedQuerySummary) SetMembershipId(v string) *ProtectedQuerySummary return s } +// SetReceiverConfigurations sets the ReceiverConfigurations field's value. +func (s *ProtectedQuerySummary) SetReceiverConfigurations(v []*ReceiverConfiguration) *ProtectedQuerySummary { + s.ReceiverConfigurations = v + return s +} + // SetStatus sets the Status field's value. func (s *ProtectedQuerySummary) SetStatus(v string) *ProtectedQuerySummary { s.Status = &v @@ -22117,6 +23377,52 @@ func (s *QueryConstraintRequireOverlap) SetColumns(v []*string) *QueryConstraint return s } +// The receiver configuration for a protected query. +type ReceiverConfiguration struct { + _ struct{} `type:"structure"` + + // 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. + // + // AnalysisType is a required field + AnalysisType *string `locationName:"analysisType" type:"string" required:"true" enum:"AnalysisType"` + + // The configuration details of the receiver configuration. + ConfigurationDetails *ConfigurationDetails `locationName:"configurationDetails" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ReceiverConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ReceiverConfiguration) GoString() string { + return s.String() +} + +// SetAnalysisType sets the AnalysisType field's value. +func (s *ReceiverConfiguration) SetAnalysisType(v string) *ReceiverConfiguration { + s.AnalysisType = &v + return s +} + +// SetConfigurationDetails sets the ConfigurationDetails field's value. +func (s *ReceiverConfiguration) SetConfigurationDetails(v *ConfigurationDetails) *ReceiverConfiguration { + s.ConfigurationDetails = v + return s +} + // Request references a resource which does not exist. type ResourceNotFoundException struct { _ struct{} `type:"structure"` @@ -22198,14 +23504,13 @@ type Schema struct { // The analysis method for the schema. The only valid value is currently DIRECT_QUERY. AnalysisMethod *string `locationName:"analysisMethod" type:"string" enum:"AnalysisMethod"` - // The analysis rule types that are associated with the schema. Currently, only - // one entry is present. + // The analysis rule types associated with the schema. Currently, only one entry + // is present. // // AnalysisRuleTypes is a required field AnalysisRuleTypes []*string `locationName:"analysisRuleTypes" type:"list" required:"true" enum:"AnalysisRuleType"` - // The unique Amazon Resource Name (ARN) for the collaboration that the schema - // belongs to. + // The unique ARN for the collaboration that the schema belongs to. // // CollaborationArn is a required field CollaborationArn *string `locationName:"collaborationArn" type:"string" required:"true"` @@ -22215,12 +23520,12 @@ type Schema struct { // CollaborationId is a required field CollaborationId *string `locationName:"collaborationId" min:"36" type:"string" required:"true"` - // The columns for the relation that this schema represents. + // The columns for the relation this schema represents. // // Columns is a required field Columns []*Column `locationName:"columns" type:"list" required:"true"` - // The time at which the schema was created. + // The time the schema was created. // // CreateTime is a required field CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"` @@ -22254,12 +23559,12 @@ type Schema struct { // The schema type properties. SchemaTypeProperties *SchemaTypeProperties `locationName:"schemaTypeProperties" type:"structure"` - // The type of schema. + // The type of schema. The only valid value is currently `TABLE`. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"SchemaType"` - // The most recent time at which the schema was updated. + // The time the schema was last updated. // // UpdateTime is a required field UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" required:"true"` @@ -22441,13 +23746,21 @@ type SchemaStatusDetail struct { // The analysis rule type for which the schema status has been evaluated. AnalysisRuleType *string `locationName:"analysisRuleType" type:"string" enum:"AnalysisRuleType"` + // The type of analysis that can be performed on the schema. + // + // A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, + // or both. + // + // AnalysisType is a required field + AnalysisType *string `locationName:"analysisType" type:"string" required:"true" enum:"AnalysisType"` + // The configuration details of the schema analysis rule for the given type. Configurations []*string `locationName:"configurations" type:"list" enum:"SchemaConfiguration"` // The reasons why the schema status is set to its current state. Reasons []*SchemaStatusReason `locationName:"reasons" type:"list"` - // The status of the schema. + // The status of the schema, indicating if it is ready to query. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"SchemaStatus"` @@ -22477,6 +23790,12 @@ func (s *SchemaStatusDetail) SetAnalysisRuleType(v string) *SchemaStatusDetail { return s } +// SetAnalysisType sets the AnalysisType field's value. +func (s *SchemaStatusDetail) SetAnalysisType(v string) *SchemaStatusDetail { + s.AnalysisType = &v + return s +} + // SetConfigurations sets the Configurations field's value. func (s *SchemaStatusDetail) SetConfigurations(v []*string) *SchemaStatusDetail { s.Configurations = v @@ -22578,7 +23897,7 @@ type SchemaSummary struct { // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // The type of schema object. + // The type of schema object. The only valid schema type is currently `TABLE`. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"SchemaType"` @@ -23637,6 +24956,139 @@ func (s *UpdateConfiguredTableAnalysisRuleOutput) SetAnalysisRule(v *ConfiguredT return s } +type UpdateConfiguredTableAssociationAnalysisRuleInput struct { + _ struct{} `type:"structure"` + + // The updated analysis rule policy for the configured table association. + // + // AnalysisRulePolicy is a required field + AnalysisRulePolicy *ConfiguredTableAssociationAnalysisRulePolicy `locationName:"analysisRulePolicy" type:"structure" required:"true"` + + // The analysis rule type that you want to update. + // + // AnalysisRuleType is a required field + AnalysisRuleType *string `location:"uri" locationName:"analysisRuleType" type:"string" required:"true" enum:"ConfiguredTableAssociationAnalysisRuleType"` + + // The identifier for the configured table association to update. + // + // ConfiguredTableAssociationIdentifier is a required field + ConfiguredTableAssociationIdentifier *string `location:"uri" locationName:"configuredTableAssociationIdentifier" min:"36" type:"string" required:"true"` + + // A unique identifier for the membership that the configured table association + // belongs to. Currently accepts the membership ID. + // + // MembershipIdentifier is a required field + MembershipIdentifier *string `location:"uri" locationName:"membershipIdentifier" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConfiguredTableAssociationAnalysisRuleInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConfiguredTableAssociationAnalysisRuleInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateConfiguredTableAssociationAnalysisRuleInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateConfiguredTableAssociationAnalysisRuleInput"} + if s.AnalysisRulePolicy == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisRulePolicy")) + } + if s.AnalysisRuleType == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisRuleType")) + } + if s.AnalysisRuleType != nil && len(*s.AnalysisRuleType) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisRuleType", 1)) + } + if s.ConfiguredTableAssociationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ConfiguredTableAssociationIdentifier")) + } + if s.ConfiguredTableAssociationIdentifier != nil && len(*s.ConfiguredTableAssociationIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ConfiguredTableAssociationIdentifier", 36)) + } + if s.MembershipIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("MembershipIdentifier")) + } + if s.MembershipIdentifier != nil && len(*s.MembershipIdentifier) < 36 { + invalidParams.Add(request.NewErrParamMinLen("MembershipIdentifier", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnalysisRulePolicy sets the AnalysisRulePolicy field's value. +func (s *UpdateConfiguredTableAssociationAnalysisRuleInput) SetAnalysisRulePolicy(v *ConfiguredTableAssociationAnalysisRulePolicy) *UpdateConfiguredTableAssociationAnalysisRuleInput { + s.AnalysisRulePolicy = v + return s +} + +// SetAnalysisRuleType sets the AnalysisRuleType field's value. +func (s *UpdateConfiguredTableAssociationAnalysisRuleInput) SetAnalysisRuleType(v string) *UpdateConfiguredTableAssociationAnalysisRuleInput { + s.AnalysisRuleType = &v + return s +} + +// SetConfiguredTableAssociationIdentifier sets the ConfiguredTableAssociationIdentifier field's value. +func (s *UpdateConfiguredTableAssociationAnalysisRuleInput) SetConfiguredTableAssociationIdentifier(v string) *UpdateConfiguredTableAssociationAnalysisRuleInput { + s.ConfiguredTableAssociationIdentifier = &v + return s +} + +// SetMembershipIdentifier sets the MembershipIdentifier field's value. +func (s *UpdateConfiguredTableAssociationAnalysisRuleInput) SetMembershipIdentifier(v string) *UpdateConfiguredTableAssociationAnalysisRuleInput { + s.MembershipIdentifier = &v + return s +} + +type UpdateConfiguredTableAssociationAnalysisRuleOutput struct { + _ struct{} `type:"structure"` + + // The updated analysis rule for the configured table association. In the console, + // the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration + // analysis rule. + // + // AnalysisRule is a required field + AnalysisRule *ConfiguredTableAssociationAnalysisRule `locationName:"analysisRule" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConfiguredTableAssociationAnalysisRuleOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConfiguredTableAssociationAnalysisRuleOutput) GoString() string { + return s.String() +} + +// SetAnalysisRule sets the AnalysisRule field's value. +func (s *UpdateConfiguredTableAssociationAnalysisRuleOutput) SetAnalysisRule(v *ConfiguredTableAssociationAnalysisRule) *UpdateConfiguredTableAssociationAnalysisRuleOutput { + s.AnalysisRule = v + return s +} + type UpdateConfiguredTableAssociationInput struct { _ struct{} `type:"structure"` @@ -24462,6 +25914,26 @@ func AccessDeniedExceptionReason_Values() []string { } } +const ( + // AdditionalAnalysesAllowed is a AdditionalAnalyses enum value + AdditionalAnalysesAllowed = "ALLOWED" + + // AdditionalAnalysesRequired is a AdditionalAnalyses enum value + AdditionalAnalysesRequired = "REQUIRED" + + // AdditionalAnalysesNotAllowed is a AdditionalAnalyses enum value + AdditionalAnalysesNotAllowed = "NOT_ALLOWED" +) + +// AdditionalAnalyses_Values returns all elements of the AdditionalAnalyses enum +func AdditionalAnalyses_Values() []string { + return []string{ + AdditionalAnalysesAllowed, + AdditionalAnalysesRequired, + AdditionalAnalysesNotAllowed, + } +} + const ( // AggregateFunctionNameSum is a AggregateFunctionName enum value AggregateFunctionNameSum = "SUM" @@ -24582,6 +26054,22 @@ func AnalysisTemplateValidationType_Values() []string { } } +const ( + // AnalysisTypeDirectAnalysis is a AnalysisType enum value + AnalysisTypeDirectAnalysis = "DIRECT_ANALYSIS" + + // AnalysisTypeAdditionalAnalysis is a AnalysisType enum value + AnalysisTypeAdditionalAnalysis = "ADDITIONAL_ANALYSIS" +) + +// AnalysisType_Values returns all elements of the AnalysisType enum +func AnalysisType_Values() []string { + return []string{ + AnalysisTypeDirectAnalysis, + AnalysisTypeAdditionalAnalysis, + } +} + const ( // CollaborationQueryLogStatusEnabled is a CollaborationQueryLogStatus enum value CollaborationQueryLogStatusEnabled = "ENABLED" @@ -24618,6 +26106,26 @@ func ConfiguredTableAnalysisRuleType_Values() []string { } } +const ( + // ConfiguredTableAssociationAnalysisRuleTypeAggregation is a ConfiguredTableAssociationAnalysisRuleType enum value + ConfiguredTableAssociationAnalysisRuleTypeAggregation = "AGGREGATION" + + // ConfiguredTableAssociationAnalysisRuleTypeList is a ConfiguredTableAssociationAnalysisRuleType enum value + ConfiguredTableAssociationAnalysisRuleTypeList = "LIST" + + // ConfiguredTableAssociationAnalysisRuleTypeCustom is a ConfiguredTableAssociationAnalysisRuleType enum value + ConfiguredTableAssociationAnalysisRuleTypeCustom = "CUSTOM" +) + +// ConfiguredTableAssociationAnalysisRuleType_Values returns all elements of the ConfiguredTableAssociationAnalysisRuleType enum +func ConfiguredTableAssociationAnalysisRuleType_Values() []string { + return []string{ + ConfiguredTableAssociationAnalysisRuleTypeAggregation, + ConfiguredTableAssociationAnalysisRuleTypeList, + ConfiguredTableAssociationAnalysisRuleTypeCustom, + } +} + const ( // ConflictExceptionReasonAlreadyExists is a ConflictExceptionReason enum value ConflictExceptionReasonAlreadyExists = "ALREADY_EXISTS" @@ -25093,28 +26601,12 @@ func ScalarFunctions_Values() []string { const ( // SchemaConfigurationDifferentialPrivacy is a SchemaConfiguration enum value SchemaConfigurationDifferentialPrivacy = "DIFFERENTIAL_PRIVACY" - - // SchemaConfigurationCustomAnalysisNotAllowed is a SchemaConfiguration enum value - SchemaConfigurationCustomAnalysisNotAllowed = "CUSTOM_ANALYSIS_NOT_ALLOWED" - - // SchemaConfigurationNoMemberAccountAllowedToProvideAnalysis is a SchemaConfiguration enum value - SchemaConfigurationNoMemberAccountAllowedToProvideAnalysis = "NO_MEMBER_ACCOUNT_ALLOWED_TO_PROVIDE_ANALYSIS" - - // SchemaConfigurationDifferentialPrivacyBudgetNotConfigured is a SchemaConfiguration enum value - SchemaConfigurationDifferentialPrivacyBudgetNotConfigured = "DIFFERENTIAL_PRIVACY_BUDGET_NOT_CONFIGURED" - - // SchemaConfigurationIdMappingTableNotPopulated is a SchemaConfiguration enum value - SchemaConfigurationIdMappingTableNotPopulated = "ID_MAPPING_TABLE_NOT_POPULATED" ) // SchemaConfiguration_Values returns all elements of the SchemaConfiguration enum func SchemaConfiguration_Values() []string { return []string{ SchemaConfigurationDifferentialPrivacy, - SchemaConfigurationCustomAnalysisNotAllowed, - SchemaConfigurationNoMemberAccountAllowedToProvideAnalysis, - SchemaConfigurationDifferentialPrivacyBudgetNotConfigured, - SchemaConfigurationIdMappingTableNotPopulated, } } @@ -25149,6 +26641,24 @@ const ( // SchemaStatusReasonCodeIdMappingTableNotPopulated is a SchemaStatusReasonCode enum value SchemaStatusReasonCodeIdMappingTableNotPopulated = "ID_MAPPING_TABLE_NOT_POPULATED" + + // SchemaStatusReasonCodeCollaborationAnalysisRuleNotConfigured is a SchemaStatusReasonCode enum value + SchemaStatusReasonCodeCollaborationAnalysisRuleNotConfigured = "COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED" + + // SchemaStatusReasonCodeAdditionalAnalysesNotConfigured is a SchemaStatusReasonCode enum value + SchemaStatusReasonCodeAdditionalAnalysesNotConfigured = "ADDITIONAL_ANALYSES_NOT_CONFIGURED" + + // SchemaStatusReasonCodeResultReceiversNotConfigured is a SchemaStatusReasonCode enum value + SchemaStatusReasonCodeResultReceiversNotConfigured = "RESULT_RECEIVERS_NOT_CONFIGURED" + + // SchemaStatusReasonCodeAdditionalAnalysesNotAllowed is a SchemaStatusReasonCode enum value + SchemaStatusReasonCodeAdditionalAnalysesNotAllowed = "ADDITIONAL_ANALYSES_NOT_ALLOWED" + + // SchemaStatusReasonCodeResultReceiversNotAllowed is a SchemaStatusReasonCode enum value + SchemaStatusReasonCodeResultReceiversNotAllowed = "RESULT_RECEIVERS_NOT_ALLOWED" + + // SchemaStatusReasonCodeAnalysisRuleTypesNotCompatible is a SchemaStatusReasonCode enum value + SchemaStatusReasonCodeAnalysisRuleTypesNotCompatible = "ANALYSIS_RULE_TYPES_NOT_COMPATIBLE" ) // SchemaStatusReasonCode_Values returns all elements of the SchemaStatusReasonCode enum @@ -25159,6 +26669,12 @@ func SchemaStatusReasonCode_Values() []string { SchemaStatusReasonCodeAnalysisProvidersNotConfigured, SchemaStatusReasonCodeDifferentialPrivacyPolicyNotConfigured, SchemaStatusReasonCodeIdMappingTableNotPopulated, + SchemaStatusReasonCodeCollaborationAnalysisRuleNotConfigured, + SchemaStatusReasonCodeAdditionalAnalysesNotConfigured, + SchemaStatusReasonCodeResultReceiversNotConfigured, + SchemaStatusReasonCodeAdditionalAnalysesNotAllowed, + SchemaStatusReasonCodeResultReceiversNotAllowed, + SchemaStatusReasonCodeAnalysisRuleTypesNotCompatible, } } diff --git a/service/cleanrooms/cleanroomsiface/interface.go b/service/cleanrooms/cleanroomsiface/interface.go index 6b0bf4f0498..cf694aa577f 100644 --- a/service/cleanrooms/cleanroomsiface/interface.go +++ b/service/cleanrooms/cleanroomsiface/interface.go @@ -96,6 +96,10 @@ type CleanRoomsAPI interface { CreateConfiguredTableAssociationWithContext(aws.Context, *cleanrooms.CreateConfiguredTableAssociationInput, ...request.Option) (*cleanrooms.CreateConfiguredTableAssociationOutput, error) CreateConfiguredTableAssociationRequest(*cleanrooms.CreateConfiguredTableAssociationInput) (*request.Request, *cleanrooms.CreateConfiguredTableAssociationOutput) + CreateConfiguredTableAssociationAnalysisRule(*cleanrooms.CreateConfiguredTableAssociationAnalysisRuleInput) (*cleanrooms.CreateConfiguredTableAssociationAnalysisRuleOutput, error) + CreateConfiguredTableAssociationAnalysisRuleWithContext(aws.Context, *cleanrooms.CreateConfiguredTableAssociationAnalysisRuleInput, ...request.Option) (*cleanrooms.CreateConfiguredTableAssociationAnalysisRuleOutput, error) + CreateConfiguredTableAssociationAnalysisRuleRequest(*cleanrooms.CreateConfiguredTableAssociationAnalysisRuleInput) (*request.Request, *cleanrooms.CreateConfiguredTableAssociationAnalysisRuleOutput) + CreateIdMappingTable(*cleanrooms.CreateIdMappingTableInput) (*cleanrooms.CreateIdMappingTableOutput, error) CreateIdMappingTableWithContext(aws.Context, *cleanrooms.CreateIdMappingTableInput, ...request.Option) (*cleanrooms.CreateIdMappingTableOutput, error) CreateIdMappingTableRequest(*cleanrooms.CreateIdMappingTableInput) (*request.Request, *cleanrooms.CreateIdMappingTableOutput) @@ -132,6 +136,10 @@ type CleanRoomsAPI interface { DeleteConfiguredTableAssociationWithContext(aws.Context, *cleanrooms.DeleteConfiguredTableAssociationInput, ...request.Option) (*cleanrooms.DeleteConfiguredTableAssociationOutput, error) DeleteConfiguredTableAssociationRequest(*cleanrooms.DeleteConfiguredTableAssociationInput) (*request.Request, *cleanrooms.DeleteConfiguredTableAssociationOutput) + DeleteConfiguredTableAssociationAnalysisRule(*cleanrooms.DeleteConfiguredTableAssociationAnalysisRuleInput) (*cleanrooms.DeleteConfiguredTableAssociationAnalysisRuleOutput, error) + DeleteConfiguredTableAssociationAnalysisRuleWithContext(aws.Context, *cleanrooms.DeleteConfiguredTableAssociationAnalysisRuleInput, ...request.Option) (*cleanrooms.DeleteConfiguredTableAssociationAnalysisRuleOutput, error) + DeleteConfiguredTableAssociationAnalysisRuleRequest(*cleanrooms.DeleteConfiguredTableAssociationAnalysisRuleInput) (*request.Request, *cleanrooms.DeleteConfiguredTableAssociationAnalysisRuleOutput) + DeleteIdMappingTable(*cleanrooms.DeleteIdMappingTableInput) (*cleanrooms.DeleteIdMappingTableOutput, error) DeleteIdMappingTableWithContext(aws.Context, *cleanrooms.DeleteIdMappingTableInput, ...request.Option) (*cleanrooms.DeleteIdMappingTableOutput, error) DeleteIdMappingTableRequest(*cleanrooms.DeleteIdMappingTableInput) (*request.Request, *cleanrooms.DeleteIdMappingTableOutput) @@ -188,6 +196,10 @@ type CleanRoomsAPI interface { GetConfiguredTableAssociationWithContext(aws.Context, *cleanrooms.GetConfiguredTableAssociationInput, ...request.Option) (*cleanrooms.GetConfiguredTableAssociationOutput, error) GetConfiguredTableAssociationRequest(*cleanrooms.GetConfiguredTableAssociationInput) (*request.Request, *cleanrooms.GetConfiguredTableAssociationOutput) + GetConfiguredTableAssociationAnalysisRule(*cleanrooms.GetConfiguredTableAssociationAnalysisRuleInput) (*cleanrooms.GetConfiguredTableAssociationAnalysisRuleOutput, error) + GetConfiguredTableAssociationAnalysisRuleWithContext(aws.Context, *cleanrooms.GetConfiguredTableAssociationAnalysisRuleInput, ...request.Option) (*cleanrooms.GetConfiguredTableAssociationAnalysisRuleOutput, error) + GetConfiguredTableAssociationAnalysisRuleRequest(*cleanrooms.GetConfiguredTableAssociationAnalysisRuleInput) (*request.Request, *cleanrooms.GetConfiguredTableAssociationAnalysisRuleOutput) + GetIdMappingTable(*cleanrooms.GetIdMappingTableInput) (*cleanrooms.GetIdMappingTableOutput, error) GetIdMappingTableWithContext(aws.Context, *cleanrooms.GetIdMappingTableInput, ...request.Option) (*cleanrooms.GetIdMappingTableOutput, error) GetIdMappingTableRequest(*cleanrooms.GetIdMappingTableInput) (*request.Request, *cleanrooms.GetIdMappingTableOutput) @@ -386,6 +398,10 @@ type CleanRoomsAPI interface { UpdateConfiguredTableAssociationWithContext(aws.Context, *cleanrooms.UpdateConfiguredTableAssociationInput, ...request.Option) (*cleanrooms.UpdateConfiguredTableAssociationOutput, error) UpdateConfiguredTableAssociationRequest(*cleanrooms.UpdateConfiguredTableAssociationInput) (*request.Request, *cleanrooms.UpdateConfiguredTableAssociationOutput) + UpdateConfiguredTableAssociationAnalysisRule(*cleanrooms.UpdateConfiguredTableAssociationAnalysisRuleInput) (*cleanrooms.UpdateConfiguredTableAssociationAnalysisRuleOutput, error) + UpdateConfiguredTableAssociationAnalysisRuleWithContext(aws.Context, *cleanrooms.UpdateConfiguredTableAssociationAnalysisRuleInput, ...request.Option) (*cleanrooms.UpdateConfiguredTableAssociationAnalysisRuleOutput, error) + UpdateConfiguredTableAssociationAnalysisRuleRequest(*cleanrooms.UpdateConfiguredTableAssociationAnalysisRuleInput) (*request.Request, *cleanrooms.UpdateConfiguredTableAssociationAnalysisRuleOutput) + UpdateIdMappingTable(*cleanrooms.UpdateIdMappingTableInput) (*cleanrooms.UpdateIdMappingTableOutput, error) UpdateIdMappingTableWithContext(aws.Context, *cleanrooms.UpdateIdMappingTableInput, ...request.Option) (*cleanrooms.UpdateIdMappingTableOutput, error) UpdateIdMappingTableRequest(*cleanrooms.UpdateIdMappingTableInput) (*request.Request, *cleanrooms.UpdateIdMappingTableOutput) diff --git a/service/dynamodb/api.go b/service/dynamodb/api.go index 7286d567680..5cae6505d7c 100644 --- a/service/dynamodb/api.go +++ b/service/dynamodb/api.go @@ -62,7 +62,8 @@ func (c *DynamoDB) BatchExecuteStatementRequest(input *BatchExecuteStatementInpu // This operation allows you to perform batch reads or writes on data stored // in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement // must specify an equality condition on all key attributes. This enforces that -// each SELECT statement in a batch returns at most a single item. +// each SELECT statement in a batch returns at most a single item. For more +// information, see Running batch operations with PartiQL for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ql-reference.multiplestatements.batching.html). // // The entire batch must consist of either read statements or write statements, // you cannot mix both in one batch. @@ -429,8 +430,12 @@ func (c *DynamoDB) BatchWriteItemRequest(input *BatchWriteItemInput) (req *reque // check for unprocessed items and submit a new BatchWriteItem request with // those unprocessed items until all items have been processed. // -// If none of the items can be processed due to insufficient provisioned throughput -// on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. +// For tables and indexes with provisioned capacity, if none of the items can +// be processed due to insufficient provisioned throughput on all of the tables +// in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. +// For all tables and indexes, if none of the items can be processed due to +// other throttling scenarios (such as exceeding partition level limits), then +// BatchWriteItem returns a ThrottlingException. // // If DynamoDB returns any unprocessed items, you should retry the batch operation // on those items. However, we strongly recommend that you use an exponential @@ -1564,7 +1569,7 @@ func (c *DynamoDB) DeleteTableRequest(input *DeleteTableInput) (req *request.Req // // DynamoDB might continue to accept data read and write operations, such as // GetItem and PutItem, on a table in the DELETING state until the table deletion -// is complete. +// is complete. For the full list of table states, see TableStatus (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TableDescription.html#DDB-Type-TableDescription-TableStatus). // // When you delete a table, any indexes on that table are also deleted. // @@ -21427,7 +21432,7 @@ type QueryOutput struct { // The number of items evaluated, before any QueryFilter is applied. A high // ScannedCount value with few, or no, Count results indicates an inefficient - // Query operation. For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) + // Query operation. For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Count) // in the Amazon DynamoDB Developer Guide. // // If you did not use a filter in the request, then ScannedCount is the same diff --git a/service/iotsitewise/api.go b/service/iotsitewise/api.go index a066f9ce76b..819e0f8e350 100644 --- a/service/iotsitewise/api.go +++ b/service/iotsitewise/api.go @@ -2629,6 +2629,10 @@ func (c *IoTSiteWise) DeleteGatewayRequest(input *DeleteGatewayInput) (req *requ // - ResourceNotFoundException // The requested resource can't be found. // +// - ConflictingOperationException +// Your request has conflicting operations. This can occur if you're trying +// to perform more than one operation on the same resource at the same time. +// // - InternalFailureException // IoT SiteWise can't process your request right now. Try again later. // @@ -9252,15 +9256,18 @@ func (c *IoTSiteWise) UpdateAssetModelRequest(input *UpdateAssetModelInput) (req // models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) // in the IoT SiteWise User Guide. // -// This operation overwrites the existing model with the provided model. To -// avoid deleting your asset model's properties or hierarchies, you must include -// their IDs and definitions in the updated asset model payload. For more information, -// see DescribeAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html). -// // If you remove a property from an asset model, IoT SiteWise deletes all previous -// data for that property. If you remove a hierarchy definition from an asset -// model, IoT SiteWise disassociates every asset associated with that hierarchy. -// You can't change the type or data type of an existing property. +// data for that property. You can’t change the type or data type of an existing +// property. +// +// To replace an existing asset model property with a new one with the same +// name, do the following: +// +// Submit an UpdateAssetModel request with the entire existing property removed. +// +// Submit a second UpdateAssetModel request that includes the new property. +// The new asset property will have the same name as the previous one and IoT +// SiteWise will generate a new unique id. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11263,7 +11270,7 @@ func (s *AssetModelCompositeModelPathSegment) SetName(v string) *AssetModelCompo type AssetModelCompositeModelSummary struct { _ struct{} `type:"structure"` - // The description of the the composite model that this summary describes.. + // The description of the composite model that this summary describes.. Description *string `locationName:"description" min:"1" type:"string"` // The external ID of a composite model on this asset model. For more information, @@ -11271,12 +11278,12 @@ type AssetModelCompositeModelSummary struct { // in the IoT SiteWise User Guide. ExternalId *string `locationName:"externalId" min:"2" type:"string"` - // The ID of the the composite model that this summary describes.. + // The ID of the composite model that this summary describes.. // // Id is a required field Id *string `locationName:"id" min:"36" type:"string" required:"true"` - // The name of the the composite model that this summary describes.. + // The name of the composite model that this summary describes.. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` @@ -11284,14 +11291,7 @@ type AssetModelCompositeModelSummary struct { // The path that includes all the pieces that make up the composite model. Path []*AssetModelCompositeModelPathSegment `locationName:"path" type:"list"` - // The type of asset model. - // - // * ASSET_MODEL – (default) An asset model that you can use to create - // assets. Can't be included as a component in another asset model. - // - // * COMPONENT_MODEL – A reusable component that you can include in the - // composite models of other asset models. You can't create assets directly - // from this type of asset model. + // The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY. // // Type is a required field Type *string `locationName:"type" min:"1" type:"string" required:"true"` @@ -15904,13 +15904,14 @@ type CreateAssetModelCompositeModelInput struct { // specify your own ID, it must be globally unique. AssetModelCompositeModelId *string `locationName:"assetModelCompositeModelId" min:"36" type:"string"` - // A unique, friendly name for the composite model. + // A unique name for the composite model. // // AssetModelCompositeModelName is a required field AssetModelCompositeModelName *string `locationName:"assetModelCompositeModelName" min:"1" type:"string" required:"true"` // The property definitions of the composite model. For more information, see - // . + // Inline custom composite models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models) + // in the IoT SiteWise User Guide. // // You can specify up to 200 properties per composite model. For more information, // see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) @@ -15932,7 +15933,7 @@ type CreateAssetModelCompositeModelInput struct { // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` - // The ID of a composite model on this asset. + // The ID of a component model which is reused to create this composite model. ComposedAssetModelId *string `locationName:"composedAssetModelId" min:"13" type:"string"` // The ID of the parent composite model in this asset model relationship. @@ -16142,7 +16143,8 @@ type CreateAssetModelInput struct { // // When creating custom composite models, you need to use CreateAssetModelCompositeModel // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html). - // For more information, see . + // For more information, see Creating custom composite models (Components) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html) + // in the IoT SiteWise User Guide. AssetModelCompositeModels []*AssetModelCompositeModelDefinition `locationName:"assetModelCompositeModels" type:"list"` // A description for the asset model. @@ -16170,7 +16172,7 @@ type CreateAssetModelInput struct { // format. If you specify your own ID, it must be globally unique. AssetModelId *string `locationName:"assetModelId" min:"36" type:"string"` - // A unique, friendly name for the asset model. + // A unique name for the asset model. // // AssetModelName is a required field AssetModelName *string `locationName:"assetModelName" min:"1" type:"string" required:"true"` @@ -16862,7 +16864,7 @@ func (s *CreateDashboardOutput) SetDashboardId(v string) *CreateDashboardOutput type CreateGatewayInput struct { _ struct{} `type:"structure"` - // A unique, friendly name for the gateway. + // A unique name for the gateway. // // GatewayName is a required field GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"` @@ -22380,6 +22382,9 @@ type GatewayPlatform struct { // A gateway that runs on IoT Greengrass V2. GreengrassV2 *GreengrassV2 `locationName:"greengrassV2" type:"structure"` + + // A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device. + SiemensIE *SiemensIE `locationName:"siemensIE" type:"structure"` } // String returns the string representation. @@ -22413,6 +22418,11 @@ func (s *GatewayPlatform) Validate() error { invalidParams.AddNested("GreengrassV2", err.(request.ErrInvalidParams)) } } + if s.SiemensIE != nil { + if err := s.SiemensIE.Validate(); err != nil { + invalidParams.AddNested("SiemensIE", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -22432,6 +22442,12 @@ func (s *GatewayPlatform) SetGreengrassV2(v *GreengrassV2) *GatewayPlatform { return s } +// SetSiemensIE sets the SiemensIE field's value. +func (s *GatewayPlatform) SetSiemensIE(v *SiemensIE) *GatewayPlatform { + s.SiemensIE = v + return s +} + // Contains a summary of a gateway. type GatewaySummary struct { _ struct{} `type:"structure"` @@ -22452,7 +22468,7 @@ type GatewaySummary struct { // GatewayId is a required field GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"` - // The name of the asset. + // The name of the gateway. // // GatewayName is a required field GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"` @@ -23346,9 +23362,9 @@ type Greengrass struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the Greengrass group. For more information about how to find a group's - // ARN, see ListGroups (https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html) - // and GetGroup (https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html) - // in the IoT Greengrass API Reference. + // ARN, see ListGroups (https://docs.aws.amazon.com/greengrass/v1/apireference/listgroups-get.html) + // and GetGroup (https://docs.aws.amazon.com/greengrass/v1/apireference/getgroup-get.html) + // in the IoT Greengrass V1 API Reference. // // GroupArn is a required field GroupArn *string `locationName:"groupArn" min:"1" type:"string" required:"true"` @@ -28536,6 +28552,57 @@ func (s *ServiceUnavailableException) RequestID() string { return s.RespMetadata.RequestID } +// Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial +// Edge Device. +type SiemensIE struct { + _ struct{} `type:"structure"` + + // The name of the IoT Thing for your SiteWise Edge gateway. + // + // IotCoreThingName is a required field + IotCoreThingName *string `locationName:"iotCoreThingName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SiemensIE) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SiemensIE) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SiemensIE) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SiemensIE"} + if s.IotCoreThingName == nil { + invalidParams.Add(request.NewErrParamRequired("IotCoreThingName")) + } + if s.IotCoreThingName != nil && len(*s.IotCoreThingName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IotCoreThingName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIotCoreThingName sets the IotCoreThingName field's value. +func (s *SiemensIE) SetIotCoreThingName(v string) *SiemensIE { + s.IotCoreThingName = &v + return s +} + type TagResourceInput struct { _ struct{} `type:"structure"` @@ -29691,13 +29758,14 @@ type UpdateAssetModelCompositeModelInput struct { // AssetModelCompositeModelId is a required field AssetModelCompositeModelId *string `location:"uri" locationName:"assetModelCompositeModelId" min:"13" type:"string" required:"true"` - // A unique, friendly name for the composite model. + // A unique name for the composite model. // // AssetModelCompositeModelName is a required field AssetModelCompositeModelName *string `locationName:"assetModelCompositeModelName" min:"1" type:"string" required:"true"` // The property definitions of the composite model. For more information, see - // . + // Inline custom composite models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models) + // in the IoT SiteWise User Guide. // // You can specify up to 200 properties per composite model. For more information, // see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) @@ -29879,7 +29947,8 @@ type UpdateAssetModelInput struct { // // When creating custom composite models, you need to use CreateAssetModelCompositeModel // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html). - // For more information, see . + // For more information, see Creating custom composite models (Components) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html) + // in the IoT SiteWise User Guide. AssetModelCompositeModels []*AssetModelCompositeModel `locationName:"assetModelCompositeModels" type:"list"` // A description for the asset model. @@ -29909,7 +29978,7 @@ type UpdateAssetModelInput struct { // AssetModelId is a required field AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"` - // A unique, friendly name for the asset model. + // A unique name for the asset model. // // AssetModelName is a required field AssetModelName *string `locationName:"assetModelName" min:"1" type:"string" required:"true"` @@ -30559,7 +30628,7 @@ type UpdateGatewayInput struct { // GatewayId is a required field GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"` - // A unique, friendly name for the gateway. + // A unique name for the gateway. // // GatewayName is a required field GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"` @@ -31180,8 +31249,7 @@ type Variant struct { // Asset property data of type double (floating point number). DoubleValue *float64 `locationName:"doubleValue" type:"double"` - // Asset property data of type integer (number that's greater than or equal - // to zero). + // Asset property data of type integer (whole number). IntegerValue *int64 `locationName:"integerValue" type:"integer"` // Asset property data of type string (sequence of characters). @@ -31565,6 +31633,9 @@ const ( // CapabilitySyncStatusUnknown is a CapabilitySyncStatus enum value CapabilitySyncStatusUnknown = "UNKNOWN" + + // CapabilitySyncStatusNotApplicable is a CapabilitySyncStatus enum value + CapabilitySyncStatusNotApplicable = "NOT_APPLICABLE" ) // CapabilitySyncStatus_Values returns all elements of the CapabilitySyncStatus enum @@ -31574,6 +31645,7 @@ func CapabilitySyncStatus_Values() []string { CapabilitySyncStatusOutOfSync, CapabilitySyncStatusSyncFailed, CapabilitySyncStatusUnknown, + CapabilitySyncStatusNotApplicable, } } diff --git a/service/mediapackagev2/api.go b/service/mediapackagev2/api.go index dd33142571b..f7ceafbae49 100644 --- a/service/mediapackagev2/api.go +++ b/service/mediapackagev2/api.go @@ -9257,6 +9257,9 @@ const ( // DrmSystemWidevine is a DrmSystem enum value DrmSystemWidevine = "WIDEVINE" + + // DrmSystemIrdeto is a DrmSystem enum value + DrmSystemIrdeto = "IRDETO" ) // DrmSystem_Values returns all elements of the DrmSystem enum @@ -9266,6 +9269,7 @@ func DrmSystem_Values() []string { DrmSystemFairplay, DrmSystemPlayready, DrmSystemWidevine, + DrmSystemIrdeto, } } diff --git a/service/medicalimaging/api.go b/service/medicalimaging/api.go index 47aed4216da..99ed3e80abb 100644 --- a/service/medicalimaging/api.go +++ b/service/medicalimaging/api.go @@ -2320,6 +2320,11 @@ type CopyImageSetInput struct { // DatastoreId is a required field DatastoreId *string `location:"uri" locationName:"datastoreId" type:"string" required:"true"` + // Setting this flag will force the CopyImageSet operation, even if Patient, + // Study, or Series level metadata are mismatched across the sourceImageSet + // and destinationImageSet. + Force *bool `location:"querystring" locationName:"force" type:"boolean"` + // The source image set identifier. // // SourceImageSetId is a required field @@ -2386,6 +2391,12 @@ func (s *CopyImageSetInput) SetDatastoreId(v string) *CopyImageSetInput { return s } +// SetForce sets the Force field's value. +func (s *CopyImageSetInput) SetForce(v bool) *CopyImageSetInput { + s.Force = &v + return s +} + // SetSourceImageSetId sets the SourceImageSetId field's value. func (s *CopyImageSetInput) SetSourceImageSetId(v string) *CopyImageSetInput { s.SourceImageSetId = &v @@ -2451,6 +2462,10 @@ func (s *CopyImageSetOutput) SetSourceImageSetProperties(v *CopySourceImageSetPr type CopySourceImageSetInformation struct { _ struct{} `type:"structure"` + // Contains MetadataCopies structure and wraps information related to specific + // copy use cases. For example, when copying subsets. + DICOMCopies *MetadataCopies `type:"structure"` + // The latest version identifier for the source image set. // // LatestVersionId is a required field @@ -2481,6 +2496,11 @@ func (s *CopySourceImageSetInformation) Validate() error { if s.LatestVersionId == nil { invalidParams.Add(request.NewErrParamRequired("LatestVersionId")) } + if s.DICOMCopies != nil { + if err := s.DICOMCopies.Validate(); err != nil { + invalidParams.AddNested("DICOMCopies", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -2488,6 +2508,12 @@ func (s *CopySourceImageSetInformation) Validate() error { return nil } +// SetDICOMCopies sets the DICOMCopies field's value. +func (s *CopySourceImageSetInformation) SetDICOMCopies(v *MetadataCopies) *CopySourceImageSetInformation { + s.DICOMCopies = v + return s +} + // SetLatestVersionId sets the LatestVersionId field's value. func (s *CopySourceImageSetInformation) SetLatestVersionId(v string) *CopySourceImageSetInformation { s.LatestVersionId = &v @@ -4243,6 +4269,11 @@ type GetImageSetOutput struct { // The error message thrown if an image set action fails. Message *string `locationName:"message" min:"1" type:"string"` + // This object contains the details of any overrides used while creating a specific + // image set version. If an image set was copied or updated using the force + // flag, this object will contain the forced flag. + Overrides *Overrides `locationName:"overrides" type:"structure"` + // The timestamp when image set properties were updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` @@ -4318,6 +4349,12 @@ func (s *GetImageSetOutput) SetMessage(v string) *GetImageSetOutput { return s } +// SetOverrides sets the Overrides field's value. +func (s *GetImageSetOutput) SetOverrides(v *Overrides) *GetImageSetOutput { + s.Overrides = v + return s +} + // SetUpdatedAt sets the UpdatedAt field's value. func (s *GetImageSetOutput) SetUpdatedAt(v time.Time) *GetImageSetOutput { s.UpdatedAt = &v @@ -4403,6 +4440,11 @@ type ImageSetProperties struct { // The error message thrown if an image set action fails. Message *string `locationName:"message" min:"1" type:"string"` + // Contains details on overrides used when creating the returned version of + // an image set. For example, if forced exists, the forced flag was used when + // creating the image set. + Overrides *Overrides `locationName:"overrides" type:"structure"` + // The timestamp when the image set properties were updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` @@ -4466,6 +4508,12 @@ func (s *ImageSetProperties) SetMessage(v string) *ImageSetProperties { return s } +// SetOverrides sets the Overrides field's value. +func (s *ImageSetProperties) SetOverrides(v *Overrides) *ImageSetProperties { + s.Overrides = v + return s +} + // SetUpdatedAt sets the UpdatedAt field's value. func (s *ImageSetProperties) SetUpdatedAt(v time.Time) *ImageSetProperties { s.UpdatedAt = &v @@ -5063,12 +5111,76 @@ func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForRe return s } +// Contains copiable Attributes structure and wraps information related to specific +// copy use cases. For example, when copying subsets. +type MetadataCopies struct { + _ struct{} `type:"structure"` + + // The JSON string used to specify a subset of SOP Instances to copy from source + // to destination image set. + // + // CopiableAttributes is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by MetadataCopies's + // String and GoString methods. + // + // CopiableAttributes is a required field + CopiableAttributes *string `locationName:"copiableAttributes" min:"1" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MetadataCopies) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MetadataCopies) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *MetadataCopies) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MetadataCopies"} + if s.CopiableAttributes == nil { + invalidParams.Add(request.NewErrParamRequired("CopiableAttributes")) + } + if s.CopiableAttributes != nil && len(*s.CopiableAttributes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CopiableAttributes", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCopiableAttributes sets the CopiableAttributes field's value. +func (s *MetadataCopies) SetCopiableAttributes(v string) *MetadataCopies { + s.CopiableAttributes = &v + return s +} + // Contains DICOMUpdates. type MetadataUpdates struct { _ struct{} `type:"structure"` // The object containing removableAttributes and updatableAttributes. DICOMUpdates *DICOMUpdates `type:"structure"` + + // Specifies the previous image set version ID to revert the current image set + // back to. + // + // You must provide either revertToVersionId or DICOMUpdates in your request. + // A ValidationException error is thrown if both parameters are provided at + // the same time. + RevertToVersionId *string `locationName:"revertToVersionId" type:"string"` } // String returns the string representation. @@ -5110,6 +5222,46 @@ func (s *MetadataUpdates) SetDICOMUpdates(v *DICOMUpdates) *MetadataUpdates { return s } +// SetRevertToVersionId sets the RevertToVersionId field's value. +func (s *MetadataUpdates) SetRevertToVersionId(v string) *MetadataUpdates { + s.RevertToVersionId = &v + return s +} + +// Specifies the overrides used in image set modification calls to CopyImageSet +// and UpdateImageSetMetadata. +type Overrides struct { + _ struct{} `type:"structure"` + + // Setting this flag will force the CopyImageSet and UpdateImageSetMetadata + // operations, even if Patient, Study, or Series level metadata are mismatched. + Forced *bool `locationName:"forced" type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Overrides) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Overrides) GoString() string { + return s.String() +} + +// SetForced sets the Forced field's value. +func (s *Overrides) SetForced(v bool) *Overrides { + s.Forced = &v + return s +} + // The request references a resource which does not exist. type ResourceNotFoundException struct { _ struct{} `type:"structure"` @@ -6165,6 +6317,15 @@ type UpdateImageSetMetadataInput struct { // DatastoreId is a required field DatastoreId *string `location:"uri" locationName:"datastoreId" type:"string" required:"true"` + // Setting this flag will force the UpdateImageSetMetadata operation for the + // following attributes: + // + // * Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and + // Tag.StudyID + // + // * Adding, removing, or updating private tags for an individual SOP Instance + Force *bool `location:"querystring" locationName:"force" type:"boolean"` + // The image set identifier. // // ImageSetId is a required field @@ -6238,6 +6399,12 @@ func (s *UpdateImageSetMetadataInput) SetDatastoreId(v string) *UpdateImageSetMe return s } +// SetForce sets the Force field's value. +func (s *UpdateImageSetMetadataInput) SetForce(v bool) *UpdateImageSetMetadataInput { + s.Force = &v + return s +} + // SetImageSetId sets the ImageSetId field's value. func (s *UpdateImageSetMetadataInput) SetImageSetId(v string) *UpdateImageSetMetadataInput { s.ImageSetId = &v diff --git a/service/pinpointsmsvoicev2/api.go b/service/pinpointsmsvoicev2/api.go index dbcdffdbf7e..5843938a6bb 100644 --- a/service/pinpointsmsvoicev2/api.go +++ b/service/pinpointsmsvoicev2/api.go @@ -379,14 +379,14 @@ func (c *PinpointSMSVoiceV2) CreateEventDestinationRequest(input *CreateEventDes // Creates a new event destination in a configuration set. // // An event destination is a location where you send message events. The event -// options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. -// For example, when a message is delivered successfully, you can send information -// about that event to an event destination, or send notifications to endpoints -// that are subscribed to an Amazon SNS topic. +// options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, +// when a message is delivered successfully, you can send information about +// that event to an event destination, or send notifications to endpoints that +// are subscribed to an Amazon SNS topic. // // Each configuration set can contain between 0 and 5 event destinations. Each // event destination can contain a reference to a single destination, such as -// a CloudWatch or Kinesis Data Firehose destination. +// a CloudWatch or Firehose destination. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -498,7 +498,7 @@ func (c *PinpointSMSVoiceV2) CreateOptOutListRequest(input *CreateOptOutListInpu // "STOP," an entry for the phone number is added to the opt-out list. In addition // to STOP, your recipients can use any supported opt-out keyword, such as CANCEL // or OPTOUT. For a list of supported opt-out keywords, see SMS opt out (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout) -// in the Amazon Pinpoint User Guide. +// in the AWS End User Messaging SMS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1815,8 +1815,8 @@ func (c *PinpointSMSVoiceV2) DeleteKeywordRequest(input *DeleteKeywordInput) (re // A keyword is a word that you can search for on a particular phone number // or pool. It is also a specific word or phrase that an end user can send to // your number to elicit a response, such as an informational message or a special -// offer. When your number receives a message that begins with a keyword, Amazon -// Pinpoint responds with a customizable message. +// offer. When your number receives a message that begins with a keyword, AWS +// End User Messaging SMS and Voice responds with a customizable message. // // Keywords "HELP" and "STOP" can't be deleted or modified. // @@ -2737,8 +2737,8 @@ func (c *PinpointSMSVoiceV2) DeleteTextMessageSpendLimitOverrideRequest(input *D // Deletes an account-level monthly spending limit override for sending text // messages. Deleting a spend limit override will set the EnforcedLimit to equal // the MaxLimit, which is controlled by Amazon Web Services. For more information -// on spend limits (quotas) see Amazon Pinpoint quotas (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) -// in the Amazon Pinpoint Developer Guide. +// on spend limits (quotas) see Quotas (https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html) +// in the AWS End User Messaging SMS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2932,8 +2932,8 @@ func (c *PinpointSMSVoiceV2) DeleteVoiceMessageSpendLimitOverrideRequest(input * // Deletes an account level monthly spend limit override for sending voice messages. // Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, // which is controlled by Amazon Web Services. For more information on spending -// limits (quotas) see Amazon Pinpoint quotas (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) -// in the Amazon Pinpoint Developer Guide. +// limits (quotas) see Quotas (https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html) +// in the AWS End User Messaging SMS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3036,9 +3036,9 @@ func (c *PinpointSMSVoiceV2) DescribeAccountAttributesRequest(input *DescribeAcc // account out of the sandbox, create an Amazon Web Services Support case for // a service limit increase request. // -// New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The -// sandbox protects both Amazon Web Services end recipients and SMS or voice -// recipients from fraud and abuse. +// New accounts are placed into an SMS or voice sandbox. The sandbox protects +// both Amazon Web Services end recipients and SMS or voice recipients from +// fraud and abuse. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3186,15 +3186,15 @@ func (c *PinpointSMSVoiceV2) DescribeAccountLimitsRequest(input *DescribeAccount // DescribeAccountLimits API operation for Amazon Pinpoint SMS Voice V2. // -// Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your -// account. The description for a quota includes the quota name, current usage -// toward that quota, and the quota's maximum value. +// Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource +// quotas for your account. The description for a quota includes the quota name, +// current usage toward that quota, and the quota's maximum value. // // When you establish an Amazon Web Services account, the account has initial // quotas on the maximum number of configuration sets, opt-out lists, phone // numbers, and pools that you can create in a given Region. For more information -// see Amazon Pinpoint quotas (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) -// in the Amazon Pinpoint Developer Guide. +// see Quotas (https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html) +// in the AWS End User Messaging SMS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3507,8 +3507,8 @@ func (c *PinpointSMSVoiceV2) DescribeKeywordsRequest(input *DescribeKeywordsInpu // A keyword is a word that you can search for on a particular phone number // or pool. It is also a specific word or phrase that an end user can send to // your number to elicit a response, such as an informational message or a special -// offer. When your number receives a message that begins with a keyword, Amazon -// Pinpoint responds with a customizable message. +// offer. When your number receives a message that begins with a keyword, AWS +// End User Messaging SMS and Voice responds with a customizable message. // // If you specify a keyword that isn't valid, an error is returned. // @@ -5668,14 +5668,13 @@ func (c *PinpointSMSVoiceV2) DescribeSpendLimitsRequest(input *DescribeSpendLimi // DescribeSpendLimits API operation for Amazon Pinpoint SMS Voice V2. // -// Describes the current Amazon Pinpoint monthly spend limits for sending voice -// and text messages. +// Describes the current monthly spend limits for sending voice and text messages. // // When you establish an Amazon Web Services account, the account has initial // monthly spend limit in a given Region. For more information on increasing -// your monthly spend limit, see Requesting increases to your monthly SMS spending -// quota for Amazon Pinpoint (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html) -// in the Amazon Pinpoint User Guide. +// your monthly spend limit, see Requesting increases to your monthly SMS, MMS, +// or Voice spending quota (https://docs.aws.amazon.com/sms-voice/latest/userguide/awssupport-spend-threshold.html) +// in the AWS End User Messaging SMS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6771,8 +6770,8 @@ func (c *PinpointSMSVoiceV2) PutKeywordRequest(input *PutKeywordInput) (req *req // A keyword is a word that you can search for on a particular phone number // or pool. It is also a specific word or phrase that an end user can send to // your number to elicit a response, such as an informational message or a special -// offer. When your number receives a message that begins with a keyword, Amazon -// Pinpoint responds with a customizable message. +// offer. When your number receives a message that begins with a keyword, AWS +// End User Messaging SMS and Voice responds with a customizable message. // // If you specify a keyword that isn't valid, an error is returned. // @@ -7279,8 +7278,8 @@ func (c *PinpointSMSVoiceV2) RequestPhoneNumberRequest(input *RequestPhoneNumber // RequestPhoneNumber API operation for Amazon Pinpoint SMS Voice V2. // // Request an origination phone number for use in your account. For more information -// on phone number request see Requesting a number (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-request-number.html) -// in the Amazon Pinpoint User Guide. +// on phone number request see Request a phone number (https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-request.html) +// in the AWS End User Messaging SMS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7694,13 +7693,15 @@ func (c *PinpointSMSVoiceV2) SendTextMessageRequest(input *SendTextMessageInput) // SendTextMessage API operation for Amazon Pinpoint SMS Voice V2. // -// Creates a new text message and sends it to a recipient's phone number. +// Creates a new text message and sends it to a recipient's phone number. SendTextMessage +// only sends an SMS message to one recipient each time it is invoked. // // SMS throughput limits are measured in Message Parts per Second (MPS). Your // MPS limit depends on the destination country of your messages, as well as // the type of phone number (origination number) that you use to send the message. -// For more information, see Message Parts per Second (MPS) limits (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-limitations-mps.html) -// in the Amazon Pinpoint User Guide. +// For more information about MPS, see Message Parts per Second (MPS) limits +// (https://docs.aws.amazon.com/sms-voice/latest/userguide/sms-limitations-mps.html) +// in the AWS End User Messaging SMS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7803,9 +7804,9 @@ func (c *PinpointSMSVoiceV2) SendVoiceMessageRequest(input *SendVoiceMessageInpu // SendVoiceMessage API operation for Amazon Pinpoint SMS Voice V2. // -// Allows you to send a request that sends a voice message through Amazon Pinpoint. -// This operation uses Amazon Polly (http://aws.amazon.com/polly/) to convert -// a text script into a voice message. +// Allows you to send a request that sends a voice message. This operation uses +// Amazon Polly (http://aws.amazon.com/polly/) to convert a text script into +// a voice message. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8583,13 +8584,12 @@ func (c *PinpointSMSVoiceV2) TagResourceRequest(input *TagResourceInput) (req *r // TagResource API operation for Amazon Pinpoint SMS Voice V2. // -// Adds or overwrites only the specified tags for the specified Amazon Pinpoint -// SMS Voice, version 2 resource. When you specify an existing tag key, the -// value is overwritten with the new value. Each resource can have a maximum -// of 50 tags. Each tag consists of a key and an optional value. Tag keys must -// be unique per resource. For more information about tags, see Tagging Amazon -// Pinpoint resources (https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html) -// in the Amazon Pinpoint Developer Guide. +// Adds or overwrites only the specified tags for the specified resource. When +// you specify an existing tag key, the value is overwritten with the new value. +// Each resource can have a maximum of 50 tags. Each tag consists of a key and +// an optional value. Tag keys must be unique per resource. For more information +// about tags, see Tags (https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-tags.html) +// in the AWS End User Messaging SMS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8687,10 +8687,9 @@ func (c *PinpointSMSVoiceV2) UntagResourceRequest(input *UntagResourceInput) (re // UntagResource API operation for Amazon Pinpoint SMS Voice V2. // -// Removes the association of the specified tags from an Amazon Pinpoint SMS -// Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint -// resources (https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html) -// in the Amazon Pinpoint Developer Guide. +// Removes the association of the specified tags from a resource. For more information +// on tags see Tags (https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-tags.html) +// in the AWS End User Messaging SMS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8785,13 +8784,12 @@ func (c *PinpointSMSVoiceV2) UpdateEventDestinationRequest(input *UpdateEventDes // UpdateEventDestination API operation for Amazon Pinpoint SMS Voice V2. // // Updates an existing event destination in a configuration set. You can update -// the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also -// enable or disable the event destination. +// the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or +// disable the event destination. // // You may want to update an event destination to change its matching event // types or updating the destination resource ARN. You can't change an event -// destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon -// SNS. +// destination's type between CloudWatch Logs, Firehose, and Amazon SNS. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10390,11 +10388,11 @@ type CreateEventDestinationInput struct { EventDestinationName *string `min:"1" type:"string" required:"true"` // An object that contains information about an event destination for logging - // to Amazon Kinesis Data Firehose. + // to Amazon Data Firehose. KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"` // An array of event types that determine which events to log. If "ALL" is used, - // then Amazon Pinpoint logs every event type. + // then AWS End User Messaging SMS and Voice logs every event type. // // The TEXT_SENT event type is not supported. // @@ -10722,7 +10720,7 @@ type CreatePoolInput struct { // The type of message. Valid values are TRANSACTIONAL for messages that are // critical or time-sensitive and PROMOTIONAL for messages that aren't critical - // or time-sensitive. + // or time-sensitive. After the pool is created the MessageType can't be changed. // // MessageType is a required field MessageType *string `type:"string" required:"true" enum:"MessageType"` @@ -10732,6 +10730,9 @@ type CreatePoolInput struct { // for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used // to get the values for SenderId and SenderIdArn. // + // After the pool is created you can add more origination identities to the + // pool by using AssociateOriginationIdentity (https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_AssociateOriginationIdentity.html). + // // OriginationIdentity is a required field OriginationIdentity *string `min:"1" type:"string" required:"true"` @@ -10855,14 +10856,15 @@ type CreatePoolOutput struct { PoolId *string `type:"string"` // By default this is set to false. When an end recipient sends a message that - // begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint - // automatically replies with a customizable message and adds the end recipient - // to the OptOutList. When set to true you're responsible for responding to - // HELP and STOP requests. You're also responsible for tracking and honoring - // opt-out requests. + // begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging + // SMS and Voice automatically replies with a customizable message and adds + // the end recipient to the OptOutList. When set to true you're responsible + // for responding to HELP and STOP requests. You're also responsible for tracking + // and honoring opt-out requests. SelfManagedOptOutsEnabled *bool `type:"boolean"` - // Indicates whether shared routes are enabled for the pool. + // Indicates whether shared routes are enabled for the pool. Set to false and + // only origination identities in this pool are used to send messages. SharedRoutesEnabled *bool `type:"boolean"` // The current status of the pool. @@ -13043,11 +13045,11 @@ type DeletePoolOutput struct { PoolId *string `type:"string"` // By default this is set to false. When an end recipient sends a message that - // begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint - // automatically replies with a customizable message and adds the end recipient - // to the OptOutList. When set to true you're responsible for responding to - // HELP and STOP requests. You're also responsible for tracking and honoring - // opt-out requests. + // begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging + // SMS and Voice automatically replies with a customizable message and adds + // the end recipient to the OptOutList. When set to true you're responsible + // for responding to HELP and STOP requests. You're also responsible for tracking + // and honoring opt-out requests. SelfManagedOptOutsEnabled *bool `type:"boolean"` // Indicates whether shared routes are enabled for the pool. @@ -16984,8 +16986,7 @@ func (s *DiscardRegistrationVersionOutput) SetVersionNumber(v int64) *DiscardReg // Contains information about an event destination. // // Event destinations are associated with configuration sets, which enable you -// to publish message sending events to CloudWatch, Kinesis Data Firehose, or -// Amazon SNS. +// to publish message sending events to CloudWatch, Firehose, or Amazon SNS. type EventDestination struct { _ struct{} `type:"structure"` @@ -17004,7 +17005,7 @@ type EventDestination struct { EventDestinationName *string `min:"1" type:"string" required:"true"` // An object that contains information about an event destination for logging - // to Amazon Kinesis Data Firehose. + // to Amazon Data Firehose. KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"` // An array of event types that determine which events to log. @@ -17144,7 +17145,7 @@ type GetProtectConfigurationCountryRuleSetOutput struct { // the details for the requested NumberCapability. The Key is the two-letter // ISO country code. For a list of supported ISO country codes, see Supported // countries and regions (SMS channel) (https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html) - // in the Amazon Pinpoint SMS user guide. + // in the AWS End User Messaging SMS User Guide. // // CountryRuleSet is a required field CountryRuleSet map[string]*ProtectConfigurationCountryRuleSetInformation `min:"1" type:"map" required:"true"` @@ -17397,11 +17398,11 @@ func (s *KeywordInformation) SetKeywordMessage(v string) *KeywordInformation { } // Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the -// Identity and Access Management (IAM) role associated with a Kinesis Data -// Firehose event destination. +// Identity and Access Management (IAM) role associated with a Firehose event +// destination. // -// Event destinations, such as Kinesis Data Firehose, are associated with configuration -// sets, which enable you to publish message sending events. +// Event destinations, such as Firehose, are associated with configuration sets, +// which enable you to publish message sending events. type KinesisFirehoseDestination struct { _ struct{} `type:"structure"` @@ -17411,7 +17412,7 @@ type KinesisFirehoseDestination struct { DeliveryStreamArn *string `min:"20" type:"string" required:"true"` // The ARN of an Identity and Access Management role that is able to write event - // data to an Amazon Kinesis Data Firehose destination. + // data to an Amazon Data Firehose destination. // // IamRoleArn is a required field IamRoleArn *string `min:"20" type:"string" required:"true"` @@ -18272,11 +18273,11 @@ type PhoneNumberInformation struct { RegistrationId *string `type:"string"` // When set to false an end recipient sends a message that begins with HELP - // or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies - // with a customizable message and adds the end recipient to the OptOutList. - // When set to true you're responsible for responding to HELP and STOP requests. - // You're also responsible for tracking and honoring opt-out request. For more - // information see Self-managed opt-outs (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out) + // or STOP to one of your dedicated numbers, AWS End User Messaging SMS and + // Voice automatically replies with a customizable message and adds the end + // recipient to the OptOutList. When set to true you're responsible for responding + // to HELP and STOP requests. You're also responsible for tracking and honoring + // opt-out request. For more information see Self-managed opt-outs (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out) // // SelfManagedOptOutsEnabled is a required field SelfManagedOptOutsEnabled *bool `type:"boolean" required:"true"` @@ -18528,11 +18529,11 @@ type PoolInformation struct { PoolId *string `type:"string" required:"true"` // When set to false, an end recipient sends a message that begins with HELP - // or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies - // with a customizable message and adds the end recipient to the OptOutList. - // When set to true you're responsible for responding to HELP and STOP requests. - // You're also responsible for tracking and honoring opt-out requests. For more - // information see Self-managed opt-outs (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out) + // or STOP to one of your dedicated numbers, AWS End User Messaging SMS and + // Voice automatically replies with a customizable message and adds the end + // recipient to the OptOutList. When set to true you're responsible for responding + // to HELP and STOP requests. You're also responsible for tracking and honoring + // opt-out requests. For more information see Self-managed opt-outs (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out) // // SelfManagedOptOutsEnabled is a required field SelfManagedOptOutsEnabled *bool `type:"boolean" required:"true"` @@ -18541,9 +18542,9 @@ type PoolInformation struct { // // By default, this is set to False. If you set this value to True, your messages // are sent using phone numbers or sender IDs (depending on the country) that - // are shared with other Amazon Pinpoint users. In some countries, such as the - // United States, senders aren't allowed to use shared routes and must use a - // dedicated phone number or short code. + // are shared with other users. In some countries, such as the United States, + // senders aren't allowed to use shared routes and must use a dedicated phone + // number or short code. // // SharedRoutesEnabled is a required field SharedRoutesEnabled *bool `type:"boolean" required:"true"` @@ -20897,11 +20898,11 @@ type ReleasePhoneNumberOutput struct { RegistrationId *string `type:"string"` // By default this is set to false. When an end recipient sends a message that - // begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint - // automatically replies with a customizable message and adds the end recipient - // to the OptOutList. When set to true you're responsible for responding to - // HELP and STOP requests. You're also responsible for tracking and honoring - // opt-out requests. + // begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging + // SMS and Voice automatically replies with a customizable message and adds + // the end recipient to the OptOutList. When set to true you're responsible + // for responding to HELP and STOP requests. You're also responsible for tracking + // and honoring opt-out requests. SelfManagedOptOutsEnabled *bool `type:"boolean"` // The current status of the request. @@ -21428,11 +21429,11 @@ type RequestPhoneNumberOutput struct { RegistrationId *string `type:"string"` // By default this is set to false. When an end recipient sends a message that - // begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint - // automatically replies with a customizable message and adds the end recipient - // to the OptOutList. When set to true you're responsible for responding to - // HELP and STOP requests. You're also responsible for tracking and honoring - // opt-out requests. + // begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging + // SMS and Voice automatically replies with a customizable message and adds + // the end recipient to the OptOutList. When set to true you're responsible + // for responding to HELP and STOP requests. You're also responsible for tracking + // and honoring opt-out requests. SelfManagedOptOutsEnabled *bool `type:"boolean"` // The current status of the request. @@ -22363,6 +22364,15 @@ type SendTextMessageInput struct { // this setting is only used when you send messages to recipients in India using // a sender ID. For more information see Special requirements for sending SMS // messages to recipients in India (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html). + // + // * IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received + // after completing the sender ID registration process. + // + // * IN_TEMPLATE_ID The template ID that you received after completing the + // sender ID registration process. Make sure that the Template ID that you + // specify matches your message template exactly. If your message doesn't + // match the template that you provided during the registration process, + // the mobile carriers might reject your message. DestinationCountryParameters map[string]*string `type:"map"` // The destination phone number in E.164 format. @@ -22371,15 +22381,22 @@ type SendTextMessageInput struct { DestinationPhoneNumber *string `min:"1" type:"string" required:"true"` // When set to true, the message is checked and validated, but isn't sent to - // the end recipient. + // the end recipient. You are not charged for using DryRun. + // + // The Message Parts per Second (MPS) limit when using DryRun is five. If your + // origination identity has a lower MPS limit then the lower MPS limit is used. + // For more information about MPS limits, see Message Parts per Second (MPS) + // limits (https://docs.aws.amazon.com/sms-voice/latest/userguide/sms-limitations-mps.html) + // in the AWS End User Messaging SMS User Guide.. DryRun *bool `type:"boolean"` // When you register a short code in the US, you must specify a program name. // If you don’t have a US short code, omit this attribute. Keyword *string `min:"1" type:"string"` - // The maximum amount that you want to spend, in US dollars, per each text message - // part. A text message can contain multiple parts. + // 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. MaxPrice *string `min:"2" type:"string"` // The body of the text message. @@ -22396,7 +22413,9 @@ type SendTextMessageInput struct { // The unique identifier for the protect configuration. ProtectConfigurationId *string `min:"1" type:"string"` - // How long the text message is valid for. By default this is 72 hours. + // 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. TimeToLive *int64 `min:"5" type:"integer"` } @@ -22763,9 +22782,8 @@ func (s *SendVoiceMessageOutput) SetMessageId(v string) *SendVoiceMessageOutput } // The alphanumeric sender ID in a specific country that you want to describe. -// For more information on sender IDs see Requesting sender IDs for SMS messaging -// with Amazon Pinpoint (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-sender-id.html) -// in the Amazon Pinpoint User Guide. +// For more information on sender IDs see Requesting sender IDs (https://docs.aws.amazon.com/sms-voice/latest/userguide/sender-id-request.html) +// in the AWS End User Messaging SMS User Guide. type SenderIdAndCountry struct { _ struct{} `type:"structure"` @@ -23688,11 +23706,10 @@ func (s *SnsDestination) SetTopicArn(v string) *SnsDestination { return s } -// Describes the current Amazon Pinpoint monthly spend limits for sending voice -// and text messages. For more information on increasing your monthly spend -// limit, see Requesting increases to your monthly SMS spending quota for Amazon -// Pinpoint (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html) -// in the Amazon Pinpoint User Guide. +// Describes the current monthly spend limits for sending voice and text messages. +// For more information on increasing your monthly spend limit, see Requesting +// a spending quota increase (https://docs.aws.amazon.com/sms-voice/latest/userguide/awssupport-spend-threshold.html) +// in the AWS End User Messaging SMS User Guide. type SpendLimit struct { _ struct{} `type:"structure"` @@ -24392,7 +24409,7 @@ type UpdateEventDestinationInput struct { EventDestinationName *string `min:"1" type:"string" required:"true"` // An object that contains information about an event destination for logging - // to Kinesis Data Firehose. + // to Firehose. KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"` // An array of event types that determine which events to log. @@ -24573,11 +24590,11 @@ type UpdatePhoneNumberInput struct { PhoneNumberId *string `min:"1" type:"string" required:"true"` // By default this is set to false. When an end recipient sends a message that - // begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint - // automatically replies with a customizable message and adds the end recipient - // to the OptOutList. When set to true you're responsible for responding to - // HELP and STOP requests. You're also responsible for tracking and honoring - // opt-out requests. + // begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging + // SMS and Voice automatically replies with a customizable message and adds + // the end recipient to the OptOutList. When set to true you're responsible + // for responding to HELP and STOP requests. You're also responsible for tracking + // and honoring opt-out requests. SelfManagedOptOutsEnabled *bool `type:"boolean"` // The Amazon Resource Name (ARN) of the two way channel. @@ -24875,11 +24892,11 @@ type UpdatePoolInput struct { PoolId *string `min:"1" type:"string" required:"true"` // By default this is set to false. When an end recipient sends a message that - // begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint - // automatically replies with a customizable message and adds the end recipient - // to the OptOutList. When set to true you're responsible for responding to - // HELP and STOP requests. You're also responsible for tracking and honoring - // opt-out requests. + // begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging + // SMS and Voice automatically replies with a customizable message and adds + // the end recipient to the OptOutList. When set to true you're responsible + // for responding to HELP and STOP requests. You're also responsible for tracking + // and honoring opt-out requests. SelfManagedOptOutsEnabled *bool `type:"boolean"` // Indicates whether shared routes are enabled for the pool. @@ -25011,10 +25028,10 @@ type UpdatePoolOutput struct { PoolId *string `type:"string"` // When an end recipient sends a message that begins with HELP or STOP to one - // of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable - // message and adds the end recipient to the OptOutList. When set to true you're - // responsible for responding to HELP and STOP requests. You're also responsible - // for tracking and honoring opt-out requests. + // of your dedicated numbers, AWS End User Messaging SMS and Voice automatically + // replies with a customizable message and adds the end recipient to the OptOutList. + // When set to true you're responsible for responding to HELP and STOP requests. + // You're also responsible for tracking and honoring opt-out requests. SelfManagedOptOutsEnabled *bool `type:"boolean"` // Indicates whether shared routes are enabled for the pool. @@ -25132,7 +25149,7 @@ type UpdateProtectConfigurationCountryRuleSetInput struct { // the details for the requested NumberCapability. The Key is the two-letter // ISO country code. For a list of supported ISO country codes, see Supported // countries and regions (SMS channel) (https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html) - // in the Amazon Pinpoint SMS user guide. + // in the AWS End User Messaging SMS User Guide. // // CountryRuleSetUpdates is a required field CountryRuleSetUpdates map[string]*ProtectConfigurationCountryRuleSetInformation `min:"1" type:"map" required:"true"` diff --git a/service/pinpointsmsvoicev2/doc.go b/service/pinpointsmsvoicev2/doc.go index 845ad97f5ca..e20df798a66 100644 --- a/service/pinpointsmsvoicev2/doc.go +++ b/service/pinpointsmsvoicev2/doc.go @@ -3,30 +3,31 @@ // Package pinpointsmsvoicev2 provides the client and types for making API // requests to Amazon Pinpoint SMS Voice V2. // -// Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This -// guide provides information about Amazon Pinpoint SMS and Voice, version 2 -// API resources, including supported HTTP methods, parameters, and schemas. +// Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference. +// This guide provides information about AWS End User Messaging SMS and Voice, +// version 2 API resources, including supported HTTP methods, parameters, and +// schemas. // // Amazon Pinpoint is an Amazon Web Services service that you can use to engage -// with your recipients across multiple messaging channels. The Amazon Pinpoint -// SMS and Voice, version 2 API provides programmatic access to options that -// are unique to the SMS and voice channels. Amazon Pinpoint SMS and Voice, -// version 2 resources such as phone numbers, sender IDs, and opt-out lists -// can be used by the Amazon Pinpoint API. +// with your recipients across multiple messaging channels. The AWS End User +// Messaging SMS and Voice, version 2 API provides programmatic access to options +// that are unique to the SMS and voice channels. AWS End User Messaging SMS +// and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out +// lists can be used by the Amazon Pinpoint API. // -// If you're new to Amazon Pinpoint SMS, it's also helpful to review the Amazon -// Pinpoint SMS User Guide (https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html). -// The Amazon Pinpoint Developer Guide provides tutorials, code samples, and -// procedures that demonstrate how to use Amazon Pinpoint SMS features programmatically -// and how to integrate Amazon Pinpoint functionality into mobile apps and other -// types of applications. The guide also provides key information, such as Amazon -// Pinpoint integration with other Amazon Web Services services, and the quotas -// that apply to use of the service. +// If you're new to AWS End User Messaging SMS and Voice, it's also helpful +// to review the AWS End User Messaging SMS User Guide (https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html). +// The AWS End User Messaging SMS User Guide provides tutorials, code samples, +// and procedures that demonstrate how to use AWS End User Messaging SMS and +// Voice features programmatically and how to integrate functionality into mobile +// apps and other types of applications. The guide also provides key information, +// such as AWS End User Messaging SMS and Voice integration with other Amazon +// Web Services services, and the quotas that apply to use of the service. // // # Regional availability // -// The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in -// several Amazon Web Services Regions and it provides an endpoint for each +// The AWS End User Messaging SMS and Voice version 2 API Reference is available +// in several Amazon Web Services Regions and it provides an endpoint for each // of these Regions. For a list of all the Regions and endpoints where the API // is currently available, see Amazon Web Services Service Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region) // and Amazon Pinpoint endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/pinpoint.html)