diff --git a/codegen/sdk-codegen/aws-models/application-auto-scaling.json b/codegen/sdk-codegen/aws-models/application-auto-scaling.json index 1cc31a38a78..149c976a819 100644 --- a/codegen/sdk-codegen/aws-models/application-auto-scaling.json +++ b/codegen/sdk-codegen/aws-models/application-auto-scaling.json @@ -2379,6 +2379,18 @@ "traits": { "smithy.api#enumValue": "WorkSpacesAverageUserSessionsCapacityUtilization" } + }, + "SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution" + } + }, + "SageMakerVariantConcurrentRequestsPerModelHighResolution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SageMakerVariantConcurrentRequestsPerModelHighResolution" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/cleanrooms.json b/codegen/sdk-codegen/aws-models/cleanrooms.json index db7e7cfa502..ec1149fb1a3 100644 --- a/codegen/sdk-codegen/aws-models/cleanrooms.json +++ b/codegen/sdk-codegen/aws-models/cleanrooms.json @@ -31,6 +31,12 @@ { "target": "com.amazonaws.cleanrooms#ConfiguredTableResource" }, + { + "target": "com.amazonaws.cleanrooms#IdMappingTableResource" + }, + { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationResource" + }, { "target": "com.amazonaws.cleanrooms#MembershipResource" }, @@ -783,6 +789,38 @@ "smithy.api#pattern": "^\\d+$" } }, + "com.amazonaws.cleanrooms#AdditionalAnalyses": { + "type": "enum", + "members": { + "ALLOWED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOWED" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRED" + } + }, + "NOT_ALLOWED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_ALLOWED" + } + } + } + }, + "com.amazonaws.cleanrooms#AdditionalAnalysesResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:([\\d]{12}|\\*):membership/[\\*\\d\\w-]+/configuredaudiencemodelassociation/[\\*\\d\\w-]+$" + } + }, "com.amazonaws.cleanrooms#AggregateColumn": { "type": "structure", "members": { @@ -896,6 +934,18 @@ ] } }, + "com.amazonaws.cleanrooms#AllowedAdditionalAnalyses": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AdditionalAnalysesResourceArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, "com.amazonaws.cleanrooms#AllowedAnalysesList": { "type": "list", "member": { @@ -920,6 +970,12 @@ } } }, + "com.amazonaws.cleanrooms#AllowedResultReceivers": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AccountId" + } + }, "com.amazonaws.cleanrooms#AnalysisFormat": { "type": "string", "traits": { @@ -1085,6 +1141,12 @@ "smithy.api#documentation": "
Columns that must meet a specific threshold value (after an aggregation function is\n applied to it) for each output row to be returned.
", "smithy.api#required": {} } + }, + "additionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AdditionalAnalyses", + "traits": { + "smithy.api#documentation": "An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
\nThe\n additionalAnalyses
\n parameter is\n currently\n supported for the list analysis rule (AnalysisRuleList
) and the custom\n analysis rule (AnalysisRuleCustom
).
An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
" + } + }, + "disallowedOutputColumns": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnList", + "traits": { + "smithy.api#documentation": "A list of columns that aren't allowed to be shown in the query output.
" + } + }, "differentialPrivacy": { "target": "com.amazonaws.cleanrooms#DifferentialPrivacyConfiguration", "traits": { @@ -1146,6 +1220,38 @@ "smithy.api#documentation": "A type of analysis rule that enables the table owner to approve custom SQL queries on\n their configured tables. It supports differential privacy.
" } }, + "com.amazonaws.cleanrooms#AnalysisRuleIdMappingTable": { + "type": "structure", + "members": { + "joinColumns": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnList", + "traits": { + "smithy.api#documentation": "The columns that query runners are allowed to use in an INNER JOIN statement.
", + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#required": {} + } + }, + "queryConstraints": { + "target": "com.amazonaws.cleanrooms#QueryConstraintList", + "traits": { + "smithy.api#documentation": "The query constraints of the analysis rule ID mapping table.
", + "smithy.api#required": {} + } + }, + "dimensionColumns": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnList", + "traits": { + "smithy.api#documentation": "The columns that query runners are allowed to select, group by, or filter by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines details for the analysis rule ID mapping table.
" + } + }, "com.amazonaws.cleanrooms#AnalysisRuleList": { "type": "structure", "members": { @@ -1171,6 +1277,12 @@ "smithy.api#documentation": "Columns that can be listed in the output.
", "smithy.api#required": {} } + }, + "additionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AdditionalAnalyses", + "traits": { + "smithy.api#documentation": "An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
" + } } }, "traits": { @@ -1211,6 +1323,12 @@ "traits": { "smithy.api#documentation": "Analysis rule type that enables custom SQL queries on a configured table.
" } + }, + "idMappingTable": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleIdMappingTable", + "traits": { + "smithy.api#documentation": "The ID mapping table.
" + } } }, "traits": { @@ -1237,6 +1355,12 @@ "traits": { "smithy.api#enumValue": "CUSTOM" } + }, + "ID_MAPPING_TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID_MAPPING_TABLE" + } } } }, @@ -1643,6 +1767,23 @@ } } }, + "com.amazonaws.cleanrooms#AnalysisType": { + "type": "enum", + "members": { + "DIRECT_ANALYSIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_ANALYSIS" + } + }, + "ADDITIONAL_ANALYSIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDITIONAL_ANALYSIS" + } + } + } + }, "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate": { "type": "operation", "input": { @@ -1979,7 +2120,7 @@ "names": { "target": "com.amazonaws.cleanrooms#TableAliasList", "traits": { - "smithy.api#documentation": "The names for the schema objects to\n retrieve.
", + "smithy.api#documentation": "The names for the schema objects to retrieve.
", "smithy.api#required": {} } } @@ -2473,6 +2614,184 @@ "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$" } }, + "com.amazonaws.cleanrooms#CollaborationIdNamespaceAssociation": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration ID namespace association.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdNamespaceAssociationId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration that contains the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collaboration that contains the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#GenericResourceName", + "traits": { + "smithy.api#documentation": "The name of the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the collaboration ID namespace association.
" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon Web Services account that created the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the collaboration ID namespace association was created.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the collaboration ID namespace was updated.
", + "smithy.api#required": {} + } + }, + "inputReferenceConfig": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceConfig", + "traits": { + "smithy.api#documentation": "The input reference configuration that's necessary to create the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "inputReferenceProperties": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceProperties", + "traits": { + "smithy.api#documentation": "The input reference properties that are needed to create the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "idMappingConfig": { + "target": "com.amazonaws.cleanrooms#IdMappingConfig" + } + }, + "traits": { + "smithy.api#documentation": "Defines details for the collaboration ID namespace association.
" + } + }, + "com.amazonaws.cleanrooms#CollaborationIdNamespaceAssociationSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the collaboration ID namespace association was created.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the collaboration ID namespace association was updated.
", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collaboration that contains this collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration that contains this collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account that created this collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "inputReferenceConfig": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceConfig", + "traits": { + "smithy.api#documentation": "The input reference configuration that's used to create the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#GenericResourceName", + "traits": { + "smithy.api#documentation": "The name of the collaboration ID namespace association.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the collaboration ID namepsace association.
" + } + }, + "inputReferenceProperties": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferencePropertiesSummary", + "traits": { + "smithy.api#documentation": "The input reference properties that are used to create the collaboration ID namespace association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about the collaboration ID namespace association.
" + } + }, + "com.amazonaws.cleanrooms#CollaborationIdNamespaceAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationIdNamespaceAssociationSummary" + } + }, "com.amazonaws.cleanrooms#CollaborationIdentifier": { "type": "string", "traits": { @@ -2781,6 +3100,9 @@ { "target": "com.amazonaws.cleanrooms#GetCollaborationConfiguredAudienceModelAssociation" }, + { + "target": "com.amazonaws.cleanrooms#GetCollaborationIdNamespaceAssociation" + }, { "target": "com.amazonaws.cleanrooms#GetCollaborationPrivacyBudgetTemplate" }, @@ -2796,6 +3118,9 @@ { "target": "com.amazonaws.cleanrooms#ListCollaborationConfiguredAudienceModelAssociations" }, + { + "target": "com.amazonaws.cleanrooms#ListCollaborationIdNamespaceAssociations" + }, { "target": "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgets" }, @@ -2949,6 +3274,20 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" } }, + "com.amazonaws.cleanrooms#ConfigurationDetails": { + "type": "union", + "members": { + "directAnalysisConfigurationDetails": { + "target": "com.amazonaws.cleanrooms#DirectAnalysisConfigurationDetails", + "traits": { + "smithy.api#documentation": "The direct analysis configuration details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details.
" + } + }, "com.amazonaws.cleanrooms#ConfiguredAudienceModelArn": { "type": "string", "traits": { @@ -3480,6 +3819,12 @@ "smithy.api#documentation": "A description of the configured table association.
" } }, + "analysisRuleTypes": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleTypeList", + "traits": { + "smithy.api#documentation": "The analysis rule types for the configured table association.
" + } + }, "createTime": { "target": "smithy.api#Timestamp", "traits": { @@ -3499,14 +3844,202 @@ "smithy.api#documentation": "A configured table association links a configured table to a collaboration.
" } }, - "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 100 - }, - "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtableassociation/[\\d\\w-]+/[\\d\\w-]+$" - } + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The membership identifier for the configured table association analysis rule.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableAssociationId": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "\n The\n unique identifier for the configured table association.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "configuredTableAssociationArn": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn", + "traits": { + "smithy.api#documentation": "\n The\n Amazon Resource Name (ARN) of the configured table association.
", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy", + "traits": { + "smithy.api#documentation": "The policy of the configured table association analysis rule.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", + "traits": { + "smithy.api#documentation": "The type of the configured table association analysis rule.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the configured table association analysis rule.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The update time of the configured table association analysis rule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An\n analysis rule for a configured table association. This analysis rule specifies how data\n from the table can be used within its associated\n collaboration.\n In the console, the ConfiguredTableAssociationAnalysisRule
is referred to as the\n collaboration analysis rule.
The list of collaboration members who are allowed to receive results of queries run\n with this configured table.
" + } + }, + "allowedAdditionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AllowedAdditionalAnalyses", + "traits": { + "smithy.api#documentation": "The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
\nThe\n allowedAdditionalAnalyses
\n parameter\n is currently supported for the list analysis rule\n (AnalysisRuleList
) and the custom analysis rule\n (AnalysisRuleCustom
).
The configured table association analysis rule applied to a configured table with the aggregation analysis rule.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleCustom": { + "type": "structure", + "members": { + "allowedResultReceivers": { + "target": "com.amazonaws.cleanrooms#AllowedResultReceivers", + "traits": { + "smithy.api#documentation": "The list of\n collaboration members who are allowed\n to\n receive results of queries run with this configured table.
" + } + }, + "allowedAdditionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AllowedAdditionalAnalyses", + "traits": { + "smithy.api#documentation": "The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configured table association analysis rule applied to a configured table with the custom analysis rule.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleList": { + "type": "structure", + "members": { + "allowedResultReceivers": { + "target": "com.amazonaws.cleanrooms#AllowedResultReceivers", + "traits": { + "smithy.api#documentation": "The list of collaboration members who are allowed to receive results of queries run\n with this configured table.
" + } + }, + "allowedAdditionalAnalyses": { + "target": "com.amazonaws.cleanrooms#AllowedAdditionalAnalyses", + "traits": { + "smithy.api#documentation": "The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configured table association analysis rule applied to a configured table with the list analysis rule.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy": { + "type": "union", + "members": { + "v1": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicyV1", + "traits": { + "smithy.api#documentation": "The policy for the configured table association analysis rule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Controls on the query specifications that can be run on an associated configured table.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicyV1": { + "type": "union", + "members": { + "list": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleList", + "traits": { + "smithy.api#documentation": "Analysis rule type that enables only list queries on a configured table.
" + } + }, + "aggregation": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleAggregation", + "traits": { + "smithy.api#documentation": "Analysis rule type that enables only aggregation queries on a configured table.
" + } + }, + "custom": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleCustom", + "traits": { + "smithy.api#documentation": "Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Controls on the query specifications that can be run on an associated configured table.
" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType": { + "type": "enum", + "members": { + "AGGREGATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGGREGATION" + } + }, + "LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIST" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 100 + }, + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtableassociation/[\\d\\w-]+/[\\d\\w-]+$" + } }, "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier": { "type": "string", @@ -3543,6 +4076,20 @@ "list": { "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociations" }, + "operations": [ + { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRule" + } + ], "traits": { "aws.api#arn": { "template": "membership/{MembershipId}/configuredtableassociation/{ConfiguredTableAssociationId}" @@ -4001,7 +4548,7 @@ "creatorPaymentConfiguration": { "target": "com.amazonaws.cleanrooms#PaymentConfiguration", "traits": { - "smithy.api#documentation": "The collaboration\n creator's payment responsibilities set by the collaboration creator.
\nIf the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.
" + "smithy.api#documentation": "The collaboration creator's payment responsibilities set by the collaboration creator.
\nIf the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.
" } } } @@ -4012,7 +4559,7 @@ "collaboration": { "target": "com.amazonaws.cleanrooms#Collaboration", "traits": { - "smithy.api#documentation": "The entire created collaboration object.
", + "smithy.api#documentation": "The collaboration.
", "smithy.api#required": {} } } @@ -4227,7 +4774,7 @@ "analysisRulePolicy": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy", "traits": { - "smithy.api#documentation": "The entire created configured table analysis rule object.
", + "smithy.api#documentation": "The analysis rule policy that was created for the configured table.
", "smithy.api#required": {} } } @@ -4239,7 +4786,7 @@ "analysisRule": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRule", "traits": { - "smithy.api#documentation": "The entire created analysis rule.
", + "smithy.api#documentation": "The analysis rule that was created for the configured table.
", "smithy.api#required": {} } } @@ -4289,6 +4836,102 @@ } } }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRuleInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create analysis rules for configured table association" + }, + "smithy.api#documentation": "Creates a new analysis rule for an associated configured table.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRuleInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The unique ID for the configured table association. Currently accepts the\n configured table association ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", + "traits": { + "smithy.api#documentation": "The type of analysis rule.
", + "smithy.api#required": {} + } + }, + "analysisRulePolicy": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy", + "traits": { + "smithy.api#documentation": "The analysis rule policy that was created for the configured table\n association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationAnalysisRuleOutput": { + "type": "structure", + "members": { + "analysisRule": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", + "traits": { + "smithy.api#documentation": "The analysis rule for the configured table association.\n In the console, the\n ConfiguredTableAssociationAnalysisRule
is referred to as the\n collaboration analysis rule.
The entire configured table association object.
", + "smithy.api#documentation": "The configured table association.
", "smithy.api#required": {} } } @@ -4405,13 +5048,13 @@ } } }, - "com.amazonaws.cleanrooms#CreateMembership": { + "com.amazonaws.cleanrooms#CreateIdMappingTable": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#CreateMembershipInput" + "target": "com.amazonaws.cleanrooms#CreateIdMappingTableInput" }, "output": { - "target": "com.amazonaws.cleanrooms#CreateMembershipOutput" + "target": "com.amazonaws.cleanrooms#CreateIdMappingTableOutput" }, "errors": [ { @@ -4437,33 +5080,243 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to join collaborations by creating a membership", - "smithy.api#documentation": "Creates a membership for a specific collaboration identifier and joins the\n collaboration.
", + "aws.iam#actionPermissionDescription": "Grants permission to link an id mapping workflow with a collaboration by creating a new id mapping table", + "smithy.api#documentation": "Creates an ID mapping table.
", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/memberships" + "uri": "/memberships/{membershipIdentifier}/idmappingtables" } } }, - "com.amazonaws.cleanrooms#CreateMembershipInput": { + "com.amazonaws.cleanrooms#CreateIdMappingTableInput": { "type": "structure", "members": { - "collaborationIdentifier": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "The unique ID for the associated collaboration.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of the membership that contains the ID mapping table.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" } }, - "queryLogStatus": { - "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", "traits": { - "smithy.api#documentation": "An indicator as to whether query logging has been enabled or disabled for the\n membership.
", + "smithy.api#documentation": "A name for the ID mapping table.
", "smithy.api#required": {} } }, - "tags": { + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "A description of the ID mapping table.
" + } + }, + "inputReferenceConfig": { + "target": "com.amazonaws.cleanrooms#IdMappingTableInputReferenceConfig", + "traits": { + "smithy.api#documentation": "The input reference configuration needed to create the ID mapping table.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanrooms#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. This value is used to encrypt the mapping table data that is stored by Clean Rooms.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#CreateIdMappingTableOutput": { + "type": "structure", + "members": { + "idMappingTable": { + "target": "com.amazonaws.cleanrooms#IdMappingTable", + "traits": { + "smithy.api#documentation": "The ID mapping table that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#CreateIdNamespaceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateIdNamespaceAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateIdNamespaceAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to link an AWS Entity Resolution Id Namespace with a collaboration by creating a new association", + "smithy.api#documentation": "Creates an ID namespace association.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/idnamespaceassociations" + } + } + }, + "com.amazonaws.cleanrooms#CreateIdNamespaceAssociationInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership that contains the ID namespace association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "inputReferenceConfig": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceConfig", + "traits": { + "smithy.api#documentation": "The input reference configuration needed to create the ID namespace association.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#GenericResourceName", + "traits": { + "smithy.api#documentation": "The name for the ID namespace association.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the ID namespace association.
" + } + }, + "idMappingConfig": { + "target": "com.amazonaws.cleanrooms#IdMappingConfig", + "traits": { + "smithy.api#documentation": "The configuration settings for the ID mapping table.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#CreateIdNamespaceAssociationOutput": { + "type": "structure", + "members": { + "idNamespaceAssociation": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociation", + "traits": { + "smithy.api#documentation": "The ID namespace association that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#CreateMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateMembershipInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateMembershipOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to join collaborations by creating a membership", + "smithy.api#documentation": "Creates a membership for a specific collaboration identifier and joins the\n collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships" + } + } + }, + "com.amazonaws.cleanrooms#CreateMembershipInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "The unique ID for the associated collaboration.
", + "smithy.api#required": {} + } + }, + "queryLogStatus": { + "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", + "traits": { + "smithy.api#documentation": "An indicator as to whether query logging has been enabled or disabled for the\n membership.
", + "smithy.api#required": {} + } + }, + "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" @@ -4472,13 +5325,13 @@ "defaultResultConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", "traits": { - "smithy.api#documentation": "The default\n protected query result configuration as specified by the member who can receive\n results.
" + "smithy.api#documentation": "The default protected query result configuration as specified by the member who can\n receive results.
" } }, "paymentConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", "traits": { - "smithy.api#documentation": "The payment\n responsibilities accepted by the collaboration member.
\nNot required if the collaboration member has the member ability to run queries.
\nRequired if the collaboration member doesn't have the member ability to run queries but\n is configured as a payer by the collaboration creator.
" + "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member.
\nNot required if the collaboration member has the member ability to run queries.
\nRequired if the collaboration member doesn't have the member ability to run queries but\n is configured as a payer by the collaboration creator.
" } } } @@ -4598,28 +5451,28 @@ "allowCleartext": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether encrypted tables can contain cleartext data\n (TRUE
)\n or are to cryptographically process every column\n (FALSE
).
Indicates whether encrypted tables can contain cleartext data (TRUE
) or are\n to cryptographically process every column (FALSE
).
Indicates whether Fingerprint columns can contain duplicate entries\n (TRUE
)\n or are to contain only non-repeated values\n (FALSE
).
Indicates whether Fingerprint columns can contain duplicate entries (TRUE
)\n or are to contain only non-repeated values (FALSE
).
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with\n a different name\n (TRUE
)\n or can only be joined on Fingerprint columns of the same name\n (FALSE
).
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with\n a different name (TRUE
) or can only be joined on Fingerprint columns of the\n same name (FALSE
).
Indicates whether NULL values are to be copied as NULL to encrypted tables\n (TRUE
)\n or cryptographically processed\n (FALSE
).
Indicates whether NULL values are to be copied as NULL to encrypted tables\n (TRUE
) or cryptographically processed (FALSE
).
Deletes\n an analysis rule for a configured table association.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationAnalysisRuleInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The\n identifier for the configured table association that's related to the analysis rule that you\n want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", + "traits": { + "smithy.api#documentation": "The\n type of the analysis rule that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationAnalysisRuleOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationInput": { "type": "structure", "members": { @@ -5005,21 +5940,18 @@ "smithy.api#documentation": "The empty output for a successful deletion.
" } }, - "com.amazonaws.cleanrooms#DeleteMember": { + "com.amazonaws.cleanrooms#DeleteIdMappingTable": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#DeleteMemberInput" + "target": "com.amazonaws.cleanrooms#DeleteIdMappingTableInput" }, "output": { - "target": "com.amazonaws.cleanrooms#DeleteMemberOutput" + "target": "com.amazonaws.cleanrooms#DeleteIdMappingTableOutput" }, "errors": [ { "target": "com.amazonaws.cleanrooms#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, { "target": "com.amazonaws.cleanrooms#InternalServerException" }, @@ -5034,12 +5966,153 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete members from a collaboration", - "smithy.api#documentation": "Removes the specified member from a collaboration. The removed member is placed in the\n Removed status and can't interact with the collaboration. The removed member's data is\n inaccessible to active members of the collaboration.
", + "aws.iam#actionPermissionDescription": "Grants permission to remove an id mapping table from a collaboration", + "smithy.api#documentation": "Deletes an ID mapping table.
", "smithy.api#http": { "code": 204, "method": "DELETE", - "uri": "/collaborations/{collaborationIdentifier}/member/{accountId}" + "uri": "/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteIdMappingTableInput": { + "type": "structure", + "members": { + "idMappingTableIdentifier": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID mapping table that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdMappingTableId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership that contains the ID mapping table that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#DeleteIdMappingTableOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#DeleteIdNamespaceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteIdNamespaceAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteIdNamespaceAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to remove an Id Namespace Association from a collaboration", + "smithy.api#documentation": "Deletes an ID namespace association.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/idnamespaceassociations/{idNamespaceAssociationIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteIdNamespaceAssociationInput": { + "type": "structure", + "members": { + "idNamespaceAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID namespace association that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdNamespaceAssociationId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership that contains the ID namespace association that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#DeleteIdNamespaceAssociationOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#DeleteMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteMemberInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteMemberOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete members from a collaboration", + "smithy.api#documentation": "Removes the specified member from a collaboration. The removed member is placed in the\n Removed status and can't interact with the collaboration. The removed member's data is\n inaccessible to active members of the collaboration.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/collaborations/{collaborationIdentifier}/member/{accountId}" }, "smithy.api#idempotent": {} } @@ -5541,6 +6614,20 @@ "smithy.api#documentation": "The epsilon and noise parameter values that you want to update in the differential privacy template.
" } }, + "com.amazonaws.cleanrooms#DirectAnalysisConfigurationDetails": { + "type": "structure", + "members": { + "receiverAccountIds": { + "target": "com.amazonaws.cleanrooms#ReceiverAccountIds", + "traits": { + "smithy.api#documentation": "The account IDs for the member who received the results of a protected query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The direct analysis configuration details.
" + } + }, "com.amazonaws.cleanrooms#DisplayName": { "type": "string", "traits": { @@ -5575,6 +6662,16 @@ ] } }, + "com.amazonaws.cleanrooms#GenericResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + } + }, "com.amazonaws.cleanrooms#GetAnalysisTemplate": { "type": "operation", "input": { @@ -5827,6 +6924,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.cleanrooms#GetCollaborationIdNamespaceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetCollaborationIdNamespaceAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetCollaborationIdNamespaceAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get id namespace association within a collaboration", + "smithy.api#documentation": "Retrieves an ID namespace association from a specific collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/idnamespaceassociations/{idNamespaceAssociationIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationIdNamespaceAssociationInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration that contains the ID namespace association that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "idNamespaceAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID namespace association that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdNamespaceAssociationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationIdNamespaceAssociationOutput": { + "type": "structure", + "members": { + "collaborationIdNamespaceAssociation": { + "target": "com.amazonaws.cleanrooms#CollaborationIdNamespaceAssociation", + "traits": { + "smithy.api#documentation": "The ID namespace association that you requested.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#GetCollaborationInput": { "type": "structure", "members": { @@ -6149,34 +7323,121 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetConfiguredTableAssociationInput": { + "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRuleInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get analysis rules for a configured table association" + }, + "smithy.api#documentation": "\n Retrieves\n the analysis rule for a configured table association.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRuleInput": { "type": "structure", "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "The unique ID for the configured table association to retrieve. Currently accepts the\n configured table ID.
", + "smithy.api#documentation": "\n The\n identifier for the configured table association that's related to the analysis\n rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" } }, - "membershipIdentifier": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", "traits": { - "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#documentation": "\n The\n type of analysis rule that you want to retrieve.
", "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#GetConfiguredTableAssociationOutput": { + "com.amazonaws.cleanrooms#GetConfiguredTableAssociationAnalysisRuleOutput": { "type": "structure", "members": { - "configuredTableAssociation": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociation", + "analysisRule": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", + "traits": { + "smithy.api#documentation": "The\n analysis rule for the configured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule
is referred to as the\n collaboration analysis rule.
The unique ID for the configured table association to retrieve. Currently accepts the\n configured table ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + } + }, + "com.amazonaws.cleanrooms#GetConfiguredTableAssociationOutput": { + "type": "structure", + "members": { + "configuredTableAssociation": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociation", "traits": { "smithy.api#documentation": "The entire configured table association object.
", "smithy.api#required": {} @@ -6210,6 +7471,160 @@ } } }, + "com.amazonaws.cleanrooms#GetIdMappingTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetIdMappingTableInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetIdMappingTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to view details of an id mapping table", + "smithy.api#documentation": "Retrieves an ID mapping table.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetIdMappingTableInput": { + "type": "structure", + "members": { + "idMappingTableIdentifier": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID mapping table identifier that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdMappingTableId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership that contains the ID mapping table that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#GetIdMappingTableOutput": { + "type": "structure", + "members": { + "idMappingTable": { + "target": "com.amazonaws.cleanrooms#IdMappingTable", + "traits": { + "smithy.api#documentation": "The ID mapping table that you requested.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#GetIdNamespaceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetIdNamespaceAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetIdNamespaceAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to view details of an id namespace association", + "smithy.api#documentation": "Retrieves an ID namespace association.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/idnamespaceassociations/{idNamespaceAssociationIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetIdNamespaceAssociationInput": { + "type": "structure", + "members": { + "idNamespaceAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID namespace association that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdNamespaceAssociationId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership that contains the ID namespace association that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#GetIdNamespaceAssociationOutput": { + "type": "structure", + "members": { + "idNamespaceAssociation": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociation", + "traits": { + "smithy.api#documentation": "The ID namespace association that you requested.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#GetMembership": { "type": "operation", "input": { @@ -6588,23 +8003,720 @@ "com.amazonaws.cleanrooms#GlueTableReference": { "type": "structure", "members": { - "tableName": { - "target": "com.amazonaws.cleanrooms#GlueTableName", + "tableName": { + "target": "com.amazonaws.cleanrooms#GlueTableName", + "traits": { + "smithy.api#documentation": "The name of the Glue table.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.cleanrooms#GlueDatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database the Glue table belongs to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to a table within an Glue data catalog.
" + } + }, + "com.amazonaws.cleanrooms#IdMappingConfig": { + "type": "structure", + "members": { + "allowUseAsDimensionColumn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "An indicator as to whether you can use your column as a dimension column in the ID mapping table (TRUE
) or not (FALSE
).
Default is FALSE
.
The configuration settings for the ID mapping table.
" + } + }, + "com.amazonaws.cleanrooms#IdMappingTable": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID mapping table.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdMappingTableId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#IdMappingTableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ID mapping table.
", + "smithy.api#required": {} + } + }, + "inputReferenceConfig": { + "target": "com.amazonaws.cleanrooms#IdMappingTableInputReferenceConfig", + "traits": { + "smithy.api#documentation": "The input reference configuration for the ID mapping table.
", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership resource for the ID mapping table.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.
", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration that contains this ID mapping table.
", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the ID mapping table.
" + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", + "traits": { + "smithy.api#documentation": "The name of the ID mapping table.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the ID mapping table was created.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the ID mapping table was updated.
", + "smithy.api#required": {} + } + }, + "inputReferenceProperties": { + "target": "com.amazonaws.cleanrooms#IdMappingTableInputReferenceProperties", + "traits": { + "smithy.api#documentation": "The input reference properties for the ID mapping table.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanrooms#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes information about the ID mapping table.
" + } + }, + "com.amazonaws.cleanrooms#IdMappingTableArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + }, + "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/idmappingtable/[\\d\\w-]+$" + } + }, + "com.amazonaws.cleanrooms#IdMappingTableInputReferenceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)$" + } + }, + "com.amazonaws.cleanrooms#IdMappingTableInputReferenceConfig": { + "type": "structure", + "members": { + "inputReferenceArn": { + "target": "com.amazonaws.cleanrooms#IdMappingTableInputReferenceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
", + "smithy.api#required": {} + } + }, + "manageResourcePolicies": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "When TRUE
, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE
, the resource owner manages permissions for the ID mapping table resource.
Provides the input reference configuration for the ID mapping table.
" + } + }, + "com.amazonaws.cleanrooms#IdMappingTableInputReferenceProperties": { + "type": "structure", + "members": { + "idMappingTableInputSource": { + "target": "com.amazonaws.cleanrooms#IdMappingTableInputSourceList", + "traits": { + "smithy.api#documentation": "The input source of the ID mapping table.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input reference properties for the ID mapping table.
" + } + }, + "com.amazonaws.cleanrooms#IdMappingTableInputSource": { + "type": "structure", + "members": { + "idNamespaceAssociationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID namespace association.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cleanrooms#IdNamespaceType", + "traits": { + "smithy.api#documentation": "The type of the input source of the ID mapping table.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input source of the ID mapping table.
" + } + }, + "com.amazonaws.cleanrooms#IdMappingTableInputSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#IdMappingTableInputSource" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.cleanrooms#IdMappingTableResource": { + "type": "resource", + "identifiers": { + "MembershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier" + }, + "IdMappingTableId": { + "target": "com.amazonaws.cleanrooms#UUID" + } + }, + "create": { + "target": "com.amazonaws.cleanrooms#CreateIdMappingTable" + }, + "read": { + "target": "com.amazonaws.cleanrooms#GetIdMappingTable" + }, + "update": { + "target": "com.amazonaws.cleanrooms#UpdateIdMappingTable" + }, + "delete": { + "target": "com.amazonaws.cleanrooms#DeleteIdMappingTable" + }, + "list": { + "target": "com.amazonaws.cleanrooms#ListIdMappingTables" + }, + "operations": [ + { + "target": "com.amazonaws.cleanrooms#PopulateIdMappingTable" + } + ], + "traits": { + "aws.api#arn": { + "template": "membership/{MembershipId}/idmappingtable/{IdMappingTableId}" + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "idmappingtable" + }, + "smithy.api#documentation": "Represents an Id Mapping Workflow associate with a collaboration" + } + }, + "com.amazonaws.cleanrooms#IdMappingTableSchemaTypeProperties": { + "type": "structure", + "members": { + "idMappingTableInputSource": { + "target": "com.amazonaws.cleanrooms#IdMappingTableInputSourceList", + "traits": { + "smithy.api#documentation": "Defines which ID namespace associations are used to create the ID mapping table.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Additional properties that are specific to the type of the associated schema.
" + } + }, + "com.amazonaws.cleanrooms#IdMappingTableSummary": { + "type": "structure", + "members": { + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration that contains this ID mapping table.
", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership resource for this ID mapping table.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the membership resource for this ID mapping table.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which this ID mapping table was created.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which this ID mapping table was updated.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of this ID mapping table.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdMappingTableId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#IdMappingTableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of this ID mapping table.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of this ID mapping table.
" + } + }, + "inputReferenceConfig": { + "target": "com.amazonaws.cleanrooms#IdMappingTableInputReferenceConfig", + "traits": { + "smithy.api#documentation": "The input reference configuration for the ID mapping table.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", + "traits": { + "smithy.api#documentation": "The name of this ID mapping table.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about the ID mapping table.
" + } + }, + "com.amazonaws.cleanrooms#IdMappingTableSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#IdMappingTableSummary" + } + }, + "com.amazonaws.cleanrooms#IdMappingWorkflowsSupported": { + "type": "list", + "member": { + "target": "smithy.api#Document" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociation": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier for this ID namespace association.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdNamespaceAssociationIdentifier" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ID namespace association.
", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership resource for this ID namespace association.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration that contains this ID namespace association.
", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#GenericResourceName", + "traits": { + "smithy.api#documentation": "The name of this ID namespace association.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the ID namespace association.
" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the ID namespace association was created.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the ID namespace association was updated.
", + "smithy.api#required": {} + } + }, + "inputReferenceConfig": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceConfig", + "traits": { + "smithy.api#documentation": "The input reference configuration for the ID namespace association.
", + "smithy.api#required": {} + } + }, + "inputReferenceProperties": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceProperties", + "traits": { + "smithy.api#documentation": "The input reference properties for the ID namespace association.
", + "smithy.api#required": {} + } + }, + "idMappingConfig": { + "target": "com.amazonaws.cleanrooms#IdMappingConfig", + "traits": { + "smithy.api#documentation": "The configuration settings for the ID mapping table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information to create the ID namespace association.
" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/idnamespaceassociation/[\\d\\w-]+$" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociationIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws:entityresolution:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:idnamespace/[\\d\\w-]+$" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceConfig": { + "type": "structure", + "members": { + "inputReferenceArn": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
", + "smithy.api#required": {} + } + }, + "manageResourcePolicies": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "When TRUE
, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE
, the resource owner manages permissions for the ID namespace association resource.
Provides the information for the ID namespace association input reference configuration.
" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceProperties": { + "type": "structure", + "members": { + "idNamespaceType": { + "target": "com.amazonaws.cleanrooms#IdNamespaceType", + "traits": { + "smithy.api#documentation": "The ID namespace type for this ID namespace association.
", + "smithy.api#required": {} + } + }, + "idMappingWorkflowsSupported": { + "target": "com.amazonaws.cleanrooms#IdMappingWorkflowsSupported", + "traits": { + "smithy.api#documentation": "Defines how ID mapping workflows are supported for this ID namespace association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the information for the ID namespace association input reference properties.
" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferencePropertiesSummary": { + "type": "structure", + "members": { + "idNamespaceType": { + "target": "com.amazonaws.cleanrooms#IdNamespaceType", + "traits": { + "smithy.api#documentation": "The ID namespace type for this ID namespace association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about the ID namespace association input reference properties.
" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociationResource": { + "type": "resource", + "identifiers": { + "MembershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier" + }, + "IdNamespaceAssociationId": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationIdentifier" + } + }, + "create": { + "target": "com.amazonaws.cleanrooms#CreateIdNamespaceAssociation" + }, + "read": { + "target": "com.amazonaws.cleanrooms#GetIdNamespaceAssociation" + }, + "update": { + "target": "com.amazonaws.cleanrooms#UpdateIdNamespaceAssociation" + }, + "delete": { + "target": "com.amazonaws.cleanrooms#DeleteIdNamespaceAssociation" + }, + "list": { + "target": "com.amazonaws.cleanrooms#ListIdNamespaceAssociations" + }, + "traits": { + "aws.api#arn": { + "template": "membership/{MembershipId}/idnamespaceassociation/{IdNamespaceAssociationId}" + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "idnamespaceassociation" + }, + "smithy.api#documentation": "Represents an AWS Entity Resolution Id Namespace resource that has been associated with the collaboration for use in a entity resolution workflow as a data input" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociationSummary": { + "type": "structure", + "members": { + "membershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership resource for this ID namespace association.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration that contains this ID namespace association.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which this ID namespace association was created.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which this ID namespace association has been updated.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of this ID namespace association.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdNamespaceAssociationId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of this ID namespace association.
", + "smithy.api#required": {} + } + }, + "inputReferenceConfig": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferenceConfig", + "traits": { + "smithy.api#documentation": "The input reference configuration details for this ID namespace association.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#GenericResourceName", + "traits": { + "smithy.api#documentation": "The name of the ID namespace association.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the ID namespace association.
" + } + }, + "inputReferenceProperties": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationInputReferencePropertiesSummary", + "traits": { + "smithy.api#documentation": "The input reference properties for this ID namespace association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about the ID namespace association.
" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationSummary" + } + }, + "com.amazonaws.cleanrooms#IdNamespaceType": { + "type": "enum", + "members": { + "SOURCE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the Glue table.
", - "smithy.api#required": {} + "smithy.api#enumValue": "SOURCE" } }, - "databaseName": { - "target": "com.amazonaws.cleanrooms#GlueDatabaseName", + "TARGET": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the database the Glue table belongs to.
", - "smithy.api#required": {} + "smithy.api#enumValue": "TARGET" } } - }, - "traits": { - "smithy.api#documentation": "A reference to a table within an Glue data catalog.
" } }, "com.amazonaws.cleanrooms#InternalServerException": { @@ -6657,6 +8769,16 @@ ] } }, + "com.amazonaws.cleanrooms#KMSKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:kms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:key/[a-zA-Z0-9-]+$" + } + }, "com.amazonaws.cleanrooms#KeyPrefix": { "type": "string", "traits": { @@ -6930,6 +9052,100 @@ "smithy.api#output": {} } }, + "com.amazonaws.cleanrooms#ListCollaborationIdNamespaceAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListCollaborationIdNamespaceAssociationsInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListCollaborationIdNamespaceAssociationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list id namespace within a collaboration", + "smithy.api#documentation": "Returns a list of the ID namespace associations in a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/idnamespaceassociations" + }, + "smithy.api#paginated": { + "items": "collaborationIdNamespaceAssociationSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListCollaborationIdNamespaceAssociationsInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the collaboration that contains the ID namespace associations that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.>
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#ListCollaborationIdNamespaceAssociationsOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "The token value provided to access the next page of results.
" + } + }, + "collaborationIdNamespaceAssociationSummaries": { + "target": "com.amazonaws.cleanrooms#CollaborationIdNamespaceAssociationSummaryList", + "traits": { + "smithy.api#documentation": "The summary information of the collaboration ID namespace associations that you requested.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetTemplates": { "type": "operation", "input": { @@ -7302,10 +9518,167 @@ "com.amazonaws.cleanrooms#ListConfiguredTableAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsInput" + "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list available configured table associations for a membership", + "smithy.api#documentation": "Lists configured table associations for a membership.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations" + }, + "smithy.api#paginated": { + "items": "configuredTableAssociationSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership to list configured table associations for.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsOutput": { + "type": "structure", + "members": { + "configuredTableAssociationSummaries": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummaryList", + "traits": { + "smithy.api#documentation": "The retrieved list of configured table associations.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" + } + } + } + }, + "com.amazonaws.cleanrooms#ListConfiguredTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListConfiguredTablesInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListConfiguredTablesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list available configured tables", + "smithy.api#documentation": "Lists configured tables.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configuredTables" + }, + "smithy.api#paginated": { + "items": "configuredTableSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListConfiguredTablesInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.cleanrooms#ListConfiguredTablesOutput": { + "type": "structure", + "members": { + "configuredTableSummaries": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableSummaryList", + "traits": { + "smithy.api#documentation": "The configured tables listed by the request.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" + } + } + } + }, + "com.amazonaws.cleanrooms#ListIdMappingTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListIdMappingTablesInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsOutput" + "target": "com.amazonaws.cleanrooms#ListIdMappingTablesOutput" }, "errors": [ { @@ -7325,26 +9698,29 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list available configured table associations for a membership", - "smithy.api#documentation": "Lists configured table associations for a membership.
", + "aws.iam#actionPermissionDescription": "Grants permission to list available id mapping tables for a membership", + "smithy.api#documentation": "Returns a list of ID mapping tables.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations" + "uri": "/memberships/{membershipIdentifier}/idmappingtables" }, "smithy.api#paginated": { - "items": "configuredTableAssociationSummaries" + "items": "idMappingTableSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsInput": { + "com.amazonaws.cleanrooms#ListIdMappingTablesInput": { "type": "structure", "members": { "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the membership to list configured table associations for.\n Currently accepts the membership ID.
", + "smithy.api#documentation": "The unique identifier of the membership that contains the ID mapping tables that you want to view.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7352,44 +9728,50 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsOutput": { + "com.amazonaws.cleanrooms#ListIdMappingTablesOutput": { "type": "structure", "members": { - "configuredTableAssociationSummaries": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummaryList", + "idMappingTableSummaries": { + "target": "com.amazonaws.cleanrooms#IdMappingTableSummaryList", "traits": { - "smithy.api#documentation": "The retrieved list of configured table associations.
", + "smithy.api#documentation": "The summary information of the ID mapping tables that you requested.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" + "smithy.api#documentation": "The token value provided to access the next page of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cleanrooms#ListConfiguredTables": { + "com.amazonaws.cleanrooms#ListIdNamespaceAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTablesInput" + "target": "com.amazonaws.cleanrooms#ListIdNamespaceAssociationsInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTablesOutput" + "target": "com.amazonaws.cleanrooms#ListIdNamespaceAssociationsOutput" }, "errors": [ { @@ -7398,6 +9780,9 @@ { "target": "com.amazonaws.cleanrooms#InternalServerException" }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, { "target": "com.amazonaws.cleanrooms#ThrottlingException" }, @@ -7406,54 +9791,71 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list available configured tables", - "smithy.api#documentation": "Lists configured tables.
", + "aws.iam#actionPermissionDescription": "Grants permission to list entity resolution data associations for a membership", + "smithy.api#documentation": "Returns a list of ID namespace associations.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/configuredTables" + "uri": "/memberships/{membershipIdentifier}/idnamespaceassociations" }, "smithy.api#paginated": { - "items": "configuredTableSummaries" + "items": "idNamespaceAssociationSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#ListConfiguredTablesInput": { + "com.amazonaws.cleanrooms#ListIdNamespaceAssociationsInput": { "type": "structure", "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership that contains the ID namespace association that you want to view.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#documentation": "The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#ListConfiguredTablesOutput": { + "com.amazonaws.cleanrooms#ListIdNamespaceAssociationsOutput": { "type": "structure", "members": { - "configuredTableSummaries": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableSummaryList", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The configured tables listed by the request.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token value provided to access the next page of results.
" } }, - "nextToken": { - "target": "com.amazonaws.cleanrooms#PaginationToken", + "idNamespaceAssociationSummaries": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationSummaryList", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" + "smithy.api#documentation": "The summary information of the ID namespace associations that you requested.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cleanrooms#ListMembers": { @@ -8131,7 +10533,7 @@ "paymentConfiguration": { "target": "com.amazonaws.cleanrooms#PaymentConfiguration", "traits": { - "smithy.api#documentation": "The collaboration\n member's payment responsibilities set by the collaboration creator.\n
\nIf the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.
" + "smithy.api#documentation": "The collaboration member's payment responsibilities set by the collaboration creator.
\nIf the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.
" } } }, @@ -8176,7 +10578,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MemberStatus", "traits": { - "smithy.api#documentation": "The status of the member.\n
", + "smithy.api#documentation": "The status of the member.
", "smithy.api#required": {} } }, @@ -8223,7 +10625,7 @@ "paymentConfiguration": { "target": "com.amazonaws.cleanrooms#PaymentConfiguration", "traits": { - "smithy.api#documentation": "The collaboration\n member's payment responsibilities set by the collaboration creator.\n
", + "smithy.api#documentation": "The collaboration member's payment responsibilities set by the collaboration creator.
", "smithy.api#required": {} } } @@ -8308,7 +10710,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MembershipStatus", "traits": { - "smithy.api#documentation": "The status of the\n membership.
", + "smithy.api#documentation": "The status of the membership.
", "smithy.api#required": {} } }, @@ -8335,7 +10737,7 @@ "paymentConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", "traits": { - "smithy.api#documentation": "The payment\n responsibilities accepted by the collaboration member.
", + "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member.
", "smithy.api#required": {} } } @@ -8369,13 +10771,13 @@ "queryCompute": { "target": "com.amazonaws.cleanrooms#MembershipQueryComputePaymentConfig", "traits": { - "smithy.api#documentation": "The payment\n responsibilities accepted by the collaboration member for query compute\n costs.
", + "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member for query compute\n costs.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "An object\n representing the payment responsibilities accepted by the collaboration\n member.
" + "smithy.api#documentation": "An object representing the payment responsibilities accepted by the collaboration\n member.
" } }, "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration": { @@ -8416,13 +10818,13 @@ "isResponsible": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether\n the collaboration member has accepted to pay for query compute costs (TRUE
) or\n has not accepted to pay for query compute costs\n (FALSE
).
If the collaboration creator has not specified anyone to pay for query compute costs,\n then the member who can query is the default payer.
\nAn error message is returned for the following reasons:
\nIf you set the value to FALSE
but you are responsible to pay for\n query compute costs.
If you set the value to TRUE
but you are not responsible to pay for\n query compute costs.
Indicates whether the collaboration member has accepted to pay for query compute costs\n (TRUE
) or has not accepted to pay for query compute costs\n (FALSE
).
If the collaboration creator has not specified anyone to pay for query compute costs,\n then the member who can query is the default payer.
\nAn error message is returned for the following reasons:
\nIf you set the value to FALSE
but you are responsible to pay for\n query compute costs.
If you set the value to TRUE
but you are not responsible to pay for\n query compute costs.
An object\n representing the payment responsibilities accepted by the collaboration member for query\n compute costs.
" + "smithy.api#documentation": "An object representing the payment responsibilities accepted by the collaboration member\n for query compute costs.
" } }, "com.amazonaws.cleanrooms#MembershipQueryLogStatus": { @@ -8582,7 +10984,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MembershipStatus", "traits": { - "smithy.api#documentation": "The status of the\n membership.
", + "smithy.api#documentation": "The status of the membership.
", "smithy.api#required": {} } }, @@ -8596,7 +10998,7 @@ "paymentConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", "traits": { - "smithy.api#documentation": "The payment\n responsibilities accepted by the collaboration member.
", + "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member.
", "smithy.api#required": {} } } @@ -8748,13 +11150,92 @@ "queryCompute": { "target": "com.amazonaws.cleanrooms#QueryComputePaymentConfig", "traits": { - "smithy.api#documentation": "The collaboration\n member's payment responsibilities set by the collaboration creator for query compute\n costs.
", + "smithy.api#documentation": "The collaboration member's payment responsibilities set by the collaboration creator for\n query compute costs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the collaboration member's payment responsibilities set by the\n collaboration creator.
" + } + }, + "com.amazonaws.cleanrooms#PopulateIdMappingTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#PopulateIdMappingTableInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#PopulateIdMappingTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to link an id mapping workflow with a collaboration by creating a new table", + "smithy.api#documentation": "Defines the information that's necessary to populate an ID mapping table.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}/populate" + } + } + }, + "com.amazonaws.cleanrooms#PopulateIdMappingTableInput": { + "type": "structure", + "members": { + "idMappingTableIdentifier": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID mapping table that you want to populate.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdMappingTableId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership that contains the ID mapping table that you want to populate.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#PopulateIdMappingTableOutput": { + "type": "structure", + "members": { + "idMappingJobId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the mapping job that will populate the ID mapping table.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "An object\n representing the collaboration member's payment responsibilities set by the collaboration\n creator.
" + "smithy.api#output": {} } }, "com.amazonaws.cleanrooms#PreviewPrivacyImpact": { @@ -9026,7 +11507,7 @@ "parameters": { "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateParametersOutput", "traits": { - "smithy.api#documentation": "Specifies the epislon and noise parameters for the privacy budget template.
", + "smithy.api#documentation": "Specifies the\n epsilon\n and noise parameters for the privacy budget template.
", "smithy.api#required": {} } } @@ -9363,6 +11844,21 @@ "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, + "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputConfiguration": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "The\n unique identifier for the account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configuration details for the protected query member output.
" + } + }, "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputList": { "type": "list", "member": { @@ -9395,7 +11891,13 @@ "s3": { "target": "com.amazonaws.cleanrooms#ProtectedQueryS3OutputConfiguration", "traits": { - "smithy.api#documentation": "Required configuration for a protected query with an `S3` output type.
" + "smithy.api#documentation": "Required configuration for a protected query with an\n s3
\n output type.
Required configuration for a protected query with a member
output type.
The query string to be submitted.
", "smithy.api#length": { - "max": 90000 + "max": 500000 } } }, @@ -9532,7 +12034,7 @@ "totalDurationInMillis": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "The duration of the Protected Query, from creation until query completion.
" + "smithy.api#documentation": "The duration of the protected query, from creation until query completion.
" } } }, @@ -9613,6 +12115,14 @@ "smithy.api#documentation": "The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`,\n `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.
", "smithy.api#required": {} } + }, + "receiverConfigurations": { + "target": "com.amazonaws.cleanrooms#ReceiverConfigurationsList", + "traits": { + "smithy.api#default": [], + "smithy.api#documentation": "The receiver configuration.
", + "smithy.api#required": {} + } } }, "traits": { @@ -9642,13 +12152,52 @@ "isResponsible": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether\n the collaboration creator has configured the collaboration member to pay for query compute\n costs (TRUE
) or has not configured the collaboration member to pay for query\n compute costs (FALSE
).
Exactly one member can be configured to pay for query compute costs. An error is\n returned if the collaboration creator sets a TRUE
value for more than one\n member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer. An error is returned if\n the collaboration creator sets a FALSE
value for the member who can\n query.
Indicates whether the collaboration creator has configured the collaboration member to\n pay for query compute costs (TRUE
) or has not configured the collaboration\n member to pay for query compute costs (FALSE
).
Exactly one member can be configured to pay for query compute costs. An error is\n returned if the collaboration creator sets a TRUE
value for more than one\n member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer. An error is returned if\n the collaboration creator sets a FALSE
value for the member who can\n query.
An object\n representing the collaboration member's payment responsibilities set by the collaboration\n creator for query compute costs.
" + "smithy.api#documentation": "An object representing the collaboration member's payment responsibilities set by the\n collaboration creator for query compute costs.
" + } + }, + "com.amazonaws.cleanrooms#QueryConstraint": { + "type": "union", + "members": { + "requireOverlap": { + "target": "com.amazonaws.cleanrooms#QueryConstraintRequireOverlap", + "traits": { + "smithy.api#documentation": "An array of column names that specifies which columns are required in the JOIN statement.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides any necessary query constraint information.
" + } + }, + "com.amazonaws.cleanrooms#QueryConstraintList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#QueryConstraint" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.cleanrooms#QueryConstraintRequireOverlap": { + "type": "structure", + "members": { + "columns": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnList", + "traits": { + "smithy.api#documentation": "The columns that are required to overlap.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the name of the columns that are required to overlap.
" } }, "com.amazonaws.cleanrooms#QueryTables": { @@ -9657,6 +12206,39 @@ "target": "com.amazonaws.cleanrooms#TableAlias" } }, + "com.amazonaws.cleanrooms#ReceiverAccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AccountId" + } + }, + "com.amazonaws.cleanrooms#ReceiverConfiguration": { + "type": "structure", + "members": { + "analysisType": { + "target": "com.amazonaws.cleanrooms#AnalysisType", + "traits": { + "smithy.api#documentation": " The type of analysis for the protected query. The results of the query can be analyzed directly (DIRECT_ANALYSIS
) or used as input into additional analyses (ADDITIONAL_ANALYSIS
), such as a query that is a seed for a lookalike ML model.
The configuration details of the receiver configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The receiver configuration for a protected query.
" + } + }, + "com.amazonaws.cleanrooms#ReceiverConfigurationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ReceiverConfiguration" + } + }, "com.amazonaws.cleanrooms#ResourceAlias": { "type": "string", "traits": { @@ -9955,6 +12537,12 @@ "smithy.api#documentation": "Details about the status of the schema. Currently, only one entry is present.
", "smithy.api#required": {} } + }, + "schemaTypeProperties": { + "target": "com.amazonaws.cleanrooms#SchemaTypeProperties", + "traits": { + "smithy.api#documentation": "The schema type properties.
" + } } }, "traits": { @@ -10057,7 +12645,7 @@ "status": { "target": "com.amazonaws.cleanrooms#SchemaStatus", "traits": { - "smithy.api#documentation": "The status of the schema.
", + "smithy.api#documentation": "The status of the schema, indicating if it is ready to query.
", "smithy.api#required": {} } }, @@ -10078,6 +12666,14 @@ "traits": { "smithy.api#documentation": "The configuration details of the schema analysis rule for the given type.
" } + }, + "analysisType": { + "target": "com.amazonaws.cleanrooms#AnalysisType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The type of analysis that can be performed on the schema.
\nA schema can have an analysisType
of DIRECT_ANALYSIS
, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION
, or both.
An explanation of the schema status reason code.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reason why the schema status is set to its current value.
" + } + }, + "com.amazonaws.cleanrooms#SchemaStatusReasonCode": { + "type": "enum", + "members": { + "ANALYSIS_RULE_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYSIS_RULE_MISSING" + } + }, + "ANALYSIS_TEMPLATES_NOT_CONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYSIS_TEMPLATES_NOT_CONFIGURED" + } + }, + "ANALYSIS_PROVIDERS_NOT_CONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYSIS_PROVIDERS_NOT_CONFIGURED" + } + }, + "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED" + } + }, + "ID_MAPPING_TABLE_NOT_POPULATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID_MAPPING_TABLE_NOT_POPULATED" + } + }, + "COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED" + } + }, + "ADDITIONAL_ANALYSES_NOT_CONFIGURED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "An explanation of the schema status reason code.
", - "smithy.api#required": {} + "smithy.api#enumValue": "ADDITIONAL_ANALYSES_NOT_CONFIGURED" } - } - }, - "traits": { - "smithy.api#documentation": "A reason why the schema status is set to its current value.
" - } - }, - "com.amazonaws.cleanrooms#SchemaStatusReasonCode": { - "type": "enum", - "members": { - "ANALYSIS_RULE_MISSING": { + }, + "RESULT_RECEIVERS_NOT_CONFIGURED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ANALYSIS_RULE_MISSING" + "smithy.api#enumValue": "RESULT_RECEIVERS_NOT_CONFIGURED" } }, - "ANALYSIS_TEMPLATES_NOT_CONFIGURED": { + "ADDITIONAL_ANALYSES_NOT_ALLOWED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ANALYSIS_TEMPLATES_NOT_CONFIGURED" + "smithy.api#enumValue": "ADDITIONAL_ANALYSES_NOT_ALLOWED" } }, - "ANALYSIS_PROVIDERS_NOT_CONFIGURED": { + "RESULT_RECEIVERS_NOT_ALLOWED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ANALYSIS_PROVIDERS_NOT_CONFIGURED" + "smithy.api#enumValue": "RESULT_RECEIVERS_NOT_ALLOWED" } }, - "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED": { + "ANALYSIS_RULE_TYPES_NOT_COMPATIBLE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED" + "smithy.api#enumValue": "ANALYSIS_RULE_TYPES_NOT_COMPATIBLE" } } } @@ -10232,7 +12870,27 @@ "traits": { "smithy.api#enumValue": "TABLE" } + }, + "ID_MAPPING_TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID_MAPPING_TABLE" + } + } + } + }, + "com.amazonaws.cleanrooms#SchemaTypeProperties": { + "type": "union", + "members": { + "idMappingTable": { + "target": "com.amazonaws.cleanrooms#IdMappingTableSchemaTypeProperties", + "traits": { + "smithy.api#documentation": "The ID mapping table for the schema type properties.
" + } } + }, + "traits": { + "smithy.api#documentation": "Information about the schema type properties.
" } }, "com.amazonaws.cleanrooms#ServiceQuotaExceededException": { @@ -10977,6 +13635,102 @@ } } }, + "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRuleInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update analysis rules for a configured table association" + }, + "smithy.api#documentation": "\n Updates\n the analysis rule for a configured table association.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}" + } + } + }, + "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRuleInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for the configured table association to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", + "traits": { + "smithy.api#documentation": "The analysis rule type\n that\n you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "analysisRulePolicy": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy", + "traits": { + "smithy.api#documentation": "\n The\n updated analysis rule policy for the configured table association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociationAnalysisRuleOutput": { + "type": "structure", + "members": { + "analysisRule": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", + "traits": { + "smithy.api#documentation": "\n The\n updated analysis rule for the configured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule
is referred to as the\n collaboration analysis rule.
Provides the details that are necessary to update an ID mapping table.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}" + } + } + }, + "com.amazonaws.cleanrooms#UpdateIdMappingTableInput": { + "type": "structure", + "members": { + "idMappingTableIdentifier": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID mapping table that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdMappingTableId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership that contains the ID mapping table that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "A new description for the ID mapping table.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanrooms#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#UpdateIdMappingTableOutput": { + "type": "structure", + "members": { + "idMappingTable": { + "target": "com.amazonaws.cleanrooms#IdMappingTable", + "traits": { + "smithy.api#documentation": "The updated ID mapping table.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#UpdateIdNamespaceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#UpdateIdNamespaceAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#UpdateIdNamespaceAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to update a entity resolution input association", + "smithy.api#documentation": "Provides the details that are necessary to update an ID namespace association.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/idnamespaceassociations/{idNamespaceAssociationIdentifier}" + } + } + }, + "com.amazonaws.cleanrooms#UpdateIdNamespaceAssociationInput": { + "type": "structure", + "members": { + "idNamespaceAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the ID namespace association that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "IdNamespaceAssociationId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the membership that contains the ID namespace association that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#GenericResourceName", + "traits": { + "smithy.api#documentation": "A new name for the ID namespace association.
" + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "A new description for the ID namespace association.
" + } + }, + "idMappingConfig": { + "target": "com.amazonaws.cleanrooms#IdMappingConfig", + "traits": { + "smithy.api#documentation": "The configuration settings for the ID mapping table.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#UpdateIdNamespaceAssociationOutput": { + "type": "structure", + "members": { + "idNamespaceAssociation": { + "target": "com.amazonaws.cleanrooms#IdNamespaceAssociation", + "traits": { + "smithy.api#documentation": "The updated ID namespace association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#UpdateMembership": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/cleanroomsml.json b/codegen/sdk-codegen/aws-models/cleanroomsml.json index 9c875360126..aba430385fb 100644 --- a/codegen/sdk-codegen/aws-models/cleanroomsml.json +++ b/codegen/sdk-codegen/aws-models/cleanroomsml.json @@ -755,6 +755,16 @@ "smithy.api#pattern": "^[0-9]{12}$" } }, + "com.amazonaws.cleanroomsml#AnalysisTemplateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+$" + } + }, "com.amazonaws.cleanroomsml#AudienceDestination": { "type": "structure", "members": { @@ -951,16 +961,21 @@ "dataSource": { "target": "com.amazonaws.cleanroomsml#S3ConfigMap", "traits": { - "smithy.api#documentation": "Defines the Amazon S3 bucket where the seed audience for the generating audience is stored. A valid data source is a JSON line file in the following format:
\n\n {\"user_id\": \"111111\"}
\n
\n {\"user_id\": \"222222\"}
\n
\n ...
\n
Defines the Amazon S3 bucket where the seed audience for the generating audience is stored. A valid data source is a JSON line file in the following format:
\n\n {\"user_id\": \"111111\"}
\n
\n {\"user_id\": \"222222\"}
\n
\n ...
\n
The ARN of the IAM role that can read the Amazon S3 bucket where the training data is stored.
", + "smithy.api#documentation": "The ARN of the IAM role that can read the Amazon S3 bucket where the seed audience is stored.
", "smithy.api#required": {} } + }, + "sqlParameters": { + "target": "com.amazonaws.cleanroomsml#ProtectedQuerySQLParameters", + "traits": { + "smithy.api#documentation": "The protected SQL query parameters.
" + } } }, "traits": { @@ -1316,7 +1331,7 @@ } }, "traits": { - "smithy.api#documentation": "Configure the list of audience output sizes that can be created. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize
selected from this list. You can use the ABSOLUTE
\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage
\n AudienceSize to configure sizes in the range 1-100 percent.
Returns the relevance scores at these audience sizes when used in the GetAudienceGenerationJob for a specified audience generation job and configured audience model.
\nSpecifies the list of allowed audienceSize
values when used in the StartAudienceExportJob for an audience generation job. You can use the ABSOLUTE
\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage
\n AudienceSize to configure sizes in the range 1-100 percent.
The tags that are associated to this audience generation job.
" } + }, + "protectedQueryIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the protected query for this audience generation job.
" + } } }, "traits": { @@ -3440,6 +3461,34 @@ } } }, + "com.amazonaws.cleanroomsml#ParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_]+$" + } + }, + "com.amazonaws.cleanroomsml#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cleanroomsml#ParameterKey" + }, + "value": { + "target": "com.amazonaws.cleanroomsml#ParameterValue" + } + }, + "com.amazonaws.cleanroomsml#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, "com.amazonaws.cleanroomsml#PolicyExistenceCondition": { "type": "enum", "members": { @@ -3457,6 +3506,36 @@ } } }, + "com.amazonaws.cleanroomsml#ProtectedQuerySQLParameters": { + "type": "structure", + "members": { + "queryString": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The query string to be submitted.
", + "smithy.api#length": { + "max": 90000 + } + } + }, + "analysisTemplateArn": { + "target": "com.amazonaws.cleanroomsml#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.
" + } + }, + "parameters": { + "target": "com.amazonaws.cleanroomsml#ParameterMap", + "traits": { + "smithy.api#documentation": "The protected query SQL parameters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The parameters for the SQL type Protected Query.
", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicy": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/codecommit.json b/codegen/sdk-codegen/aws-models/codecommit.json index 8edd4f8bc9d..18e1a10841d 100644 --- a/codegen/sdk-codegen/aws-models/codecommit.json +++ b/codegen/sdk-codegen/aws-models/codecommit.json @@ -4174,6 +4174,9 @@ { "target": "com.amazonaws.codecommit#InvalidTagsMapException" }, + { + "target": "com.amazonaws.codecommit#OperationNotAllowedException" + }, { "target": "com.amazonaws.codecommit#RepositoryLimitExceededException" }, @@ -4219,7 +4222,7 @@ "kmsKeyId": { "target": "com.amazonaws.codecommit#KmsKeyId", "traits": { - "smithy.api#documentation": "The ID of the encryption key. You can view the ID of an encryption key in the KMS console, or use the KMS APIs to\n programmatically retrieve a key ID. For more information about acceptable values for kmsKeyID, see \n KeyId in the Decrypt API description in \n the Key Management Service API Reference.
\nIf no key is specified, the default aws/codecommit
Amazon Web Services managed key is used.
The ID of the encryption key. You can view the ID of an encryption key in the KMS console, or use the KMS APIs to\n programmatically retrieve a key ID. For more information about acceptable values for kmsKeyID, see \n KeyId in the Decrypt API description in \n the Key Management Service API Reference.
\nIf no key is specified, the default aws/codecommit
Amazon Web Services managed key is used.
Information about the type of an object in a merge operation.
" } }, + "com.amazonaws.codecommit#OperationNotAllowedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codecommit#Message", + "traits": { + "smithy.api#documentation": "Any message associated with the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The requested action is not allowed.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.codecommit#OrderEnum": { "type": "enum", "members": { @@ -15511,7 +15529,7 @@ "kmsKeyId": { "target": "com.amazonaws.codecommit#KmsKeyId", "traits": { - "smithy.api#documentation": "The ID of the encryption key. You can view the ID of an encryption key in the KMS console, or use the KMS APIs to\n programmatically retrieve a key ID. For more information about acceptable values for keyID, see \n KeyId in the Decrypt API description in \n the Key Management Service API Reference.
", + "smithy.api#documentation": "The ID of the encryption key. You can view the ID of an encryption key in the KMS console, or use the KMS APIs to\n programmatically retrieve a key ID. For more information about acceptable values for keyID, see \n KeyId in the Decrypt API description in \n the Key Management Service API Reference.
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/codestar.json b/codegen/sdk-codegen/aws-models/codestar.json deleted file mode 100644 index ca9271136ac..00000000000 --- a/codegen/sdk-codegen/aws-models/codestar.json +++ /dev/null @@ -1,3102 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.codestar#AssociateTeamMember": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#AssociateTeamMemberRequest" - }, - "output": { - "target": "com.amazonaws.codestar#AssociateTeamMemberResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.codestar#InvalidServiceRoleException" - }, - { - "target": "com.amazonaws.codestar#LimitExceededException" - }, - { - "target": "com.amazonaws.codestar#ProjectConfigurationException" - }, - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#TeamMemberAlreadyAssociatedException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Adds an IAM user to the team for an AWS CodeStar project.
" - } - }, - "com.amazonaws.codestar#AssociateTeamMemberRequest": { - "type": "structure", - "members": { - "projectId": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project to which you will add the IAM user.
", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.codestar#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A user- or system-generated token that identifies the entity that requested the team\n member association to the project. This token can be used to repeat the request.
" - } - }, - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar\n project.
", - "smithy.api#required": {} - } - }, - "projectRole": { - "target": "com.amazonaws.codestar#Role", - "traits": { - "smithy.api#documentation": "The AWS CodeStar project role that will apply to this user. This role determines what actions\n a user can take in an AWS CodeStar project.
", - "smithy.api#required": {} - } - }, - "remoteAccessAllowed": { - "target": "com.amazonaws.codestar#RemoteAccessAllowed", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "Whether the team member is allowed to use an SSH public/private key pair to remotely\n access project resources, for example Amazon EC2 instances.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#AssociateTeamMemberResult": { - "type": "structure", - "members": { - "clientRequestToken": { - "target": "com.amazonaws.codestar#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The user- or system-generated token from the initial request that can be used to repeat\n the request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#BucketKey": { - "type": "string" - }, - "com.amazonaws.codestar#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - } - } - }, - "com.amazonaws.codestar#ClientRequestToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[\\w:/-]+$" - } - }, - "com.amazonaws.codestar#Code": { - "type": "structure", - "members": { - "source": { - "target": "com.amazonaws.codestar#CodeSource", - "traits": { - "smithy.api#documentation": "The location where the source code files provided with the project request are\n stored. AWS CodeStar retrieves the files during project creation.
", - "smithy.api#required": {} - } - }, - "destination": { - "target": "com.amazonaws.codestar#CodeDestination", - "traits": { - "smithy.api#documentation": "The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the\n source code files provided with the project request are placed in the repository.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Location and destination information about the source code files provided with the\n project request. The source code is uploaded to the new project source repository after\n project creation.
" - } - }, - "com.amazonaws.codestar#CodeCommitCodeDestination": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.codestar#RepositoryName", - "traits": { - "smithy.api#documentation": "The name of the AWS CodeCommit repository to be created in AWS CodeStar.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided\n with the project request will be uploaded after project creation.
" - } - }, - "com.amazonaws.codestar#CodeDestination": { - "type": "structure", - "members": { - "codeCommit": { - "target": "com.amazonaws.codestar#CodeCommitCodeDestination", - "traits": { - "smithy.api#documentation": "Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided\n with the project request will be uploaded after project creation.
" - } - }, - "gitHub": { - "target": "com.amazonaws.codestar#GitHubCodeDestination", - "traits": { - "smithy.api#documentation": "Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the\n project request will be uploaded after project creation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the\n source code files provided with the project request are placed in the repository.
" - } - }, - "com.amazonaws.codestar#CodeSource": { - "type": "structure", - "members": { - "s3": { - "target": "com.amazonaws.codestar#S3Location", - "traits": { - "smithy.api#documentation": "Information about the Amazon S3 location where the source code files provided with the\n project request are stored.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The location where the source code files provided with the project request are\n stored. AWS CodeStar retrieves the files during project creation.
" - } - }, - "com.amazonaws.codestar#CodeStar_20170419": { - "type": "service", - "version": "2017-04-19", - "operations": [ - { - "target": "com.amazonaws.codestar#AssociateTeamMember" - }, - { - "target": "com.amazonaws.codestar#CreateProject" - }, - { - "target": "com.amazonaws.codestar#CreateUserProfile" - }, - { - "target": "com.amazonaws.codestar#DeleteProject" - }, - { - "target": "com.amazonaws.codestar#DeleteUserProfile" - }, - { - "target": "com.amazonaws.codestar#DescribeProject" - }, - { - "target": "com.amazonaws.codestar#DescribeUserProfile" - }, - { - "target": "com.amazonaws.codestar#DisassociateTeamMember" - }, - { - "target": "com.amazonaws.codestar#ListProjects" - }, - { - "target": "com.amazonaws.codestar#ListResources" - }, - { - "target": "com.amazonaws.codestar#ListTagsForProject" - }, - { - "target": "com.amazonaws.codestar#ListTeamMembers" - }, - { - "target": "com.amazonaws.codestar#ListUserProfiles" - }, - { - "target": "com.amazonaws.codestar#TagProject" - }, - { - "target": "com.amazonaws.codestar#UntagProject" - }, - { - "target": "com.amazonaws.codestar#UpdateProject" - }, - { - "target": "com.amazonaws.codestar#UpdateTeamMember" - }, - { - "target": "com.amazonaws.codestar#UpdateUserProfile" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "CodeStar", - "arnNamespace": "codestar", - "cloudFormationName": "CodeStar", - "cloudTrailEventSource": "codestar.amazonaws.com", - "endpointPrefix": "codestar" - }, - "aws.auth#sigv4": { - "name": "codestar" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "This is the API reference for AWS CodeStar. This reference provides descriptions of the\n operations and data types for the AWS CodeStar API along with usage examples.
\nYou can use the AWS CodeStar API to work with:
\nProjects and their resources, by calling the following:
\n\n DeleteProject
, which deletes a project.
\n DescribeProject
, which lists the attributes of a project.
\n ListProjects
, which lists all projects associated with your AWS\n account.
\n ListResources
, which lists the resources associated with a\n project.
\n ListTagsForProject
, which lists the tags associated with a\n project.
\n TagProject
, which adds tags to a project.
\n UntagProject
, which removes tags from a project.
\n UpdateProject
, which updates the attributes of a project.
Teams and team members, by calling the following:
\n\n AssociateTeamMember
, which adds an IAM user to the team for a\n project.
\n DisassociateTeamMember
, which removes an IAM user from the team for a\n project.
\n ListTeamMembers
, which lists all the IAM users in the team for a\n project, including their roles and attributes.
\n UpdateTeamMember
, which updates a team member's attributes in a\n project.
Users, by calling the following:
\n\n CreateUserProfile
, which creates a user profile that contains data\n associated with the user across all projects.
\n DeleteUserProfile
, which deletes all user profile information across\n all projects.
\n DescribeUserProfile
, which describes the profile of a user.
\n ListUserProfiles
, which lists all user profiles.
\n UpdateUserProfile
, which updates the profile for a user.
Another modification is being made. That modification must complete before you can make\n your change.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.codestar#CreateProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#CreateProjectRequest" - }, - "output": { - "target": "com.amazonaws.codestar#CreateProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.codestar#InvalidServiceRoleException" - }, - { - "target": "com.amazonaws.codestar#LimitExceededException" - }, - { - "target": "com.amazonaws.codestar#ProjectAlreadyExistsException" - }, - { - "target": "com.amazonaws.codestar#ProjectConfigurationException" - }, - { - "target": "com.amazonaws.codestar#ProjectCreationFailedException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a project, including project resources. This action creates a project based on\n a submitted project request. A set of source code files and a toolchain template file\n can be included with the project request. If these are not provided, an empty project is created.
" - } - }, - "com.amazonaws.codestar#CreateProjectRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.codestar#ProjectName", - "traits": { - "smithy.api#documentation": "The display name for the project to be created in AWS CodeStar.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project to be created in AWS CodeStar.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.codestar#ProjectDescription", - "traits": { - "smithy.api#documentation": "The description of the project, if any.
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.codestar#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A user- or system-generated token that identifies the entity that requested project\n creation. This token can be used to repeat the request.
" - } - }, - "sourceCode": { - "target": "com.amazonaws.codestar#SourceCode", - "traits": { - "smithy.api#documentation": "A list of the Code objects submitted with the project request. If this\n parameter is specified, the request must also include the toolchain parameter.
" - } - }, - "toolchain": { - "target": "com.amazonaws.codestar#Toolchain", - "traits": { - "smithy.api#documentation": "The name of the toolchain template file submitted with the project request. If\n this parameter is specified, the request must also include the sourceCode parameter.
" - } - }, - "tags": { - "target": "com.amazonaws.codestar#Tags", - "traits": { - "smithy.api#documentation": "The tags created for the project.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#CreateProjectResult": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.codestar#ProjectArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created project.
", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.codestar#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A user- or system-generated token that identifies the entity that requested project\n creation.
" - } - }, - "projectTemplateId": { - "target": "com.amazonaws.codestar#ProjectTemplateId", - "traits": { - "smithy.api#documentation": "Reserved for future use.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#CreateUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#CreateUserProfileRequest" - }, - "output": { - "target": "com.amazonaws.codestar#CreateUserProfileResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#UserProfileAlreadyExistsException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a profile for a user that includes user preferences, such as the display name\n and email address assocciated with the user, in AWS CodeStar. The user profile is not\n project-specific. Information in the user profile is displayed wherever the user's information\n appears to other users in AWS CodeStar.
" - } - }, - "com.amazonaws.codestar#CreateUserProfileRequest": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user in IAM.
", - "smithy.api#required": {} - } - }, - "displayName": { - "target": "com.amazonaws.codestar#UserProfileDisplayName", - "traits": { - "smithy.api#documentation": "The name that will be displayed as the friendly name for the user in AWS CodeStar.
", - "smithy.api#required": {} - } - }, - "emailAddress": { - "target": "com.amazonaws.codestar#Email", - "traits": { - "smithy.api#documentation": "The email address that will be displayed as part of the user's profile in\n AWS CodeStar.
", - "smithy.api#required": {} - } - }, - "sshPublicKey": { - "target": "com.amazonaws.codestar#SshPublicKey", - "traits": { - "smithy.api#documentation": "The SSH public key associated with the user in AWS CodeStar. If a project owner allows the\n user remote access to project resources, this public key will be used along with the user's\n private key for SSH access.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#CreateUserProfileResult": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user in IAM.
", - "smithy.api#required": {} - } - }, - "displayName": { - "target": "com.amazonaws.codestar#UserProfileDisplayName", - "traits": { - "smithy.api#documentation": "The name that is displayed as the friendly name for the user in AWS CodeStar.
" - } - }, - "emailAddress": { - "target": "com.amazonaws.codestar#Email", - "traits": { - "smithy.api#documentation": "The email address that is displayed as part of the user's profile in AWS CodeStar.
" - } - }, - "sshPublicKey": { - "target": "com.amazonaws.codestar#SshPublicKey", - "traits": { - "smithy.api#documentation": "The SSH public key associated with the user in AWS CodeStar. This is the public portion of the\n public/private keypair the user can use to access project resources if a project owner allows\n the user remote access to those resources.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.codestar#CreatedTimestamp", - "traits": { - "smithy.api#documentation": "The date the user profile was created, in timestamp format.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.codestar#LastModifiedTimestamp", - "traits": { - "smithy.api#documentation": "The date the user profile was last modified, in timestamp format.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#CreatedTimestamp": { - "type": "timestamp" - }, - "com.amazonaws.codestar#DeleteProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#DeleteProjectRequest" - }, - "output": { - "target": "com.amazonaws.codestar#DeleteProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.codestar#InvalidServiceRoleException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a project, including project resources. Does not delete users associated with\n the project, but does delete the IAM roles that allowed access to the project.
" - } - }, - "com.amazonaws.codestar#DeleteProjectRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project to be deleted in AWS CodeStar.
", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.codestar#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A user- or system-generated token that identifies the entity that requested project\n deletion. This token can be used to repeat the request.
" - } - }, - "deleteStack": { - "target": "com.amazonaws.codestar#DeleteStack", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Whether to send a delete request for the primary stack in AWS CloudFormation originally\n used to generate the project and its resources. This option will delete all AWS resources for\n the project (except for any buckets in Amazon S3) as well as deleting the project itself.\n Recommended for most use cases.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#DeleteProjectResult": { - "type": "structure", - "members": { - "stackId": { - "target": "com.amazonaws.codestar#StackId", - "traits": { - "smithy.api#documentation": "The ID of the primary stack in AWS CloudFormation that will be deleted as part of\n deleting the project and its resources.
" - } - }, - "projectArn": { - "target": "com.amazonaws.codestar#ProjectArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted project.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#DeleteStack": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.codestar#DeleteUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#DeleteUserProfileRequest" - }, - "output": { - "target": "com.amazonaws.codestar#DeleteUserProfileResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a user profile in AWS CodeStar, including all personal preference data associated with\n that profile, such as display name and email address. It does not delete the history of that\n user, for example the history of commits made by that user.
" - } - }, - "com.amazonaws.codestar#DeleteUserProfileRequest": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#DeleteUserProfileResult": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#DescribeProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#DescribeProjectRequest" - }, - "output": { - "target": "com.amazonaws.codestar#DescribeProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.codestar#InvalidServiceRoleException" - }, - { - "target": "com.amazonaws.codestar#ProjectConfigurationException" - }, - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Describes a project and its resources.
" - } - }, - "com.amazonaws.codestar#DescribeProjectRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#DescribeProjectResult": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.codestar#ProjectName", - "traits": { - "smithy.api#documentation": "The display name for the project.
" - } - }, - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project.
" - } - }, - "arn": { - "target": "com.amazonaws.codestar#ProjectArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the project.
" - } - }, - "description": { - "target": "com.amazonaws.codestar#ProjectDescription", - "traits": { - "smithy.api#documentation": "The description of the project, if any.
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.codestar#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A user- or system-generated token that identifies the entity that requested project\n creation.
" - } - }, - "createdTimeStamp": { - "target": "com.amazonaws.codestar#CreatedTimestamp", - "traits": { - "smithy.api#documentation": "The date and time the project was created, in timestamp format.
" - } - }, - "stackId": { - "target": "com.amazonaws.codestar#StackId", - "traits": { - "smithy.api#documentation": "The ID of the primary stack in AWS CloudFormation used to generate resources for the\n project.
" - } - }, - "projectTemplateId": { - "target": "com.amazonaws.codestar#ProjectTemplateId", - "traits": { - "smithy.api#documentation": "The ID for the AWS CodeStar project template used to create the project.
" - } - }, - "status": { - "target": "com.amazonaws.codestar#ProjectStatus", - "traits": { - "smithy.api#documentation": "The project creation or deletion status.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#DescribeUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#DescribeUserProfileRequest" - }, - "output": { - "target": "com.amazonaws.codestar#DescribeUserProfileResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#UserProfileNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Describes a user in AWS CodeStar and the user attributes across all projects.
" - } - }, - "com.amazonaws.codestar#DescribeUserProfileRequest": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#DescribeUserProfileResult": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user.
", - "smithy.api#required": {} - } - }, - "displayName": { - "target": "com.amazonaws.codestar#UserProfileDisplayName", - "traits": { - "smithy.api#documentation": "The display name shown for the user in AWS CodeStar projects. For example, this could be set\n to both first and last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also\n used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are\n included in the display name, the first character that appears after the space will be used as\n the second character in the user initial icon. The initial icon displays a maximum of two\n characters, so a display name with more than one space (for example \"Mary Jane Major\") would\n generate an initial icon using the first character and the first character after the space\n (\"MJ\", not \"MM\").
" - } - }, - "emailAddress": { - "target": "com.amazonaws.codestar#Email", - "traits": { - "smithy.api#documentation": "The email address for the user. Optional.
" - } - }, - "sshPublicKey": { - "target": "com.amazonaws.codestar#SshPublicKey", - "traits": { - "smithy.api#documentation": "The SSH public key associated with the user. This SSH public key is associated with the\n user profile, and can be used in conjunction with the associated private key for access to\n project resources, such as Amazon EC2 instances, if a project owner grants remote access to\n those resources.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.codestar#CreatedTimestamp", - "traits": { - "smithy.api#documentation": "The date and time when the user profile was created in AWS CodeStar, in timestamp\n format.
", - "smithy.api#required": {} - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.codestar#LastModifiedTimestamp", - "traits": { - "smithy.api#documentation": "The date and time when the user profile was last modified, in timestamp\n format.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#DisassociateTeamMember": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#DisassociateTeamMemberRequest" - }, - "output": { - "target": "com.amazonaws.codestar#DisassociateTeamMemberResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.codestar#InvalidServiceRoleException" - }, - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Removes a user from a project. Removing a user from a project also removes the IAM\n policies from that user that allowed access to the project and its resources. Disassociating a\n team member does not remove that user's profile from AWS CodeStar. It does not remove the user from\n IAM.
" - } - }, - "com.amazonaws.codestar#DisassociateTeamMemberRequest": { - "type": "structure", - "members": { - "projectId": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the AWS CodeStar project from which you want to remove a team member.
", - "smithy.api#required": {} - } - }, - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from\n the project.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#DisassociateTeamMemberResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#Email": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 128 - }, - "smithy.api#pattern": "^[\\w-.+]+@[\\w-.+]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.codestar#GitHubCodeDestination": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.codestar#RepositoryName", - "traits": { - "smithy.api#documentation": "Name of the GitHub repository to be created in AWS CodeStar.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.codestar#RepositoryDescription", - "traits": { - "smithy.api#documentation": "Description for the GitHub repository to be created in AWS CodeStar. This description displays in\n GitHub after the repository is created.
" - } - }, - "type": { - "target": "com.amazonaws.codestar#RepositoryType", - "traits": { - "smithy.api#documentation": "The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.
", - "smithy.api#required": {} - } - }, - "owner": { - "target": "com.amazonaws.codestar#RepositoryOwner", - "traits": { - "smithy.api#documentation": "The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should\n be owned by a GitHub organization, provide its name.
", - "smithy.api#required": {} - } - }, - "privateRepository": { - "target": "com.amazonaws.codestar#RepositoryIsPrivate", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Whether the GitHub repository is to be a private repository.
", - "smithy.api#required": {} - } - }, - "issuesEnabled": { - "target": "com.amazonaws.codestar#RepositoryEnableIssues", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Whether to enable issues for the GitHub repository.
", - "smithy.api#required": {} - } - }, - "token": { - "target": "com.amazonaws.codestar#GitHubPersonalToken", - "traits": { - "smithy.api#documentation": "The GitHub user's personal access token for the GitHub repository.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the\n project request will be uploaded after project creation.
" - } - }, - "com.amazonaws.codestar#GitHubPersonalToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.codestar#InvalidNextTokenException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "The next token is not valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.codestar#InvalidServiceRoleException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "The service role is not valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.codestar#LastModifiedTimestamp": { - "type": "timestamp" - }, - "com.amazonaws.codestar#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "A resource limit has been exceeded.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.codestar#ListProjects": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#ListProjectsRequest" - }, - "output": { - "target": "com.amazonaws.codestar#ListProjectsResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all projects in AWS CodeStar associated with your AWS account.
" - } - }, - "com.amazonaws.codestar#ListProjectsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "The continuation token to be used to return the next set of results, if the results\n cannot be returned in one response.
" - } - }, - "maxResults": { - "target": "com.amazonaws.codestar#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum amount of data that can be contained in a single set of results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#ListProjectsResult": { - "type": "structure", - "members": { - "projects": { - "target": "com.amazonaws.codestar#ProjectsList", - "traits": { - "smithy.api#documentation": "A list of projects.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "The continuation token to use when requesting the next set of results, if there are\n more results to be returned.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#ListResources": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#ListResourcesRequest" - }, - "output": { - "target": "com.amazonaws.codestar#ListResourcesResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists resources associated with a project in AWS CodeStar.
" - } - }, - "com.amazonaws.codestar#ListResourcesRequest": { - "type": "structure", - "members": { - "projectId": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "The continuation token for the next set of results, if the results cannot be returned\n in one response.
" - } - }, - "maxResults": { - "target": "com.amazonaws.codestar#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum amount of data that can be contained in a single set of results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#ListResourcesResult": { - "type": "structure", - "members": { - "resources": { - "target": "com.amazonaws.codestar#ResourcesResult", - "traits": { - "smithy.api#documentation": "An array of resources associated with the project.
" - } - }, - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "The continuation token to use when requesting the next set of results, if there are\n more results to be returned.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#ListTagsForProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#ListTagsForProjectRequest" - }, - "output": { - "target": "com.amazonaws.codestar#ListTagsForProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets the tags for a project.
" - } - }, - "com.amazonaws.codestar#ListTagsForProjectRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project to get tags for.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "Reserved for future use.
" - } - }, - "maxResults": { - "target": "com.amazonaws.codestar#MaxResults", - "traits": { - "smithy.api#documentation": "Reserved for future use.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#ListTagsForProjectResult": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.codestar#Tags", - "traits": { - "smithy.api#documentation": "The tags for the project.
" - } - }, - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "Reserved for future use.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#ListTeamMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#ListTeamMembersRequest" - }, - "output": { - "target": "com.amazonaws.codestar#ListTeamMembersResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all team members associated with a project.
" - } - }, - "com.amazonaws.codestar#ListTeamMembersRequest": { - "type": "structure", - "members": { - "projectId": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project for which you want to list team members.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "The continuation token for the next set of results, if the results cannot be returned\n in one response.
" - } - }, - "maxResults": { - "target": "com.amazonaws.codestar#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of team members you want returned in a response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#ListTeamMembersResult": { - "type": "structure", - "members": { - "teamMembers": { - "target": "com.amazonaws.codestar#TeamMemberResult", - "traits": { - "smithy.api#documentation": "A list of team member objects for the project.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "The continuation token to use when requesting the next set of results, if there are\n more results to be returned.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#ListUserProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#ListUserProfilesRequest" - }, - "output": { - "target": "com.amazonaws.codestar#ListUserProfilesResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all the user profiles configured for your AWS account in AWS CodeStar.
" - } - }, - "com.amazonaws.codestar#ListUserProfilesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "The continuation token for the next set of results, if the results cannot be returned\n in one response.
" - } - }, - "maxResults": { - "target": "com.amazonaws.codestar#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in a response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#ListUserProfilesResult": { - "type": "structure", - "members": { - "userProfiles": { - "target": "com.amazonaws.codestar#UserProfilesList", - "traits": { - "smithy.api#documentation": "All the user profiles configured in AWS CodeStar for an AWS account.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "The continuation token to use when requesting the next set of results, if there are\n more results to be returned.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.codestar#Message": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.codestar#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[\\w/+=]+$" - } - }, - "com.amazonaws.codestar#ProjectAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "An AWS CodeStar project with the same ID already exists in this region for the AWS account.\n AWS CodeStar project IDs must be unique within a region for the AWS account.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.codestar#ProjectArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:\\s]*:codestar:[^:\\s]+:[0-9]{12}:project\\/[a-z]([a-z0-9|-])+$" - } - }, - "com.amazonaws.codestar#ProjectConfigurationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "Project configuration information is required but not specified.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.codestar#ProjectCreationFailedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "The project creation request was valid, but a nonspecific exception or error occurred\n during project creation. The project could not be created in AWS CodeStar.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.codestar#ProjectDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^$|^\\S(.*\\S)?$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.codestar#ProjectId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 15 - }, - "smithy.api#pattern": "^[a-z][a-z0-9-]+$" - } - }, - "com.amazonaws.codestar#ProjectName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^\\S(.*\\S)?$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.codestar#ProjectNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "The specified AWS CodeStar project was not found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.codestar#ProjectStatus": { - "type": "structure", - "members": { - "state": { - "target": "com.amazonaws.codestar#State", - "traits": { - "smithy.api#documentation": "The phase of completion for a project creation or deletion.
", - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.codestar#Reason", - "traits": { - "smithy.api#documentation": "In the case of a project creation or deletion failure, a reason for the\n failure.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An indication of whether a project creation or deletion is failed or\n successful.
" - } - }, - "com.amazonaws.codestar#ProjectSummary": { - "type": "structure", - "members": { - "projectId": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project.
" - } - }, - "projectArn": { - "target": "com.amazonaws.codestar#ProjectArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the metadata for a project.
" - } - }, - "com.amazonaws.codestar#ProjectTemplateId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^arn:aws[^:\\s]{0,5}:codestar:[^:\\s]+::project-template(\\/(github|codecommit))?\\/[a-z0-9-]+$" - } - }, - "com.amazonaws.codestar#ProjectsList": { - "type": "list", - "member": { - "target": "com.amazonaws.codestar#ProjectSummary" - } - }, - "com.amazonaws.codestar#Reason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^$|^\\S(.*\\S)?$" - } - }, - "com.amazonaws.codestar#RemoteAccessAllowed": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.codestar#RepositoryDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^\\S(.*\\S)?$" - } - }, - "com.amazonaws.codestar#RepositoryEnableIssues": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.codestar#RepositoryIsPrivate": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.codestar#RepositoryName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^\\S[\\w.-]*$" - } - }, - "com.amazonaws.codestar#RepositoryOwner": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^\\S(.*\\S)?$" - } - }, - "com.amazonaws.codestar#RepositoryType": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(user|organization|User|Organization)$" - } - }, - "com.amazonaws.codestar#Resource": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.codestar#ResourceId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Information about a resource for a project.
" - } - }, - "com.amazonaws.codestar#ResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 11 - }, - "smithy.api#pattern": "^arn\\:aws\\:\\S.*\\:" - } - }, - "com.amazonaws.codestar#ResourcesResult": { - "type": "list", - "member": { - "target": "com.amazonaws.codestar#Resource" - } - }, - "com.amazonaws.codestar#Role": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(Owner|Viewer|Contributor)$" - } - }, - "com.amazonaws.codestar#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1224 - } - } - }, - "com.amazonaws.codestar#S3Location": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.codestar#BucketName", - "traits": { - "smithy.api#documentation": "The Amazon S3 bucket name where the source code files provided with the project\n request are stored.
" - } - }, - "bucketKey": { - "target": "com.amazonaws.codestar#BucketKey", - "traits": { - "smithy.api#documentation": "The Amazon S3 object key where the source code files provided with the project\n request are stored.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon S3 location where the source code files provided with the project\n request are stored.
" - } - }, - "com.amazonaws.codestar#SourceCode": { - "type": "list", - "member": { - "target": "com.amazonaws.codestar#Code" - } - }, - "com.amazonaws.codestar#SshPublicKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 16384 - }, - "smithy.api#pattern": "^[\\t\\r\\n\\u0020-\\u00FF]*$" - } - }, - "com.amazonaws.codestar#StackId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:\\s]*:cloudformation:[^:\\s]+:[0-9]{12}:stack\\/[^:\\s]+\\/[^:\\s]+$" - } - }, - "com.amazonaws.codestar#State": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(CreateInProgress|CreateComplete|CreateFailed|DeleteComplete|DeleteFailed|DeleteInProgress|UpdateComplete|UpdateInProgress|UpdateFailed|Unknown)$" - } - }, - "com.amazonaws.codestar#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.codestar#TagKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.codestar#TagKey" - } - }, - "com.amazonaws.codestar#TagProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#TagProjectRequest" - }, - "output": { - "target": "com.amazonaws.codestar#TagProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.codestar#LimitExceededException" - }, - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Adds tags to a project.
" - } - }, - "com.amazonaws.codestar#TagProjectRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project you want to add a tag to.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.codestar#Tags", - "traits": { - "smithy.api#documentation": "The tags you want to add to the project.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#TagProjectResult": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.codestar#Tags", - "traits": { - "smithy.api#documentation": "The tags for the project.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.codestar#Tags": { - "type": "map", - "key": { - "target": "com.amazonaws.codestar#TagKey" - }, - "value": { - "target": "com.amazonaws.codestar#TagValue" - } - }, - "com.amazonaws.codestar#TeamMember": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user in IAM.
", - "smithy.api#required": {} - } - }, - "projectRole": { - "target": "com.amazonaws.codestar#Role", - "traits": { - "smithy.api#documentation": "The role assigned to the user in the project. Project roles have different levels of\n access. For more information, see Working with\n Teams in the AWS CodeStar User Guide.
", - "smithy.api#required": {} - } - }, - "remoteAccessAllowed": { - "target": "com.amazonaws.codestar#RemoteAccessAllowed", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "Whether the user is allowed to remotely access project resources using an SSH\n public/private key pair.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about a team member in a project.
" - } - }, - "com.amazonaws.codestar#TeamMemberAlreadyAssociatedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "The team member is already associated with a role in this project.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.codestar#TeamMemberNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "The specified team member was not found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.codestar#TeamMemberResult": { - "type": "list", - "member": { - "target": "com.amazonaws.codestar#TeamMember" - } - }, - "com.amazonaws.codestar#TemplateParameterKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - }, - "smithy.api#pattern": "^\\S(.*\\S)?$" - } - }, - "com.amazonaws.codestar#TemplateParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.codestar#TemplateParameterKey" - }, - "value": { - "target": "com.amazonaws.codestar#TemplateParameterValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.codestar#TemplateParameterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^\\S(.*\\S)?$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.codestar#Toolchain": { - "type": "structure", - "members": { - "source": { - "target": "com.amazonaws.codestar#ToolchainSource", - "traits": { - "smithy.api#documentation": "The Amazon S3 location where the toolchain template file provided with the\n project request is stored. AWS CodeStar retrieves the file during project creation.
", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.codestar#RoleArn", - "traits": { - "smithy.api#documentation": "The service role ARN for AWS CodeStar to use for the toolchain template during stack\n provisioning.
" - } - }, - "stackParameters": { - "target": "com.amazonaws.codestar#TemplateParameterMap", - "traits": { - "smithy.api#documentation": "The list of parameter overrides to be passed into the toolchain template during stack\n provisioning, if any.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The toolchain template file provided with the project request. AWS CodeStar uses\n the template to provision the toolchain stack in AWS CloudFormation.
" - } - }, - "com.amazonaws.codestar#ToolchainSource": { - "type": "structure", - "members": { - "s3": { - "target": "com.amazonaws.codestar#S3Location", - "traits": { - "smithy.api#documentation": "The Amazon S3 bucket where the toolchain template file provided with the project\n request is stored.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon S3 location where the toolchain template file provided with the\n project request is stored. AWS CodeStar retrieves the file during project creation.
" - } - }, - "com.amazonaws.codestar#UntagProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#UntagProjectRequest" - }, - "output": { - "target": "com.amazonaws.codestar#UntagProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.codestar#LimitExceededException" - }, - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Removes tags from a project.
" - } - }, - "com.amazonaws.codestar#UntagProjectRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project to remove tags from.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.codestar#TagKeys", - "traits": { - "smithy.api#documentation": "The tags to remove from the project.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#UntagProjectResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#UpdateProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#UpdateProjectRequest" - }, - "output": { - "target": "com.amazonaws.codestar#UpdateProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a project in AWS CodeStar.
" - } - }, - "com.amazonaws.codestar#UpdateProjectRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project you want to update.
", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.codestar#ProjectName", - "traits": { - "smithy.api#documentation": "The name of the project you want to update.
" - } - }, - "description": { - "target": "com.amazonaws.codestar#ProjectDescription", - "traits": { - "smithy.api#documentation": "The description of the project, if any.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#UpdateProjectResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#UpdateTeamMember": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#UpdateTeamMemberRequest" - }, - "output": { - "target": "com.amazonaws.codestar#UpdateTeamMemberResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.codestar#InvalidServiceRoleException" - }, - { - "target": "com.amazonaws.codestar#LimitExceededException" - }, - { - "target": "com.amazonaws.codestar#ProjectConfigurationException" - }, - { - "target": "com.amazonaws.codestar#ProjectNotFoundException" - }, - { - "target": "com.amazonaws.codestar#TeamMemberNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a team member's attributes in an AWS CodeStar project. For example, you can change a\n team member's role in the project, or change whether they have remote access to project\n resources.
" - } - }, - "com.amazonaws.codestar#UpdateTeamMemberRequest": { - "type": "structure", - "members": { - "projectId": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project.
", - "smithy.api#required": {} - } - }, - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user for whom you want to change team membership\n attributes.
", - "smithy.api#required": {} - } - }, - "projectRole": { - "target": "com.amazonaws.codestar#Role", - "traits": { - "smithy.api#documentation": "The role assigned to the user in the project. Project roles have different levels of\n access. For more information, see Working with\n Teams in the AWS CodeStar User Guide.
" - } - }, - "remoteAccessAllowed": { - "target": "com.amazonaws.codestar#RemoteAccessAllowed", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "Whether a team member is allowed to remotely access project resources using the SSH\n public key associated with the user's profile. Even if this is set to True, the user must\n associate a public key with their profile before the user can access resources.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#UpdateTeamMemberResult": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user whose team membership attributes were\n updated.
" - } - }, - "projectRole": { - "target": "com.amazonaws.codestar#Role", - "traits": { - "smithy.api#documentation": "The project role granted to the user.
" - } - }, - "remoteAccessAllowed": { - "target": "com.amazonaws.codestar#RemoteAccessAllowed", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "Whether a team member is allowed to remotely access project resources using the SSH\n public key associated with the user's profile.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#UpdateUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.codestar#UpdateUserProfileRequest" - }, - "output": { - "target": "com.amazonaws.codestar#UpdateUserProfileResult" - }, - "errors": [ - { - "target": "com.amazonaws.codestar#UserProfileNotFoundException" - }, - { - "target": "com.amazonaws.codestar#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a user's profile in AWS CodeStar. The user profile is not project-specific.\n Information in the user profile is displayed wherever the user's information appears to other\n users in AWS CodeStar.
" - } - }, - "com.amazonaws.codestar#UpdateUserProfileRequest": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The name that will be displayed as the friendly name for the user in AWS\n CodeStar.
", - "smithy.api#required": {} - } - }, - "displayName": { - "target": "com.amazonaws.codestar#UserProfileDisplayName", - "traits": { - "smithy.api#documentation": "The name that is displayed as the friendly name for the user in AWS CodeStar.
" - } - }, - "emailAddress": { - "target": "com.amazonaws.codestar#Email", - "traits": { - "smithy.api#documentation": "The email address that is displayed as part of the user's profile in AWS\n CodeStar.
" - } - }, - "sshPublicKey": { - "target": "com.amazonaws.codestar#SshPublicKey", - "traits": { - "smithy.api#documentation": "The SSH public key associated with the user in AWS CodeStar. If a project owner allows the\n user remote access to project resources, this public key will be used along with the user's\n private key for SSH access.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codestar#UpdateUserProfileResult": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user in IAM.
", - "smithy.api#required": {} - } - }, - "displayName": { - "target": "com.amazonaws.codestar#UserProfileDisplayName", - "traits": { - "smithy.api#documentation": "The name that is displayed as the friendly name for the user in AWS CodeStar.
" - } - }, - "emailAddress": { - "target": "com.amazonaws.codestar#Email", - "traits": { - "smithy.api#documentation": "The email address that is displayed as part of the user's profile in AWS\n CodeStar.
" - } - }, - "sshPublicKey": { - "target": "com.amazonaws.codestar#SshPublicKey", - "traits": { - "smithy.api#documentation": "The SSH public key associated with the user in AWS CodeStar. This is the public portion of the\n public/private keypair the user can use to access project resources if a project owner allows\n the user remote access to those resources.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.codestar#CreatedTimestamp", - "traits": { - "smithy.api#documentation": "The date the user profile was created, in timestamp format.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.codestar#LastModifiedTimestamp", - "traits": { - "smithy.api#documentation": "The date the user profile was last modified, in timestamp format.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codestar#UserArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 95 - }, - "smithy.api#pattern": "^arn:aws:iam::\\d{12}:user(?:(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F))[\\w+=,.@-]+$" - } - }, - "com.amazonaws.codestar#UserProfileAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "A user profile with that name already exists in this region for the AWS account. AWS\n CodeStar user profile names must be unique within a region for the AWS account.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.codestar#UserProfileDisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^\\S(.*\\S)?$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.codestar#UserProfileNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "The user profile was not found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.codestar#UserProfileSummary": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user in IAM.
" - } - }, - "displayName": { - "target": "com.amazonaws.codestar#UserProfileDisplayName", - "traits": { - "smithy.api#documentation": "The display name of a user in AWS CodeStar. For example, this could be set to both first and\n last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also used to generate\n the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the\n display name, the first character that appears after the space will be used as the second\n character in the user initial icon. The initial icon displays a maximum of two characters, so\n a display name with more than one space (for example \"Mary Jane Major\") would generate an\n initial icon using the first character and the first character after the space (\"MJ\", not\n \"MM\").
" - } - }, - "emailAddress": { - "target": "com.amazonaws.codestar#Email", - "traits": { - "smithy.api#documentation": "The email address associated with the user.
" - } - }, - "sshPublicKey": { - "target": "com.amazonaws.codestar#SshPublicKey", - "traits": { - "smithy.api#documentation": "The SSH public key associated with the user in AWS CodeStar. If a project owner allows the\n user remote access to project resources, this public key will be used along with the user's\n private key for SSH access.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about a user's profile in AWS CodeStar.
" - } - }, - "com.amazonaws.codestar#UserProfilesList": { - "type": "list", - "member": { - "target": "com.amazonaws.codestar#UserProfileSummary" - } - }, - "com.amazonaws.codestar#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.codestar#Message" - } - }, - "traits": { - "smithy.api#documentation": "The specified input is either not valid, or it could not be validated.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - } - } -} diff --git a/codegen/sdk-codegen/aws-models/connect-contact-lens.json b/codegen/sdk-codegen/aws-models/connect-contact-lens.json index f26cec0a2c5..d696f32dc84 100644 --- a/codegen/sdk-codegen/aws-models/connect-contact-lens.json +++ b/codegen/sdk-codegen/aws-models/connect-contact-lens.json @@ -66,7 +66,7 @@ "name": "connect" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents,\n by using speech transcription, natural language processing, and intelligent search\n capabilities. It performs sentiment analysis, detects issues, and enables you to automatically\n categorize contacts.
\nContact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent\n conversations. For more information, see Analyze conversations using\n Contact Lens in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "\n Contact Lens actions\n
\nAmazon Connect Contact Lens enables you to analyze conversations between customer and agents, by using\n speech transcription, natural language processing, and intelligent search capabilities.\n It performs sentiment analysis, detects issues, and enables you to automatically\n categorize contacts.
\nAmazon Connect Contact Lens provides both real-time and post-call analytics of customer-agent\n conversations. For more information, see Analyze conversations\n using speech analytics in the Amazon Connect Administrator\n Guide.
", "smithy.api#title": "Amazon Connect Contact Lens", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -810,7 +810,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the category rules that are used to automatically categorize contacts based on\n uttered keywords and phrases.
" + "smithy.api#documentation": "Provides the category rules that are used to automatically categorize contacts based\n on uttered keywords and phrases.
" } }, "com.amazonaws.connectcontactlens#CategoryDetails": { @@ -868,7 +868,7 @@ } }, "traits": { - "smithy.api#documentation": "For characters that were detected as issues, where they occur in the transcript.
" + "smithy.api#documentation": "For characters that were detected as issues, where they occur in the\n transcript.
" } }, "com.amazonaws.connectcontactlens#ContactId": { @@ -930,7 +930,7 @@ } }, "traits": { - "smithy.api#documentation": "Potential issues that are detected based on an artificial intelligence analysis of each\n turn in the conversation.
" + "smithy.api#documentation": "Potential issues that are detected based on an artificial intelligence analysis of\n each turn in the conversation.
" } }, "com.amazonaws.connectcontactlens#IssuesDetected": { @@ -1006,7 +1006,7 @@ "MaxResults": { "target": "com.amazonaws.connectcontactlens#MaxResults", "traits": { - "smithy.api#documentation": "The maximimum number of results to return per page.
" + "smithy.api#documentation": "The maximum number of results to return per page.
" } }, "NextToken": { @@ -1034,7 +1034,7 @@ "NextToken": { "target": "com.amazonaws.connectcontactlens#NextToken", "traits": { - "smithy.api#documentation": "If there are additional results, this is the token for the next set of results. If response includes nextToken
there are two possible scenarios:
There are more segments so another call is required to get them.
\nThere are no more segments at this time, but more may be available later (real-time\n analysis is in progress) so the client should call the operation again to get new\n segments.
\nIf response does not include nextToken
, the analysis is completed (successfully or failed) and there are no more segments to retrieve.
If there are additional results, this is the token for the next set of results. If response includes nextToken
there are two possible\n scenarios:
There are more segments so another call is required to get them.
\nThere are no more segments at this time, but more may be available later\n (real-time analysis is in progress) so the client should call the operation\n again to get new segments.
\nIf response does not include nextToken
, the analysis is completed\n (successfully or failed) and there are no more segments to retrieve.
The content of the summary.
" + } + }, + "Status": { + "target": "com.amazonaws.connectcontactlens#PostContactSummaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether the summary was successfully COMPLETED or FAILED to be generated.
", + "smithy.api#required": {} + } + }, + "FailureCode": { + "target": "com.amazonaws.connectcontactlens#PostContactSummaryFailureCode", + "traits": { + "smithy.api#documentation": "If the summary failed to be generated, one of the following failure codes\n occurs:
\n\n QUOTA_EXCEEDED
: The number of concurrent analytics jobs reached\n your service quota.
\n INSUFFICIENT_CONVERSATION_CONTENT
: The conversation needs to have\n at least one turn from both the participants in order to generate the\n summary.
\n FAILED_SAFETY_GUIDELINES
: The generated summary cannot be\n provided because it failed to meet system safety guidelines.
\n INVALID_ANALYSIS_CONFIGURATION
: This code occurs when, for\n example, you're using a \n language \n that isn't supported by generative AI-powered post-contact summaries.\n
\n INTERNAL_ERROR
: Internal system error.
Information about the post-contact summary.
" + } + }, + "com.amazonaws.connectcontactlens#PostContactSummaryContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1762 + } + } + }, + "com.amazonaws.connectcontactlens#PostContactSummaryFailureCode": { + "type": "enum", + "members": { + "QUOTA_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUOTA_EXCEEDED" + } + }, + "INSUFFICIENT_CONVERSATION_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_CONVERSATION_CONTENT" + } + }, + "FAILED_SAFETY_GUIDELINES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_SAFETY_GUIDELINES" + } + }, + "INVALID_ANALYSIS_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ANALYSIS_CONFIGURATION" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + } + } + }, + "com.amazonaws.connectcontactlens#PostContactSummaryStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, "com.amazonaws.connectcontactlens#RealtimeContactAnalysisSegment": { "type": "structure", "members": { @@ -1169,6 +1258,12 @@ "traits": { "smithy.api#documentation": "The matched category rules.
" } + }, + "PostContactSummary": { + "target": "com.amazonaws.connectcontactlens#PostContactSummary", + "traits": { + "smithy.api#documentation": "Information about the post-contact summary.
" + } } }, "traits": { @@ -1255,7 +1350,7 @@ "target": "com.amazonaws.connectcontactlens#ParticipantId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier of the participant.
", + "smithy.api#documentation": "The identifier of the participant. Valid values are CUSTOMER or AGENT.
", "smithy.api#required": {} } }, @@ -1295,7 +1390,7 @@ "target": "com.amazonaws.connectcontactlens#SentimentValue", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The sentiment of the detected for this piece of transcript.
", + "smithy.api#documentation": "The sentiment detected for this piece of transcript.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/elastic-load-balancing.json b/codegen/sdk-codegen/aws-models/elastic-load-balancing.json index 6f26eed42f4..6f2556ab02a 100644 --- a/codegen/sdk-codegen/aws-models/elastic-load-balancing.json +++ b/codegen/sdk-codegen/aws-models/elastic-load-balancing.json @@ -2152,7 +2152,35 @@ "inputToken": "Marker", "outputToken": "NextMarker", "items": "LoadBalancerDescriptions" - } + }, + "smithy.test#smokeTests": [ + { + "id": "DescribeLoadBalancersSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + }, + { + "id": "DescribeLoadBalancersFailure", + "params": { + "LoadBalancerNames": [ + "fake_load_balancer" + ] + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] } }, "com.amazonaws.elasticloadbalancing#DescribeTags": { diff --git a/codegen/sdk-codegen/aws-models/eventbridge.json b/codegen/sdk-codegen/aws-models/eventbridge.json index 9756587b894..e61df2d72ed 100644 --- a/codegen/sdk-codegen/aws-models/eventbridge.json +++ b/codegen/sdk-codegen/aws-models/eventbridge.json @@ -4801,7 +4801,22 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified rule.
\nDescribeRule does not list the targets of a rule. To see the targets associated with a\n rule, use ListTargetsByRule.
" + "smithy.api#documentation": "Describes the specified rule.
\nDescribeRule does not list the targets of a rule. To see the targets associated with a\n rule, use ListTargetsByRule.
", + "smithy.test#smokeTests": [ + { + "id": "DescribeRuleFailure", + "params": { + "Name": "fake-rule" + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] } }, "com.amazonaws.eventbridge#DescribeRuleRequest": { @@ -6537,7 +6552,20 @@ } ], "traits": { - "smithy.api#documentation": "Lists your Amazon EventBridge rules. You can either list all the rules or you can\n provide a prefix to match to the rule names.
\nThe maximum number of results per page for requests is 100.
\nListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.
" + "smithy.api#documentation": "Lists your Amazon EventBridge rules. You can either list all the rules or you can\n provide a prefix to match to the rule names.
\nThe maximum number of results per page for requests is 100.
\nListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.
", + "smithy.test#smokeTests": [ + { + "id": "ListRulesSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.eventbridge#ListRulesRequest": { diff --git a/codegen/sdk-codegen/aws-models/firehose.json b/codegen/sdk-codegen/aws-models/firehose.json index 14d83e82f8b..e89f2448b37 100644 --- a/codegen/sdk-codegen/aws-models/firehose.json +++ b/codegen/sdk-codegen/aws-models/firehose.json @@ -753,6 +753,20 @@ "smithy.api#documentation": "Describes hints for the buffering to perform before delivering data to the\n destination. These options are treated as hints, and therefore Firehose might\n choose to use different values when it is optimal. The SizeInMBs
and\n IntervalInSeconds
parameters are optional. However, if specify a value for\n one of them, you must also provide a value for the other.
\n Specifies the Glue catalog ARN indentifier of the destination Apache Iceberg Tables. You must specify the ARN in the format arn:aws:glue:region:account-id:catalog
.\n
Amazon Data Firehose is in preview release and is subject to change.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Describes the containers where the destination Apache Iceberg Tables are persisted.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, "com.amazonaws.firehose#CloudWatchLoggingOptions": { "type": "structure", "members": { @@ -1036,6 +1050,12 @@ "traits": { "smithy.api#documentation": "Configure Snowflake destination
" } + }, + "IcebergDestinationConfiguration": { + "target": "com.amazonaws.firehose#IcebergDestinationConfiguration", + "traits": { + "smithy.api#documentation": "\n Configure Apache Iceberg Tables destination.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } } }, "traits": { @@ -1715,6 +1735,12 @@ "traits": { "smithy.api#documentation": "The destination in the Serverless offering for Amazon OpenSearch Service.
" } + }, + "IcebergDestinationDescription": { + "target": "com.amazonaws.firehose#IcebergDestinationDescription", + "traits": { + "smithy.api#documentation": "\n Describes a destination in Apache Iceberg Tables.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } } }, "traits": { @@ -1737,6 +1763,46 @@ "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, + "com.amazonaws.firehose#DestinationTableConfiguration": { + "type": "structure", + "members": { + "DestinationTableName": { + "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", + "traits": { + "smithy.api#documentation": "\n Specifies the name of the Apache Iceberg Table.\n
\nAmazon Data Firehose is in preview release and is subject to change.
", + "smithy.api#required": {} + } + }, + "DestinationDatabaseName": { + "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", + "traits": { + "smithy.api#documentation": "\n The name of the Apache Iceberg database.\n
\nAmazon Data Firehose is in preview release and is subject to change.
", + "smithy.api#required": {} + } + }, + "UniqueKeys": { + "target": "com.amazonaws.firehose#ListOfNonEmptyStringsWithoutWhitespace", + "traits": { + "smithy.api#documentation": "\n A list of unique keys for a given Apache Iceberg table. Firehose will use these for running Create/Update/Delete operations on the given Iceberg table. \n \n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, + "S3ErrorOutputPrefix": { + "target": "com.amazonaws.firehose#ErrorOutputPrefix", + "traits": { + "smithy.api#documentation": "\n The table specific S3 error output prefix. All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination. \n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Describes the configuration of a destination in Apache Iceberg Tables.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, + "com.amazonaws.firehose#DestinationTableConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.firehose#DestinationTableConfiguration" + } + }, "com.amazonaws.firehose#DocumentIdOptions": { "type": "structure", "members": { @@ -3600,6 +3666,16 @@ } } }, + "com.amazonaws.firehose#GlueDataCatalogARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^arn:" + } + }, "com.amazonaws.firehose#HECAcknowledgmentTimeoutInSeconds": { "type": "integer", "traits": { @@ -4074,6 +4150,169 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.firehose#IcebergDestinationConfiguration": { + "type": "structure", + "members": { + "DestinationTableConfigurationList": { + "target": "com.amazonaws.firehose#DestinationTableConfigurationList", + "traits": { + "smithy.api#documentation": " Provides a list of DestinationTableConfigurations
which Firehose uses\n to deliver data to Apache Iceberg tables.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, + "BufferingHints": { + "target": "com.amazonaws.firehose#BufferingHints" + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" + }, + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration" + }, + "S3BackupMode": { + "target": "com.amazonaws.firehose#IcebergS3BackupMode", + "traits": { + "smithy.api#documentation": " Describes how Firehose will backup records. Currently,Firehose only supports\n FailedDataOnly
for preview.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, + "RetryOptions": { + "target": "com.amazonaws.firehose#RetryOptions" + }, + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Apache Iceberg tables role.\n
\nAmazon Data Firehose is in preview release and is subject to change.
", + "smithy.api#required": {} + } + }, + "CatalogConfiguration": { + "target": "com.amazonaws.firehose#CatalogConfiguration", + "traits": { + "smithy.api#documentation": "\n Configuration describing where the destination Apache Iceberg Tables are persisted.\n
\nAmazon Data Firehose is in preview release and is subject to change.
", + "smithy.api#required": {} + } + }, + "S3Configuration": { + "target": "com.amazonaws.firehose#S3DestinationConfiguration", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Specifies the destination configure settings for Apache Iceberg Table.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, + "com.amazonaws.firehose#IcebergDestinationDescription": { + "type": "structure", + "members": { + "DestinationTableConfigurationList": { + "target": "com.amazonaws.firehose#DestinationTableConfigurationList", + "traits": { + "smithy.api#documentation": " Provides a list of DestinationTableConfigurations
which Firehose uses\n to deliver data to Apache Iceberg tables.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, + "BufferingHints": { + "target": "com.amazonaws.firehose#BufferingHints" + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" + }, + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration" + }, + "S3BackupMode": { + "target": "com.amazonaws.firehose#IcebergS3BackupMode", + "traits": { + "smithy.api#documentation": " Describes how Firehose will backup records. Currently,Firehose only supports\n FailedDataOnly
for preview.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, + "RetryOptions": { + "target": "com.amazonaws.firehose#RetryOptions" + }, + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Apache Iceberg Tables role.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, + "CatalogConfiguration": { + "target": "com.amazonaws.firehose#CatalogConfiguration", + "traits": { + "smithy.api#documentation": "\n Configuration describing where the destination Iceberg tables are persisted.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, + "S3DestinationDescription": { + "target": "com.amazonaws.firehose#S3DestinationDescription" + } + }, + "traits": { + "smithy.api#documentation": "\n Describes a destination in Apache Iceberg Tables.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, + "com.amazonaws.firehose#IcebergDestinationUpdate": { + "type": "structure", + "members": { + "DestinationTableConfigurationList": { + "target": "com.amazonaws.firehose#DestinationTableConfigurationList", + "traits": { + "smithy.api#documentation": " Provides a list of DestinationTableConfigurations
which Firehose uses\n to deliver data to Apache Iceberg tables.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, + "BufferingHints": { + "target": "com.amazonaws.firehose#BufferingHints" + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" + }, + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration" + }, + "S3BackupMode": { + "target": "com.amazonaws.firehose#IcebergS3BackupMode", + "traits": { + "smithy.api#documentation": " Describes how Firehose will backup records. Currently,Firehose only supports\n FailedDataOnly
for preview.
Amazon Data Firehose is in preview release and is subject to change.
" + } + }, + "RetryOptions": { + "target": "com.amazonaws.firehose#RetryOptions" + }, + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Apache Iceberg Tables role.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, + "CatalogConfiguration": { + "target": "com.amazonaws.firehose#CatalogConfiguration", + "traits": { + "smithy.api#documentation": "\n Configuration describing where the destination Iceberg tables are persisted.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, + "S3Configuration": { + "target": "com.amazonaws.firehose#S3DestinationConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "\n Describes an update for a destination in Apache Iceberg Tables.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } + }, + "com.amazonaws.firehose#IcebergS3BackupMode": { + "type": "enum", + "members": { + "FailedDataOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FailedDataOnly" + } + }, + "AllData": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AllData" + } + } + } + }, "com.amazonaws.firehose#InputFormatConfiguration": { "type": "structure", "members": { @@ -4256,20 +4495,7 @@ "target": "com.amazonaws.firehose#ListDeliveryStreamsOutput" }, "traits": { - "smithy.api#documentation": "Lists your delivery streams in alphabetical order of their names.
\nThe number of delivery streams might be too large to return using a single call to\n ListDeliveryStreams
. You can limit the number of delivery streams returned,\n using the Limit
parameter. To determine whether there are more delivery\n streams to list, check the value of HasMoreDeliveryStreams
in the output. If\n there are more delivery streams to list, you can request them by calling this operation\n again and setting the ExclusiveStartDeliveryStreamName
parameter to the name\n of the last delivery stream returned in the last call.
Lists your delivery streams in alphabetical order of their names.
\nThe number of delivery streams might be too large to return using a single call to\n ListDeliveryStreams
. You can limit the number of delivery streams returned,\n using the Limit
parameter. To determine whether there are more delivery\n streams to list, check the value of HasMoreDeliveryStreams
in the output. If\n there are more delivery streams to list, you can request them by calling this operation\n again and setting the ExclusiveStartDeliveryStreamName
parameter to the name\n of the last delivery stream returned in the last call.
The authentication configuration of the Amazon MSK cluster.
", "smithy.api#required": {} } + }, + "ReadFromTimestamp": { + "target": "com.amazonaws.firehose#ReadFromTimestamp", + "traits": { + "smithy.api#documentation": "The start date and time in UTC for the offset position within your MSK topic from where\n Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.
\nIf you want to create a Firehose stream with Earliest start position from SDK or CLI,\n you need to set the ReadFromTimestamp
parameter to Epoch\n (1970-01-01T00:00:00Z).
Firehose starts retrieving records from the topic within the Amazon MSK\n cluster starting with this timestamp.
" } + }, + "ReadFromTimestamp": { + "target": "com.amazonaws.firehose#ReadFromTimestamp", + "traits": { + "smithy.api#documentation": "The start date and time in UTC for the offset position within your MSK topic from where\n Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.
\nIf you want to create a Firehose stream with Earliest start position from SDK or CLI,\n you need to set the ReadFromTimestampUTC
parameter to Epoch\n (1970-01-01T00:00:00Z).
\n Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 1.\n
" + } + }, + "IntervalInSeconds": { + "target": "com.amazonaws.firehose#SnowflakeBufferingIntervalInSeconds", + "traits": { + "smithy.api#documentation": "\n Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 0.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.\n
" + } + }, + "com.amazonaws.firehose#SnowflakeBufferingIntervalInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 900 + } + } + }, + "com.amazonaws.firehose#SnowflakeBufferingSizeInMBs": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.firehose#SnowflakeContentColumnName": { "type": "string", "traits": { @@ -6115,6 +6394,12 @@ "traits": { "smithy.api#documentation": "\n The configuration that defines how you access secrets for Snowflake.\n
" } + }, + "BufferingHints": { + "target": "com.amazonaws.firehose#SnowflakeBufferingHints", + "traits": { + "smithy.api#documentation": "\n Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.\n
" + } } }, "traits": { @@ -6216,6 +6501,12 @@ "traits": { "smithy.api#documentation": "\n The configuration that defines how you access secrets for Snowflake.\n
" } + }, + "BufferingHints": { + "target": "com.amazonaws.firehose#SnowflakeBufferingHints", + "traits": { + "smithy.api#documentation": "\n Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.\n
" + } } }, "traits": { @@ -6323,6 +6614,12 @@ "traits": { "smithy.api#documentation": "\n Describes the Secrets Manager configuration in Snowflake.\n
" } + }, + "BufferingHints": { + "target": "com.amazonaws.firehose#SnowflakeBufferingHints", + "traits": { + "smithy.api#documentation": "\n Describes the buffering to perform before delivering data to the Snowflake destination. \n
" + } } }, "traits": { @@ -7218,6 +7515,12 @@ "traits": { "smithy.api#documentation": "Update to the Snowflake destination configuration settings.
" } + }, + "IcebergDestinationUpdate": { + "target": "com.amazonaws.firehose#IcebergDestinationUpdate", + "traits": { + "smithy.api#documentation": "\n Describes an update for a destination in Apache Iceberg Tables.\n
\nAmazon Data Firehose is in preview release and is subject to change.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/medical-imaging.json b/codegen/sdk-codegen/aws-models/medical-imaging.json index 4d0db1b204c..26553e0db3c 100644 --- a/codegen/sdk-codegen/aws-models/medical-imaging.json +++ b/codegen/sdk-codegen/aws-models/medical-imaging.json @@ -806,6 +806,16 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.medicalimaging#CopiableAttributes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 260000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.medicalimaging#CopyDestinationImageSet": { "type": "structure", "members": { @@ -969,6 +979,13 @@ "smithy.api#httpPayload": {}, "smithy.api#required": {} } + }, + "force": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Setting this flag will force the CopyImageSet
operation, even if Patient, Study, or Series level\n metadata are mismatched across the sourceImageSet
and destinationImageSet
.
The latest version identifier for the source image set.
", "smithy.api#required": {} } + }, + "DICOMCopies": { + "target": "com.amazonaws.medicalimaging#MetadataCopies", + "traits": { + "smithy.api#documentation": "Contains MetadataCopies
structure and wraps information related to specific copy use cases.\n For example, when copying subsets.
The Amazon Resource Name (ARN) assigned to the image set.
" } + }, + "overrides": { + "target": "com.amazonaws.medicalimaging#Overrides", + "traits": { + "smithy.api#documentation": "This object contains the details of any overrides used while creating a specific image set version.\n If an image set was copied or updated using the force
flag, this object will contain the\n forced
flag.
The error message thrown if an image set action fails.
" } + }, + "overrides": { + "target": "com.amazonaws.medicalimaging#Overrides", + "traits": { + "smithy.api#documentation": "Contains details on overrides used when creating the returned version of an image set.\n For example, if forced
exists, the forced
flag was used when \n creating the image set.
The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains copiable Attributes
structure and wraps information related to specific copy use cases.\n For example, when copying subsets.
The object containing removableAttributes
and updatableAttributes
.
Specifies the previous image set version ID to revert the current image set back to.
\nYou must provide either revertToVersionId
or DICOMUpdates
in your request. A \n ValidationException
error is thrown if both parameters are provided at the same time.
Setting this flag will force the CopyImageSet
and UpdateImageSetMetadata
\n operations, even if Patient, Study, or Series level metadata are mismatched.
Specifies the overrides used in image set modification calls to CopyImageSet
and \n UpdateImageSetMetadata
.
Setting this flag will force the UpdateImageSetMetadata
operation for the following attributes:
\n Tag.StudyInstanceUID
, Tag.SeriesInstanceUID
, Tag.SOPInstanceUID
, and Tag.StudyID
\n
Adding, removing, or updating private tags for an individual SOP Instance
\n\n AWS Mobile Service provides mobile app and website developers with capabilities\n required to configure AWS resources and bootstrap their developer desktop projects\n with the necessary SDKs, constants, tools and samples to make use of those resources.\n
", - "smithy.api#title": "AWS Mobile", - "smithy.api#xmlNamespace": { - "uri": "http://mobile.amazonaws.com" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://mobile-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://mobile-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://mobile.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://mobile.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://mobile-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://mobile.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://mobile-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://mobile.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://mobile-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://mobile.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://mobile.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.mobile#AccountActionRequiredException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.mobile#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "\n Account Action is required in order to continue the request.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.mobile#AttributeKey": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Key part of key-value attribute pairs.\n
" - } - }, - "com.amazonaws.mobile#AttributeValue": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Value part of key-value attribute pairs.\n
" - } - }, - "com.amazonaws.mobile#Attributes": { - "type": "map", - "key": { - "target": "com.amazonaws.mobile#AttributeKey" - }, - "value": { - "target": "com.amazonaws.mobile#AttributeValue" - }, - "traits": { - "smithy.api#documentation": "\n Key-value attribute pairs.\n
" - } - }, - "com.amazonaws.mobile#BadRequestException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.mobile#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "\n The request cannot be processed because some parameter is not valid or the project\n state prevents the operation from being performed.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.mobile#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.mobile#BundleDescription": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Description of the download bundle.\n
" - } - }, - "com.amazonaws.mobile#BundleDetails": { - "type": "structure", - "members": { - "bundleId": { - "target": "com.amazonaws.mobile#BundleId" - }, - "title": { - "target": "com.amazonaws.mobile#BundleTitle" - }, - "version": { - "target": "com.amazonaws.mobile#BundleVersion" - }, - "description": { - "target": "com.amazonaws.mobile#BundleDescription" - }, - "iconUrl": { - "target": "com.amazonaws.mobile#IconUrl" - }, - "availablePlatforms": { - "target": "com.amazonaws.mobile#Platforms" - } - }, - "traits": { - "smithy.api#documentation": "\n The details of the bundle.\n
" - } - }, - "com.amazonaws.mobile#BundleId": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Unique bundle identifier.\n
" - } - }, - "com.amazonaws.mobile#BundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.mobile#BundleDetails" - }, - "traits": { - "smithy.api#documentation": "\n A list of bundles.\n
" - } - }, - "com.amazonaws.mobile#BundleTitle": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Title of the download bundle.\n
" - } - }, - "com.amazonaws.mobile#BundleVersion": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Version of the download bundle.\n
" - } - }, - "com.amazonaws.mobile#ConsoleUrl": { - "type": "string" - }, - "com.amazonaws.mobile#Contents": { - "type": "blob", - "traits": { - "smithy.api#documentation": "\n Binary file data.\n
" - } - }, - "com.amazonaws.mobile#CreateProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.mobile#CreateProjectRequest" - }, - "output": { - "target": "com.amazonaws.mobile#CreateProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.mobile#BadRequestException" - }, - { - "target": "com.amazonaws.mobile#InternalFailureException" - }, - { - "target": "com.amazonaws.mobile#LimitExceededException" - }, - { - "target": "com.amazonaws.mobile#NotFoundException" - }, - { - "target": "com.amazonaws.mobile#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.mobile#TooManyRequestsException" - }, - { - "target": "com.amazonaws.mobile#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "\n Creates an AWS Mobile Hub project.\n
", - "smithy.api#http": { - "method": "POST", - "uri": "/projects", - "code": 200 - } - } - }, - "com.amazonaws.mobile#CreateProjectRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.mobile#ProjectName", - "traits": { - "smithy.api#documentation": "\n Name of the project.\n
", - "smithy.api#httpQuery": "name" - } - }, - "region": { - "target": "com.amazonaws.mobile#ProjectRegion", - "traits": { - "smithy.api#documentation": "\n Default region where project resources should be created.\n
", - "smithy.api#httpQuery": "region" - } - }, - "contents": { - "target": "com.amazonaws.mobile#Contents", - "traits": { - "smithy.api#documentation": "\n ZIP or YAML file which contains configuration settings to be used when creating\n the project. This may be the contents of the file downloaded from the URL provided\n in an export project operation.\n
", - "smithy.api#httpPayload": {} - } - }, - "snapshotId": { - "target": "com.amazonaws.mobile#SnapshotId", - "traits": { - "smithy.api#documentation": "\n Unique identifier for an exported snapshot of project configuration. This\n snapshot identifier is included in the share URL when a project is exported.\n
", - "smithy.api#httpQuery": "snapshotId" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Request structure used to request a project be created.\n
", - "smithy.api#input": {} - } - }, - "com.amazonaws.mobile#CreateProjectResult": { - "type": "structure", - "members": { - "details": { - "target": "com.amazonaws.mobile#ProjectDetails", - "traits": { - "smithy.api#documentation": "\n Detailed information about the created AWS Mobile Hub project.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Result structure used in response to a request to create a project.\n
", - "smithy.api#output": {} - } - }, - "com.amazonaws.mobile#Date": { - "type": "timestamp" - }, - "com.amazonaws.mobile#DeleteProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.mobile#DeleteProjectRequest" - }, - "output": { - "target": "com.amazonaws.mobile#DeleteProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.mobile#InternalFailureException" - }, - { - "target": "com.amazonaws.mobile#NotFoundException" - }, - { - "target": "com.amazonaws.mobile#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.mobile#TooManyRequestsException" - }, - { - "target": "com.amazonaws.mobile#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "\n Delets a project in AWS Mobile Hub.\n
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/projects/{projectId}", - "code": 200 - } - } - }, - "com.amazonaws.mobile#DeleteProjectRequest": { - "type": "structure", - "members": { - "projectId": { - "target": "com.amazonaws.mobile#ProjectId", - "traits": { - "smithy.api#documentation": "\n Unique project identifier.\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "\n Request structure used to request a project be deleted.\n
", - "smithy.api#input": {} - } - }, - "com.amazonaws.mobile#DeleteProjectResult": { - "type": "structure", - "members": { - "deletedResources": { - "target": "com.amazonaws.mobile#Resources", - "traits": { - "smithy.api#documentation": "\n Resources which were deleted.\n
" - } - }, - "orphanedResources": { - "target": "com.amazonaws.mobile#Resources", - "traits": { - "smithy.api#documentation": "\n Resources which were not deleted, due to a risk of losing potentially\n important data or files.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Result structure used in response to request to delete a project.\n
", - "smithy.api#output": {} - } - }, - "com.amazonaws.mobile#DescribeBundle": { - "type": "operation", - "input": { - "target": "com.amazonaws.mobile#DescribeBundleRequest" - }, - "output": { - "target": "com.amazonaws.mobile#DescribeBundleResult" - }, - "errors": [ - { - "target": "com.amazonaws.mobile#BadRequestException" - }, - { - "target": "com.amazonaws.mobile#InternalFailureException" - }, - { - "target": "com.amazonaws.mobile#NotFoundException" - }, - { - "target": "com.amazonaws.mobile#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.mobile#TooManyRequestsException" - }, - { - "target": "com.amazonaws.mobile#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "\n Get the bundle details for the requested bundle id.\n
", - "smithy.api#http": { - "method": "GET", - "uri": "/bundles/{bundleId}", - "code": 200 - } - } - }, - "com.amazonaws.mobile#DescribeBundleRequest": { - "type": "structure", - "members": { - "bundleId": { - "target": "com.amazonaws.mobile#BundleId", - "traits": { - "smithy.api#documentation": "\n Unique bundle identifier.\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "\n Request structure to request the details of a specific bundle.\n
", - "smithy.api#input": {} - } - }, - "com.amazonaws.mobile#DescribeBundleResult": { - "type": "structure", - "members": { - "details": { - "target": "com.amazonaws.mobile#BundleDetails", - "traits": { - "smithy.api#documentation": "\n The details of the bundle.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Result structure contains the details of the bundle.\n
", - "smithy.api#output": {} - } - }, - "com.amazonaws.mobile#DescribeProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.mobile#DescribeProjectRequest" - }, - "output": { - "target": "com.amazonaws.mobile#DescribeProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.mobile#BadRequestException" - }, - { - "target": "com.amazonaws.mobile#InternalFailureException" - }, - { - "target": "com.amazonaws.mobile#NotFoundException" - }, - { - "target": "com.amazonaws.mobile#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.mobile#TooManyRequestsException" - }, - { - "target": "com.amazonaws.mobile#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "\n Gets details about a project in AWS Mobile Hub.\n
", - "smithy.api#http": { - "method": "GET", - "uri": "/project", - "code": 200 - } - } - }, - "com.amazonaws.mobile#DescribeProjectRequest": { - "type": "structure", - "members": { - "projectId": { - "target": "com.amazonaws.mobile#ProjectId", - "traits": { - "smithy.api#documentation": "\n Unique project identifier.\n
", - "smithy.api#httpQuery": "projectId", - "smithy.api#required": {} - } - }, - "syncFromResources": { - "target": "com.amazonaws.mobile#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "\n If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project.\n
", - "smithy.api#httpQuery": "syncFromResources" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Request structure used to request details about a project.\n
", - "smithy.api#input": {} - } - }, - "com.amazonaws.mobile#DescribeProjectResult": { - "type": "structure", - "members": { - "details": { - "target": "com.amazonaws.mobile#ProjectDetails" - } - }, - "traits": { - "smithy.api#documentation": "\n Result structure used for requests of project details.\n
", - "smithy.api#output": {} - } - }, - "com.amazonaws.mobile#DownloadUrl": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n The download Url.\n
" - } - }, - "com.amazonaws.mobile#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n The Exception Error Message.\n
" - } - }, - "com.amazonaws.mobile#ExportBundle": { - "type": "operation", - "input": { - "target": "com.amazonaws.mobile#ExportBundleRequest" - }, - "output": { - "target": "com.amazonaws.mobile#ExportBundleResult" - }, - "errors": [ - { - "target": "com.amazonaws.mobile#BadRequestException" - }, - { - "target": "com.amazonaws.mobile#InternalFailureException" - }, - { - "target": "com.amazonaws.mobile#NotFoundException" - }, - { - "target": "com.amazonaws.mobile#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.mobile#TooManyRequestsException" - }, - { - "target": "com.amazonaws.mobile#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "\n Generates customized software development kit (SDK) and or tool packages\n used to integrate mobile web or mobile app clients with backend AWS resources.\n
", - "smithy.api#http": { - "method": "POST", - "uri": "/bundles/{bundleId}", - "code": 200 - } - } - }, - "com.amazonaws.mobile#ExportBundleRequest": { - "type": "structure", - "members": { - "bundleId": { - "target": "com.amazonaws.mobile#BundleId", - "traits": { - "smithy.api#documentation": "\n Unique bundle identifier.\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "projectId": { - "target": "com.amazonaws.mobile#ProjectId", - "traits": { - "smithy.api#documentation": "\n Unique project identifier.\n
", - "smithy.api#httpQuery": "projectId" - } - }, - "platform": { - "target": "com.amazonaws.mobile#Platform", - "traits": { - "smithy.api#documentation": "\n Developer desktop or target application platform.\n
", - "smithy.api#httpQuery": "platform" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Request structure used to request generation of custom SDK and tool packages\n required to integrate mobile web or app clients with backed AWS resources.\n
", - "smithy.api#input": {} - } - }, - "com.amazonaws.mobile#ExportBundleResult": { - "type": "structure", - "members": { - "downloadUrl": { - "target": "com.amazonaws.mobile#DownloadUrl", - "traits": { - "smithy.api#documentation": "\n URL which contains the custom-generated SDK and tool packages used\n to integrate the client mobile app or web app with the AWS resources\n created by the AWS Mobile Hub project.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Result structure which contains link to download custom-generated SDK and\n tool packages used to integrate mobile web or app clients with backed\n AWS resources.\n
", - "smithy.api#output": {} - } - }, - "com.amazonaws.mobile#ExportProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.mobile#ExportProjectRequest" - }, - "output": { - "target": "com.amazonaws.mobile#ExportProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.mobile#BadRequestException" - }, - { - "target": "com.amazonaws.mobile#InternalFailureException" - }, - { - "target": "com.amazonaws.mobile#NotFoundException" - }, - { - "target": "com.amazonaws.mobile#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.mobile#TooManyRequestsException" - }, - { - "target": "com.amazonaws.mobile#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "\n Exports project configuration to a snapshot which can be downloaded and shared.\n Note that mobile app push credentials are encrypted in exported projects, so they\n can only be shared successfully within the same AWS account.\n
", - "smithy.api#http": { - "method": "POST", - "uri": "/exports/{projectId}", - "code": 200 - } - } - }, - "com.amazonaws.mobile#ExportProjectRequest": { - "type": "structure", - "members": { - "projectId": { - "target": "com.amazonaws.mobile#ProjectId", - "traits": { - "smithy.api#documentation": "\n Unique project identifier.\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "\n Request structure used in requests to export project configuration details.\n
", - "smithy.api#input": {} - } - }, - "com.amazonaws.mobile#ExportProjectResult": { - "type": "structure", - "members": { - "downloadUrl": { - "target": "com.amazonaws.mobile#DownloadUrl", - "traits": { - "smithy.api#documentation": "\n URL which can be used to download the exported project configuation file(s).\n
" - } - }, - "shareUrl": { - "target": "com.amazonaws.mobile#ShareUrl", - "traits": { - "smithy.api#documentation": "\n URL which can be shared to allow other AWS users to create their own project\n in AWS Mobile Hub with the same configuration as the specified project. This\n URL pertains to a snapshot in time of the project configuration that is created\n when this API is called. If you want to share additional changes to your project\n configuration, then you will need to create and share a new snapshot by calling\n this method again.\n
" - } - }, - "snapshotId": { - "target": "com.amazonaws.mobile#SnapshotId", - "traits": { - "smithy.api#documentation": "\n Unique identifier for the exported snapshot of the project configuration. This\n snapshot identifier is included in the share URL.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Result structure used for requests to export project configuration details.\n
", - "smithy.api#output": {} - } - }, - "com.amazonaws.mobile#Feature": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Identifies which feature in AWS Mobile Hub is associated with this AWS resource.\n
" - } - }, - "com.amazonaws.mobile#IconUrl": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Icon for the download bundle.\n
" - } - }, - "com.amazonaws.mobile#InternalFailureException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.mobile#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "\n The service has encountered an unexpected error condition which prevents it from\n servicing the request.\n
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.mobile#LimitExceededException": { - "type": "structure", - "members": { - "retryAfterSeconds": { - "target": "com.amazonaws.mobile#ErrorMessage", - "traits": { - "smithy.api#httpHeader": "Retry-After" - } - }, - "message": { - "target": "com.amazonaws.mobile#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "\n There are too many AWS Mobile Hub projects in the account or the account has\n exceeded the maximum number of resources in some AWS service. You should create\n another sub-account using AWS Organizations or remove some resources and retry\n your request.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.mobile#ListBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.mobile#ListBundlesRequest" - }, - "output": { - "target": "com.amazonaws.mobile#ListBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.mobile#BadRequestException" - }, - { - "target": "com.amazonaws.mobile#InternalFailureException" - }, - { - "target": "com.amazonaws.mobile#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.mobile#TooManyRequestsException" - }, - { - "target": "com.amazonaws.mobile#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "\n List all available bundles.\n
", - "smithy.api#http": { - "method": "GET", - "uri": "/bundles", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.mobile#ListBundlesRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.mobile#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "\n Maximum number of records to list in a single response.\n
", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.mobile#NextToken", - "traits": { - "smithy.api#documentation": "\n Pagination token. Set to null to start listing bundles from start.\n If non-null pagination token is returned in a result, then pass its\n value in here in another request to list more bundles.\n
", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Request structure to request all available bundles.\n
", - "smithy.api#input": {} - } - }, - "com.amazonaws.mobile#ListBundlesResult": { - "type": "structure", - "members": { - "bundleList": { - "target": "com.amazonaws.mobile#BundleList", - "traits": { - "smithy.api#documentation": "\n A list of bundles.\n
" - } - }, - "nextToken": { - "target": "com.amazonaws.mobile#NextToken", - "traits": { - "smithy.api#documentation": "\n Pagination token. If non-null pagination token is returned in a result,\n then pass its value in another request to fetch more entries.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Result structure contains a list of all available bundles with details.\n
", - "smithy.api#output": {} - } - }, - "com.amazonaws.mobile#ListProjects": { - "type": "operation", - "input": { - "target": "com.amazonaws.mobile#ListProjectsRequest" - }, - "output": { - "target": "com.amazonaws.mobile#ListProjectsResult" - }, - "errors": [ - { - "target": "com.amazonaws.mobile#BadRequestException" - }, - { - "target": "com.amazonaws.mobile#InternalFailureException" - }, - { - "target": "com.amazonaws.mobile#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.mobile#TooManyRequestsException" - }, - { - "target": "com.amazonaws.mobile#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "\n Lists projects in AWS Mobile Hub.\n
", - "smithy.api#http": { - "method": "GET", - "uri": "/projects", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.mobile#ListProjectsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.mobile#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "\n Maximum number of records to list in a single response.\n
", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.mobile#NextToken", - "traits": { - "smithy.api#documentation": "\n Pagination token. Set to null to start listing projects from start.\n If non-null pagination token is returned in a result, then pass its\n value in here in another request to list more projects.\n
", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Request structure used to request projects list in AWS Mobile Hub.\n
", - "smithy.api#input": {} - } - }, - "com.amazonaws.mobile#ListProjectsResult": { - "type": "structure", - "members": { - "projects": { - "target": "com.amazonaws.mobile#ProjectSummaries" - }, - "nextToken": { - "target": "com.amazonaws.mobile#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "\n Result structure used for requests to list projects in AWS Mobile Hub.\n
", - "smithy.api#output": {} - } - }, - "com.amazonaws.mobile#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "\n Maximum number of records to list in a single response.\n
" - } - }, - "com.amazonaws.mobile#NextToken": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Pagination token. Set to null to start listing records from start.\n If non-null pagination token is returned in a result, then pass its\n value in here in another request to list more entries.\n
" - } - }, - "com.amazonaws.mobile#NotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.mobile#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "\n No entity can be found with the specified identifier.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.mobile#Platform": { - "type": "enum", - "members": { - "OSX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OSX" - } - }, - "WINDOWS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS" - } - }, - "LINUX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINUX" - } - }, - "OBJC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OBJC" - } - }, - "SWIFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SWIFT" - } - }, - "ANDROID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANDROID" - } - }, - "JAVASCRIPT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JAVASCRIPT" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Developer desktop or target mobile app or website platform.\n
" - } - }, - "com.amazonaws.mobile#Platforms": { - "type": "list", - "member": { - "target": "com.amazonaws.mobile#Platform" - }, - "traits": { - "smithy.api#documentation": "\n Developer desktop or mobile app or website platforms.\n
" - } - }, - "com.amazonaws.mobile#ProjectDetails": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.mobile#ProjectName" - }, - "projectId": { - "target": "com.amazonaws.mobile#ProjectId" - }, - "region": { - "target": "com.amazonaws.mobile#ProjectRegion" - }, - "state": { - "target": "com.amazonaws.mobile#ProjectState" - }, - "createdDate": { - "target": "com.amazonaws.mobile#Date", - "traits": { - "smithy.api#documentation": "\n Date the project was created.\n
" - } - }, - "lastUpdatedDate": { - "target": "com.amazonaws.mobile#Date", - "traits": { - "smithy.api#documentation": "\n Date of the last modification of the project.\n
" - } - }, - "consoleUrl": { - "target": "com.amazonaws.mobile#ConsoleUrl", - "traits": { - "smithy.api#documentation": "\n Website URL for this project in the AWS Mobile Hub console.\n
" - } - }, - "resources": { - "target": "com.amazonaws.mobile#Resources" - } - }, - "traits": { - "smithy.api#documentation": "\n Detailed information about an AWS Mobile Hub project.\n
" - } - }, - "com.amazonaws.mobile#ProjectId": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Unique project identifier.\n
" - } - }, - "com.amazonaws.mobile#ProjectName": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Name of the project.\n
" - } - }, - "com.amazonaws.mobile#ProjectRegion": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Default region to use for AWS resource creation in the AWS Mobile Hub project.\n
" - } - }, - "com.amazonaws.mobile#ProjectState": { - "type": "enum", - "members": { - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - }, - "SYNCING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SYNCING" - } - }, - "IMPORTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORTING" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Synchronization state for a project.\n
" - } - }, - "com.amazonaws.mobile#ProjectSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.mobile#ProjectSummary" - }, - "traits": { - "smithy.api#documentation": "\n List of projects.\n
" - } - }, - "com.amazonaws.mobile#ProjectSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.mobile#ProjectName", - "traits": { - "smithy.api#documentation": "\n Name of the project.\n
" - } - }, - "projectId": { - "target": "com.amazonaws.mobile#ProjectId", - "traits": { - "smithy.api#documentation": "\n Unique project identifier.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Summary information about an AWS Mobile Hub project.\n
" - } - }, - "com.amazonaws.mobile#Resource": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.mobile#ResourceType" - }, - "name": { - "target": "com.amazonaws.mobile#ResourceName" - }, - "arn": { - "target": "com.amazonaws.mobile#ResourceArn" - }, - "feature": { - "target": "com.amazonaws.mobile#Feature" - }, - "attributes": { - "target": "com.amazonaws.mobile#Attributes" - } - }, - "traits": { - "smithy.api#documentation": "\n Information about an instance of an AWS resource associated with a project.\n
" - } - }, - "com.amazonaws.mobile#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n AWS resource name which uniquely identifies the resource in AWS systems.\n
" - } - }, - "com.amazonaws.mobile#ResourceName": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).\n
" - } - }, - "com.amazonaws.mobile#ResourceType": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).\n
" - } - }, - "com.amazonaws.mobile#Resources": { - "type": "list", - "member": { - "target": "com.amazonaws.mobile#Resource" - }, - "traits": { - "smithy.api#documentation": "\n List of AWS resources associated with a project.\n
" - } - }, - "com.amazonaws.mobile#ServiceUnavailableException": { - "type": "structure", - "members": { - "retryAfterSeconds": { - "target": "com.amazonaws.mobile#ErrorMessage", - "traits": { - "smithy.api#httpHeader": "Retry-After" - } - }, - "message": { - "target": "com.amazonaws.mobile#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "\n The service is temporarily unavailable. The request should be retried after some\n time delay.\n
", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.mobile#ShareUrl": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n URL which can be shared to allow other AWS users to create their own project\n in AWS Mobile Hub with the same configuration as the specified project. This\n URL pertains to a snapshot in time of the project configuration that is created\n when this API is called. If you want to share additional changes to your project\n configuration, then you will need to create and share a new snapshot by calling\n this method again.\n
" - } - }, - "com.amazonaws.mobile#SnapshotId": { - "type": "string", - "traits": { - "smithy.api#documentation": "\n Unique identifier for the exported snapshot of the project configuration. This\n snapshot identifier is included in the share URL.\n
" - } - }, - "com.amazonaws.mobile#TooManyRequestsException": { - "type": "structure", - "members": { - "retryAfterSeconds": { - "target": "com.amazonaws.mobile#ErrorMessage", - "traits": { - "smithy.api#httpHeader": "Retry-After" - } - }, - "message": { - "target": "com.amazonaws.mobile#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "\n Too many requests have been received for this AWS account in too short a time. The\n request should be retried after some time delay.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.mobile#UnauthorizedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.mobile#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "\n Credentials of the caller are insufficient to authorize the request.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.mobile#UpdateProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.mobile#UpdateProjectRequest" - }, - "output": { - "target": "com.amazonaws.mobile#UpdateProjectResult" - }, - "errors": [ - { - "target": "com.amazonaws.mobile#AccountActionRequiredException" - }, - { - "target": "com.amazonaws.mobile#BadRequestException" - }, - { - "target": "com.amazonaws.mobile#InternalFailureException" - }, - { - "target": "com.amazonaws.mobile#LimitExceededException" - }, - { - "target": "com.amazonaws.mobile#NotFoundException" - }, - { - "target": "com.amazonaws.mobile#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.mobile#TooManyRequestsException" - }, - { - "target": "com.amazonaws.mobile#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "\n Update an existing project.\n
", - "smithy.api#http": { - "method": "POST", - "uri": "/update", - "code": 200 - } - } - }, - "com.amazonaws.mobile#UpdateProjectRequest": { - "type": "structure", - "members": { - "contents": { - "target": "com.amazonaws.mobile#Contents", - "traits": { - "smithy.api#documentation": "\n ZIP or YAML file which contains project configuration to be updated. This should\n be the contents of the file downloaded from the URL provided in an export project\n operation.\n
", - "smithy.api#httpPayload": {} - } - }, - "projectId": { - "target": "com.amazonaws.mobile#ProjectId", - "traits": { - "smithy.api#documentation": "\n Unique project identifier.\n
", - "smithy.api#httpQuery": "projectId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "\n Request structure used for requests to update project configuration.\n
", - "smithy.api#input": {} - } - }, - "com.amazonaws.mobile#UpdateProjectResult": { - "type": "structure", - "members": { - "details": { - "target": "com.amazonaws.mobile#ProjectDetails", - "traits": { - "smithy.api#documentation": "\n Detailed information about the updated AWS Mobile Hub project.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Result structure used for requests to updated project configuration.\n
", - "smithy.api#output": {} - } - } - } -} diff --git a/codegen/sdk-codegen/aws-models/network-firewall.json b/codegen/sdk-codegen/aws-models/network-firewall.json index a7d6b43fdb6..63ff40ba387 100644 --- a/codegen/sdk-codegen/aws-models/network-firewall.json +++ b/codegen/sdk-codegen/aws-models/network-firewall.json @@ -804,7 +804,7 @@ "Capacity": { "target": "com.amazonaws.networkfirewall#RuleCapacity", "traits": { - "smithy.api#documentation": "The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.\n When you update a rule group, you are limited to this capacity. When you reference a rule group\n from a firewall policy, Network Firewall reserves this capacity for the rule group.
\nYou can retrieve the capacity that would be required for a rule group before you create the rule group by calling\n CreateRuleGroup with DryRun
set to TRUE
.
You can't change or exceed this capacity when you update the rule group, so leave\n room for your rule group to grow.
\n\n Capacity for a stateless rule group\n
\nFor a stateless rule group, the capacity required is the sum of the capacity\n requirements of the individual rules that you expect to have in the rule group.
\nTo calculate the capacity requirement of a single rule, multiply the capacity\n requirement values of each of the rule's match settings:
\nA match setting with no criteria specified has a value of 1.
\nA match setting with Any
specified has a value of 1.
All other match settings have a value equal to the number of elements provided in\n the setting. For example, a protocol setting [\"UDP\"] and a source setting\n [\"10.0.0.0/24\"] each have a value of 1. A protocol setting [\"UDP\",\"TCP\"] has a value\n of 2. A source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"] has a value of 3.\n
\nA rule with no criteria specified in any of its match settings has a capacity\n requirement of 1. A rule with protocol setting [\"UDP\",\"TCP\"], source setting\n [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no specification\n for each of the other match settings has a capacity requirement of 6.
\n\n Capacity for a stateful rule group\n
\nFor\n a stateful rule group, the minimum capacity required is the number of individual rules that\n you expect to have in the rule group.
", + "smithy.api#documentation": "The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.\n When you update a rule group, you are limited to this capacity. When you reference a rule group\n from a firewall policy, Network Firewall reserves this capacity for the rule group.
\nYou can retrieve the capacity that would be required for a rule group before you create the rule group by calling\n CreateRuleGroup with DryRun
set to TRUE
.
You can't change or exceed this capacity when you update the rule group, so leave\n room for your rule group to grow.
\n\n Capacity for a stateless rule group\n
\nFor a stateless rule group, the capacity required is the sum of the capacity\n requirements of the individual rules that you expect to have in the rule group.
\nTo calculate the capacity requirement of a single rule, multiply the capacity\n requirement values of each of the rule's match settings:
\nA match setting with no criteria specified has a value of 1.
\nA match setting with Any
specified has a value of 1.
All other match settings have a value equal to the number of elements provided in\n the setting. For example, a protocol setting [\"UDP\"] and a source setting\n [\"10.0.0.0/24\"] each have a value of 1. A protocol setting [\"UDP\",\"TCP\"] has a value\n of 2. A source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"] has a value of 3.\n
\nA rule with no criteria specified in any of its match settings has a capacity\n requirement of 1. A rule with protocol setting [\"UDP\",\"TCP\"], source setting\n [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no specification\n for each of the other match settings has a capacity requirement of 6.
\n\n Capacity for a stateful rule group\n
\nFor a stateful rule group, the minimum capacity required is the number of individual rules that\n you expect to have in the rule group.
", "smithy.api#required": {} } }, @@ -893,7 +893,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration contains Certificate Manager certificate associations between and the scope configurations that Network Firewall uses to decrypt and re-encrypt traffic traveling through your firewall.
\nAfter you create a TLS inspection configuration, you can associate it with a new firewall policy.
\nTo update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.
\nTo manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
\nTo retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.
\n\n For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.\n
" + "smithy.api#documentation": "Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.
\nTo update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.
\nTo manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
\nTo retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.
\n\n For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.\n
" } }, "com.amazonaws.networkfirewall#CreateTLSInspectionConfigurationRequest": { @@ -3073,7 +3073,7 @@ "LogType": { "target": "com.amazonaws.networkfirewall#LogType", "traits": { - "smithy.api#documentation": "The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are\n standard network traffic flow logs.
", + "smithy.api#documentation": "The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
\n\n ALERT
- Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.
\n FLOW
- Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.
\n TLS
- Logs for events that are related to TLS inspection. For more information, see \n Inspecting SSL/TLS traffic with TLS inspection configurations \n in the Network Firewall Developer Guide.
The named location for the logs, provided in a key:value mapping that is specific to the\n chosen destination type.
\nFor an Amazon S3 bucket, provide the name of the bucket, with key bucketName
,\n and optionally provide a prefix, with key prefix
. The following example\n specifies an Amazon S3 bucket named\n DOC-EXAMPLE-BUCKET
and the prefix alerts
:
\n \"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\"\n }
\n
For a CloudWatch log group, provide the name of the CloudWatch log group, with key\n logGroup
. The following example specifies a log group named\n alert-log-group
:
\n \"LogDestination\": { \"logGroup\": \"alert-log-group\" }
\n
For a Firehose delivery stream, provide the name of the delivery stream, with key\n deliveryStream
. The following example specifies a delivery stream\n named alert-delivery-stream
:
\n \"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\"\n }
\n
The named location for the logs, provided in a key:value mapping that is specific to the\n chosen destination type.
\nFor an Amazon S3 bucket, provide the name of the bucket, with key bucketName
,\n and optionally provide a prefix, with key prefix
.
The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET
and the prefix alerts
:
\n \"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\"\n }
\n
For a CloudWatch log group, provide the name of the CloudWatch log group, with key\n logGroup
. The following example specifies a log group named\n alert-log-group
:
\n \"LogDestination\": { \"logGroup\": \"alert-log-group\" }
\n
For a Firehose delivery stream, provide the name of the delivery stream, with key\n deliveryStream
. The following example specifies a delivery stream\n named alert-delivery-stream
:
\n \"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\"\n }
\n
Defines where Network Firewall sends logs for the firewall for one log type. This is used\n in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
\nNetwork Firewall generates logs for stateful rule groups. You can save alert and flow log\n types. The stateful rules engine records flow logs for all network traffic that it receives.\n It records alert logs for traffic that matches stateful rules that have the rule\n action set to DROP
or ALERT
.
Defines where Network Firewall sends logs for the firewall for one log type. This is used\n in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
\nNetwork Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log\n types.
" } }, "com.amazonaws.networkfirewall#LogDestinationConfigs": { @@ -3167,6 +3167,12 @@ "traits": { "smithy.api#enumValue": "FLOW" } + }, + "TLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TLS" + } } } }, @@ -5089,7 +5095,7 @@ } }, "traits": { - "smithy.api#documentation": "Stateful inspection criteria for a domain list rule group.
\nFor HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
\nBy default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET
rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.
Stateful inspection criteria for a domain list rule group.
\nFor HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
\nBy default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET
rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and \n Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.
Defines what Network Firewall should do with the packets in a traffic flow when the flow\n matches the stateful rule criteria. For all actions, Network Firewall performs the specified\n action and discontinues stateful inspection of the traffic flow.
\nThe actions for a stateful rule are defined as follows:
\n\n PASS - Permits the packets to go to the\n intended destination.
\n\n DROP - Blocks the packets from going to\n the intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\n\n ALERT - Sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\nYou can use this action to test a rule that you intend to use to drop traffic. You\n can enable the rule with ALERT
action, verify in the logs that the rule\n is filtering as you want, then change the action to DROP
.
Defines what Network Firewall should do with the packets in a traffic flow when the flow\n matches the stateful rule criteria. For all actions, Network Firewall performs the specified\n action and discontinues stateful inspection of the traffic flow.
\nThe actions for a stateful rule are defined as follows:
\n\n PASS - Permits the packets to go to the\n intended destination.
\n\n DROP - Blocks the packets from going to\n the intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\n\n ALERT - Sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\nYou can use this action to test a rule that you intend to use to drop traffic. You\n can enable the rule with ALERT
action, verify in the logs that the rule\n is filtering as you want, then change the action to DROP
.
\n REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
\nThe ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. \n This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. \n For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for \n Amazon Redshift in the Amazon Redshift Cluster Management Guide
", + "smithy.api#documentation": "The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. \n This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. \n For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for \n Amazon Redshift in the Amazon Redshift Management Guide
", "smithy.api#required": {} } }, @@ -904,6 +904,9 @@ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, + { + "target": "com.amazonaws.redshiftserverless#Ipv6CidrBlockNotFoundException" + }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, @@ -989,6 +992,12 @@ "traits": { "smithy.api#documentation": "The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" } + }, + "ipAddressType": { + "target": "com.amazonaws.redshiftserverless#IpAddressType", + "traits": { + "smithy.api#documentation": "The IP address type that the workgroup supports. Possible values are ipv4
and dualstack
.
There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.redshiftserverless#KmsKeyId": { "type": "string" }, @@ -3589,6 +3620,12 @@ "traits": { "smithy.api#documentation": "The availability Zone.
" } + }, + "ipv6Address": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The IPv6 address of the network interface within the subnet.
" + } } }, "traits": { @@ -5166,7 +5203,7 @@ "roleArn": { "target": "com.amazonaws.redshiftserverless#IamRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. \n This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. \n For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for \n Amazon Redshift in the Amazon Redshift Cluster Management Guide
" + "smithy.api#documentation": "The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. \n This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. \n For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for \n Amazon Redshift in the Amazon Redshift Management Guide
" } }, "state": { @@ -6195,7 +6232,7 @@ "roleArn": { "target": "com.amazonaws.redshiftserverless#IamRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. \n This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. \n For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for \n Amazon Redshift in the Amazon Redshift Cluster Management Guide
" + "smithy.api#documentation": "The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. \n This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. \n For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for \n Amazon Redshift in the Amazon Redshift Management Guide
" } }, "enabled": { @@ -6452,6 +6489,9 @@ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, + { + "target": "com.amazonaws.redshiftserverless#Ipv6CidrBlockNotFoundException" + }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, @@ -6520,6 +6560,12 @@ "traits": { "smithy.api#documentation": "The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" } + }, + "ipAddressType": { + "target": "com.amazonaws.redshiftserverless#IpAddressType", + "traits": { + "smithy.api#documentation": "The IP address type that the workgroup supports. Possible values are ipv4
and dualstack
.
A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.
" } + }, + "ipAddressType": { + "target": "com.amazonaws.redshiftserverless#IpAddressType", + "traits": { + "smithy.api#documentation": "The IP address type that the workgroup supports. Possible values are ipv4
and dualstack
.
The tags to attach to the profile.
" } + }, + "acceptRoleSessionName": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Used to determine if a custom role session name will be accepted in a temporary credential request.
" + } } } }, @@ -405,6 +411,7 @@ }, "output": { "profile": { + "acceptRoleSessionName": false, "attributeMappings": [ { "mappingRules": [ @@ -1533,6 +1540,12 @@ "smithy.api#documentation": " Used to determine how long sessions vended using this profile are valid for. See the Expiration
section of the \nCreateSession API documentation\npage for more details. In requests, if this value is not provided, the default value will be 3600.
Used to determine if a custom role session name will be accepted in a temporary credential request.
" + } + }, "attributeMappings": { "target": "com.amazonaws.rolesanywhere#AttributeMappings", "traits": { @@ -1596,6 +1609,7 @@ }, "output": { "profile": { + "acceptRoleSessionName": false, "attributeMappings": [ { "mappingRules": [ @@ -3560,6 +3574,12 @@ "max": 43200 } } + }, + "acceptRoleSessionName": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Used to determine if a custom role session name will be accepted in a temporary credential request.
" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/secrets-manager.json b/codegen/sdk-codegen/aws-models/secrets-manager.json index 053e9e19b3e..831a88fc178 100644 --- a/codegen/sdk-codegen/aws-models/secrets-manager.json +++ b/codegen/sdk-codegen/aws-models/secrets-manager.json @@ -360,7 +360,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new secret. A secret can be a password, a set of \n credentials such as a user name and password, an OAuth token, or other secret information \n that you store in an encrypted form in Secrets Manager. The secret also \n includes the connection information to access a database or other service, which Secrets Manager \n doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.
\nFor secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services.\n\n
\nFor information about creating a secret in the console, see Create a secret.
\nTo create a secret, you can provide the secret value to be encrypted in either the\n SecretString
parameter or the SecretBinary
parameter, but not both. \n If you include SecretString
or SecretBinary
\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label AWSCURRENT
to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,\n you must make sure the JSON you store in the SecretString
matches the JSON structure of\n a database secret.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager
. If this key \n doesn't already exist in your account, then Secrets Manager creates it for you automatically. All\n users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager
. \n Creating aws/secretsmanager
can result in a one-time significant delay in returning the \n result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager
to encrypt the secret, and you must create \n and use a customer managed KMS key.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary
or SecretString
because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n Required permissions: \n secretsmanager:CreateSecret
. If you \n include tags in the secret, you also need secretsmanager:TagResource
. To add replica Regions, you must also have secretsmanager:ReplicateSecretToRegions
.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager
, you need kms:GenerateDataKey
and kms:Decrypt
permission to the key.
Creates a new secret. A secret can be a password, a set of \n credentials such as a user name and password, an OAuth token, or other secret information \n that you store in an encrypted form in Secrets Manager. The secret also \n includes the connection information to access a database or other service, which Secrets Manager \n doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.
\nFor secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services.\n\n
\nFor information about creating a secret in the console, see Create a secret.
\nTo create a secret, you can provide the secret value to be encrypted in either the\n SecretString
parameter or the SecretBinary
parameter, but not both. \n If you include SecretString
or SecretBinary
\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label AWSCURRENT
to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,\n you must make sure the JSON you store in the SecretString
matches the JSON structure of\n a database secret.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager
. If this key \n doesn't already exist in your account, then Secrets Manager creates it for you automatically. All\n users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager
. \n Creating aws/secretsmanager
can result in a one-time significant delay in returning the \n result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager
to encrypt the secret, and you must create \n and use a customer managed KMS key.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary
or SecretString
because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n Required permissions: \n secretsmanager:CreateSecret
. If you \n include tags in the secret, you also need secretsmanager:TagResource
. To add replica Regions, you must also have secretsmanager:ReplicateSecretToRegions
.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager
, you need kms:GenerateDataKey
and kms:Decrypt
permission to the key.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
\nCreates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString
value or a new SecretBinary
value.
We recommend you avoid calling PutSecretValue
at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue
more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages
. \n If you don't include VersionStages
, then Secrets Manager automatically\n moves the staging label AWSCURRENT
to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT
to it. \n If this operation moves the staging label AWSCURRENT
from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS
to\n the version that AWSCURRENT
was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken
\n that matches an existing version's VersionId, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary
, SecretString
, or RotationToken
because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n Required permissions: \n secretsmanager:PutSecretValue
. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString
value or a new SecretBinary
value.
We recommend you avoid calling PutSecretValue
at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue
more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages
. \n If you don't include VersionStages
, then Secrets Manager automatically\n moves the staging label AWSCURRENT
to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT
to it. \n If this operation moves the staging label AWSCURRENT
from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS
to\n the version that AWSCURRENT
was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken
\n that matches an existing version's VersionId, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary
, SecretString
, or RotationToken
because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n Required permissions: \n secretsmanager:PutSecretValue
. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
\nModifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
\nTo change the rotation configuration of a secret, use RotateSecret instead.
\nTo change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.
\nWe recommend you avoid calling UpdateSecret
at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret
to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
If you include SecretString
or SecretBinary
to create a new\n secret version, Secrets Manager automatically moves the staging label AWSCURRENT
to the new\n version. Then it attaches the label AWSPREVIOUS
\n to the version that AWSCURRENT
was removed from.
If you call this operation with a ClientRequestToken
that matches an existing version's \n VersionId
, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary
or SecretString
because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n Required permissions: \n secretsmanager:UpdateSecret
. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey
, kms:Encrypt
, and \n kms:Decrypt
permissions on the key. If you change the KMS key and you don't have kms:Encrypt
permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information, see \n Secret encryption and decryption.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
\nTo change the rotation configuration of a secret, use RotateSecret instead.
\nTo change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.
\nWe recommend you avoid calling UpdateSecret
at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret
to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
If you include SecretString
or SecretBinary
to create a new\n secret version, Secrets Manager automatically moves the staging label AWSCURRENT
to the new\n version. Then it attaches the label AWSPREVIOUS
\n to the version that AWSCURRENT
was removed from.
If you call this operation with a ClientRequestToken
that matches an existing version's \n VersionId
, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary
or SecretString
because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n Required permissions: \n secretsmanager:UpdateSecret
. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey
, kms:Encrypt
, and \n kms:Decrypt
permissions on the key. If you change the KMS key and you don't have kms:Encrypt
permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information, see \n Secret encryption and decryption.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
\nThe ARN, key ID, or alias of the KMS key that Secrets Manager \n uses to encrypt new secret versions as well as any existing versions with the staging labels \n AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. If you don't have kms:Encrypt
permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.
A key alias is always prefixed by alias/
, for example alias/aws/secretsmanager
.\n For more information, see About aliases.
If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time \n significant delay in returning the result.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this\n operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in\n a different account, then you must use a customer managed key and provide the ARN of that KMS key in\n this field. The user making the call must have permissions to both the secret and the KMS key in\n their respective accounts.
The ARN, key ID, or alias of the KMS key that Secrets Manager \n uses to encrypt new secret versions as well as any existing versions with the staging labels \n AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. If you don't have kms:Encrypt
permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.
A key alias is always prefixed by alias/
, for example alias/aws/secretsmanager
.\n For more information, see About aliases.
If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time \n significant delay in returning the result.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this\n operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in\n a different account, then you must use a customer managed key and provide the ARN of that KMS key in\n this field. The user making the call must have permissions to both the secret and the KMS key in\n their respective accounts.
You can use the tax setting API to programmatically set, modify, and delete the tax\n registration number (TRN), associated business legal name, and address (Collectively referred\n to as \"TRN information\"). You can also programmatically view TRN information and tax addresses\n (\"Tax profiles\").
\nYou can use this API to automate your TRN information settings instead of manually using\n the console.
\nService Endpoint
\nhttps://tax.us-east-1.amazonaws.com
\nThe pricing model for queries in an account.
" + "smithy.api#documentation": "The pricing model for queries in an account.
\nThe QueryPricingModel
parameter is used by several Timestream operations; however, the UpdateAccountSettings
API operation doesn't recognize any values other than COMPUTE_UNITS
.
Creates a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide. \n
\nCreating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.
", + "smithy.api#documentation": "Creates a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the\n Amazon Web Services Telco Network Builder User Guide.
\nCreating a function package is the first step for creating a network in AWS TNB. This\n request creates an empty container with an ID. The next step is to upload the actual CSAR\n zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.
", "smithy.api#examples": [ { "title": "Create a Sol function package", @@ -221,7 +221,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide.
\nOnce you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.
", + "smithy.api#documentation": "Creates a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network\n package. For more information about network instances, Network instances in the\n Amazon Web Services Telco Network Builder User Guide.
\nOnce you create a network instance, you can instantiate it. To instantiate a network,\n see InstantiateSolNetworkInstance.
", "smithy.api#examples": [ { "title": "Create a Sol Network Instance", @@ -361,7 +361,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide. \n
\nA network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.
\nThis request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent.
", + "smithy.api#documentation": "Creates a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the\n Amazon Web Services Telco Network Builder User Guide.
\nA network package consists of a network service descriptor (NSD) file (required) and any\n additional files (optional), such as scripts specific to your needs. For example, if you\n have multiple function packages in your network package, you can use the NSD to define\n which network functions should run in certain VPCs, subnets, or EKS clusters.
\nThis request creates an empty network package container with an ID. Once you create a\n network package, you can upload the network package content using PutSolNetworkPackageContent.
", "smithy.api#examples": [ { "title": "Create a Sol network package", @@ -478,7 +478,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
\nTo delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.\n
", + "smithy.api#documentation": "Deletes a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
\nTo delete a function package, the package must be in a disabled state. To disable a\n function package, see UpdateSolFunctionPackage.
", "smithy.api#examples": [ { "title": "Delete a function package", @@ -537,7 +537,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
\nTo delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.
", + "smithy.api#documentation": "Deletes a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
\nTo delete a network instance, the instance must be in a stopped or terminated state. To\n terminate a network instance, see TerminateSolNetworkInstance.
", "smithy.api#examples": [ { "title": "Delete a Sol Network Instance.", @@ -596,7 +596,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
\nTo delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.
", + "smithy.api#documentation": "Deletes network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
\nTo delete a network package, the package must be in a disable state. To disable a\n network package, see UpdateSolNetworkPackage.
", "smithy.api#examples": [ { "title": "Delete a Sol network package", @@ -717,7 +717,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the details of a network function instance, including the instantation state and metadata from the function package descriptor in the network function package.
\nA network function instance is a function in a function package .
", + "smithy.api#documentation": "Gets the details of a network function instance, including the instantiation state and\n metadata from the function package descriptor in the network function package.
\nA network function instance is a function in a function package .
", "smithy.api#examples": [ { "title": "Get a Sol Network Function Instance details", @@ -910,7 +910,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the details of an individual function package, such as the operational state and whether the package is in use.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..
", + "smithy.api#documentation": "Gets the details of an individual function package, such as the operational state and\n whether the package is in use.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..
", "smithy.api#examples": [ { "title": "Describe a function package with correct vnfPkgId", @@ -1098,7 +1098,7 @@ "accept": { "target": "com.amazonaws.tnb#DescriptorContentType", "traits": { - "smithy.api#documentation": "Indicates which content types, expressed as MIME types, the client is able to understand.
", + "smithy.api#documentation": "Indicates which content types, expressed as MIME types, the client is able to\n understand.
", "smithy.api#httpHeader": "Accept", "smithy.api#required": {} } @@ -1217,7 +1217,7 @@ "vnfdId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Function package descriptor ID.
" + "smithy.api#documentation": "Function package descriptor ID.
" } }, "vnfProvider": { @@ -1462,7 +1462,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
", + "smithy.api#documentation": "Gets the details of a network operation, including the tasks involved in the network\n operation and the status of the tasks.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
", "smithy.api#examples": [ { "title": "Get Sol Network Instantiate operation", @@ -1476,6 +1476,85 @@ "operationState": "COMPLETED", "lcmOperationType": "INSTANTIATE", "metadata": { + "instantiateMetadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", + "additionalParamsForNs": { + "cidr_block": "10.0.0.0/16", + "availability_zone": "us-west-2a" + } + }, + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + }, + "tasks": [ + { + "taskName": "HookExecution", + "taskContext": { + "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" + }, + "taskStatus": "IN_PROGRESS", + "taskStartTime": "2022-06-10T19:48:34Z", + "taskEndTime": "2022-06-10T21:48:33Z" + } + ] + } + }, + { + "title": "Get Sol Network Update operation", + "input": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + }, + "output": { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "UPDATE", + "updateType": "UPDATE_NS", + "metadata": { + "updateNsMetadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", + "additionalParamsForNs": { + "cidr_block": "10.0.0.0/16", + "availability_zone": "us-west-2a" + } + }, + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + }, + "tasks": [ + { + "taskName": "HookExecution", + "taskContext": { + "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" + }, + "taskStatus": "IN_PROGRESS", + "taskStartTime": "2022-06-10T19:48:34Z", + "taskEndTime": "2022-06-10T21:48:33Z" + } + ] + } + }, + { + "title": "Get Sol Network Update operation", + "input": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + }, + "output": { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "UPDATE", + "updateType": "MODIFY_VNF_INFORMATION", + "metadata": { + "modifyVnfInfoMetadata": { + "vnfInstanceId": "fi-0d5b823eb5c2a9241", + "vnfConfigurableProperties": { + "pcf.port": "8080", + "pcf.pods": "10" + } + }, "createdAt": "2022-06-10T19:48:34Z", "lastModified": "2022-06-10T21:48:33Z" }, @@ -1561,6 +1640,24 @@ "com.amazonaws.tnb#GetSolNetworkOperationMetadata": { "type": "structure", "members": { + "updateNsMetadata": { + "target": "com.amazonaws.tnb#UpdateNsMetadata", + "traits": { + "smithy.api#documentation": "Metadata related to the network operation occurrence for network instance updates.\n This is populated only if the lcmOperationType is UPDATE
and the\n updateType is UPDATE_NS
.
Metadata related to the network operation occurrence for network function updates in a network instance.\n This is populated only if the lcmOperationType is UPDATE
and the\n updateType is MODIFY_VNF_INFORMATION
.
Metadata related to the network operation occurrence for network instantiation.\n This is populated only if the lcmOperationType is INSTANTIATE
.
Type of the operation represented by this occurrence.
" } }, + "updateType": { + "target": "com.amazonaws.tnb#UpdateSolNetworkType", + "traits": { + "smithy.api#documentation": "Type of the update. Only present if the network operation\n lcmOperationType is UPDATE
.
Metadata related to the onboarded network service descriptor in the network package.
" + "smithy.api#documentation": "Metadata related to the onboarded network service descriptor in the network\n package.
" } }, "createdAt": { @@ -2053,7 +2156,7 @@ "vnfPkgIds": { "target": "com.amazonaws.tnb#VnfPkgIdList", "traits": { - "smithy.api#documentation": "Identifies the function package for the function package descriptor referenced by the onboarded network package.
", + "smithy.api#documentation": "Identifies the function package for the function package descriptor referenced by the\n onboarded network package.
", "smithy.api#required": {} } }, @@ -2140,6 +2243,27 @@ "smithy.api#documentation": "The metadata of a network function.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" } }, + "com.amazonaws.tnb#InstantiateMetadata": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "The network service descriptor used for instantiating the network instance.
", + "smithy.api#required": {} + } + }, + "additionalParamsForNs": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The configurable properties used during instantiation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata related to the configuration properties used during instantiation of the network instance.
" + } + }, "com.amazonaws.tnb#InstantiateSolNetworkInstance": { "type": "operation", "input": { @@ -2169,7 +2293,7 @@ } ], "traits": { - "smithy.api#documentation": "Instantiates a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
\nBefore you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.
", + "smithy.api#documentation": "Instantiates a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
\nBefore you can instantiate a network instance, you have to create a network instance.\n For more information, see CreateSolNetworkInstance.
", "smithy.api#examples": [ { "title": "Instantiate a Sol Network Instance", @@ -2234,7 +2358,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" } } }, @@ -2255,7 +2379,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" } } }, @@ -3052,7 +3176,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists details for a network operation, including when the operation started and the status of the operation.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
", + "smithy.api#documentation": "Lists details for a network operation, including when the operation started and the\n status of the operation.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
", "smithy.api#examples": [ { "title": "List Sol Network Instantiate operations", @@ -3066,6 +3190,7 @@ "operationState": "COMPLETED", "lcmOperationType": "INSTANTIATE", "metadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", "createdAt": "2022-06-10T19:48:34Z", "lastModified": "2022-06-10T21:48:33Z" } @@ -3092,12 +3217,59 @@ "detail": "An error occurred (InsufficientInstanceCapacity) when calling the RunInstances operation (reached max retries: 4). We currently do not have sufficient capacity in the Availability Zone you requested" }, "metadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", "createdAt": "2022-06-10T19:48:33Z", "lastModified": "2022-06-10T19:48:33Z" } } ] } + }, + { + "title": "List Sol Network Update operations", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241" + }, + "output": { + "networkOperations": [ + { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "UPDATE", + "updateType": "MODIFY_VNF_INFORMATION", + "metadata": { + "vnfInstanceId": "fi-0d5b823eb5c2a9241", + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + }, + { + "title": "List Sol Network Update operations", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241" + }, + "output": { + "networkOperations": [ + { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "UPDATE", + "updateType": "UPDATE_NS", + "metadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } } ], "smithy.api#http": { @@ -3151,6 +3323,12 @@ "smithy.api#required": {} } }, + "updateType": { + "target": "com.amazonaws.tnb#UpdateSolNetworkType", + "traits": { + "smithy.api#documentation": "Type of the update. Only present if the network operation lcmOperationType is UPDATE
.
Network instance id filter, to retrieve network operations associated to a network instance.
", + "smithy.api#httpQuery": "nsInstanceId" + } + }, "maxResults": { "target": "smithy.api#Integer", "traits": { @@ -3197,6 +3382,18 @@ "com.amazonaws.tnb#ListSolNetworkOperationsMetadata": { "type": "structure", "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "The network service descriptor id used for the operation.
\nOnly present if the updateType is UPDATE_NS
.
The network function id used for the operation.
\nOnly present if the updateType is MODIFY_VNF_INFO
.
Identifies the function package for the function package descriptor referenced by the onboarded network package.
" + "smithy.api#documentation": "Identifies the function package for the function package descriptor referenced by the\n onboarded network package.
" } }, "metadata": { @@ -3593,6 +3790,28 @@ "smithy.api#output": {} } }, + "com.amazonaws.tnb#ModifyVnfInfoMetadata": { + "type": "structure", + "members": { + "vnfInstanceId": { + "target": "com.amazonaws.tnb#VnfInstanceId", + "traits": { + "smithy.api#documentation": "The network function instance that was updated in the network instance.
", + "smithy.api#required": {} + } + }, + "vnfConfigurableProperties": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The configurable properties used during update of the network function instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata related to the configuration properties used during update of a specific\n network function in a network instance.
" + } + }, "com.amazonaws.tnb#NetworkArtifactMeta": { "type": "structure", "members": { @@ -3681,12 +3900,24 @@ "smithy.api#enumValue": "NOT_INSTANTIATED" } }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, "IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPAIRED" } }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, "STOPPED": { "target": "smithy.api#Unit", "traits": { @@ -3705,6 +3936,12 @@ "smithy.api#enumValue": "INSTANTIATE_IN_PROGRESS" } }, + "INTENT_TO_UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTENT_TO_UPDATE_IN_PROGRESS" + } + }, "UPDATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { @@ -3951,7 +4188,7 @@ } }, "file": { - "target": "smithy.api#Blob", + "target": "com.amazonaws.tnb#SensitiveBlob", "traits": { "smithy.api#documentation": "Function package file.
", "smithy.api#httpPayload": {}, @@ -4112,7 +4349,7 @@ } }, "file": { - "target": "smithy.api#Blob", + "target": "com.amazonaws.tnb#SensitiveBlob", "traits": { "smithy.api#documentation": "Network package file.
", "smithy.api#httpPayload": {}, @@ -4208,6 +4445,12 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.tnb#SensitiveBlob": { + "type": "blob", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.tnb#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -4363,7 +4606,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.
", + "smithy.api#documentation": "\n Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps\n you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of\n your telecommunication network functions throughout planning, deployment, and\n post-deployment activities.
", "smithy.api#title": "AWS Telco Network Builder", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5259,7 +5502,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" } } }, @@ -5279,7 +5522,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" } } }, @@ -5388,6 +5631,27 @@ "smithy.api#output": {} } }, + "com.amazonaws.tnb#UpdateNsMetadata": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "The network service descriptor used for updating the network instance.
", + "smithy.api#required": {} + } + }, + "additionalParamsForNs": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The configurable properties used during update.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata related to the configuration properties used during update of a network instance.
" + } + }, "com.amazonaws.tnb#UpdateSolFunctionPackage": { "type": "operation", "input": { @@ -5510,7 +5774,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
", + "smithy.api#documentation": "Update a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
\nChoose the updateType parameter to target the necessary update of the network instance.
", "smithy.api#examples": [ { "title": "Update a Sol Network Instance", @@ -5534,6 +5798,29 @@ "Name": "Resource" } } + }, + { + "title": "Update a Sol Network Instance", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "updateType": "UPDATE_NS", + "updateNs": { + "nsdInfoId": "np-0d5b823eb5c2a9241", + "additionalParamsForNs": { + "cidr_block": "10.0.0.0/16", + "availability_zone": "us-west-2a" + } + }, + "tags": { + "Name": "Resource" + } + }, + "output": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241", + "tags": { + "Name": "Resource" + } + } } ], "smithy.api#http": { @@ -5557,20 +5844,26 @@ "updateType": { "target": "com.amazonaws.tnb#UpdateSolNetworkType", "traits": { - "smithy.api#documentation": "The type of update.
", + "smithy.api#documentation": "The type of update.
\nUse the MODIFY_VNF_INFORMATION
update type, to update a specific network function\n configuration, in the network instance.
Use the UPDATE_NS
update type, to update the network instance to a\n new network service descriptor.
Identifies the network function information parameters and/or the configurable properties of the network function to be modified.
" + "smithy.api#documentation": "Identifies the network function information parameters and/or the configurable\n properties of the network function to be modified.
\nInclude this property only if the update type is MODIFY_VNF_INFORMATION
.
Identifies the network service descriptor and the configurable\n properties of the descriptor, to be used for the update.
\nInclude this property only if the update type is UPDATE_NS
.
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" } } }, @@ -5590,7 +5883,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" } } }, @@ -5611,7 +5904,7 @@ "vnfConfigurableProperties": { "target": "smithy.api#Document", "traits": { - "smithy.api#documentation": "Provides values for the configurable properties declared in the function package descriptor.
", + "smithy.api#documentation": "Provides values for the configurable properties declared in the function package\n descriptor.
", "smithy.api#required": {} } } @@ -5713,6 +6006,27 @@ "smithy.api#output": {} } }, + "com.amazonaws.tnb#UpdateSolNetworkServiceData": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID of the network service descriptor.
", + "smithy.api#required": {} + } + }, + "additionalParamsForNs": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Values for the configurable properties declared in the network service descriptor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information parameters and/or the configurable properties for a network descriptor used for update.
" + } + }, "com.amazonaws.tnb#UpdateSolNetworkType": { "type": "enum", "members": { @@ -5721,6 +6035,12 @@ "traits": { "smithy.api#enumValue": "MODIFY_VNF_INFORMATION" } + }, + "UPDATE_NS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_NS" + } } } }, @@ -5767,7 +6087,7 @@ } ], "traits": { - "smithy.api#documentation": "Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "smithy.api#documentation": "Validates function package content. This can be used as a dry run before uploading\n function package content with PutSolFunctionPackageContent.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", "smithy.api#examples": [ { "title": "Validate a Function Package content", @@ -5817,7 +6137,7 @@ } }, "file": { - "target": "smithy.api#Blob", + "target": "com.amazonaws.tnb#SensitiveBlob", "traits": { "smithy.api#documentation": "Function package file.
", "smithy.api#httpPayload": {}, @@ -5916,7 +6236,7 @@ } ], "traits": { - "smithy.api#documentation": "Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", + "smithy.api#documentation": "Validates network package content. This can be used as a dry run before uploading\n network package content with PutSolNetworkPackageContent.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", "smithy.api#examples": [ { "title": "Validate the network package content of a NSD archive", @@ -5978,7 +6298,7 @@ } }, "file": { - "target": "smithy.api#Blob", + "target": "com.amazonaws.tnb#SensitiveBlob", "traits": { "smithy.api#documentation": "Network package file.
", "smithy.api#httpPayload": {}, @@ -6069,7 +6389,7 @@ } }, "traits": { - "smithy.api#documentation": "Unable to process the request because the client provided input failed to satisfy request constraints.
", + "smithy.api#documentation": "Unable to process the request because the client provided input failed to satisfy\n request constraints.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk-codegen/aws-models/workspaces-thin-client.json b/codegen/sdk-codegen/aws-models/workspaces-thin-client.json index 20322a9b476..aa00d2b127d 100644 --- a/codegen/sdk-codegen/aws-models/workspaces-thin-client.json +++ b/codegen/sdk-codegen/aws-models/workspaces-thin-client.json @@ -996,7 +996,7 @@ "deviceCreationTags": { "target": "com.amazonaws.workspacesthinclient#DeviceCreationTagsMap", "traits": { - "smithy.api#documentation": "\"The tag keys and optional values for the newly created devices for this environment.\"
" + "smithy.api#documentation": "The tag keys and optional values for the newly created devices for this environment.
" } } }, diff --git a/sdk.properties b/sdk.properties index 6fb9071f7b0..0ecd6cd91c8 100644 --- a/sdk.properties +++ b/sdk.properties @@ -1,10 +1,6 @@ -excludeModels=mobile,codestar,codestar-connections,codestar-notifications +# Use this line to only include one or more AWS services +# onlyIncludeModels=s3,sts,dynamodb + +# Use this line to exclude one or more AWS services: +# excludeModels=s3,sts,dynamodb -# One service from each AWS protocol: -# - S3 is RestXML -# - STS is AwsQuery -# - EC2 is Ec2Query -# - Bedrock-runtime is RestJSON1 -# - DynamoDB is awsJSON 1.0 -# - Cognito-identity is awsJSON 1.1 -# onlyIncludeModels=s3,sts,dynamodb,sqs,ecs,kinesis,mediaconvert,transcribe-streaming,iam,cognito-identity,cloudwatch-logs,sso-admin,ec2,s3-control