diff --git a/codegen/sdk-codegen/aws-models/appintegrations.2020-07-29.json b/codegen/sdk-codegen/aws-models/appintegrations.2020-07-29.json index bca0a85f1f4..d5ec1f77fe5 100644 --- a/codegen/sdk-codegen/aws-models/appintegrations.2020-07-29.json +++ b/codegen/sdk-codegen/aws-models/appintegrations.2020-07-29.json @@ -46,6 +46,9 @@ "type": "service", "version": "2020-07-29", "operations": [ + { + "target": "com.amazonaws.appintegrations#CreateApplication" + }, { "target": "com.amazonaws.appintegrations#CreateDataIntegration" }, @@ -58,12 +61,18 @@ { "target": "com.amazonaws.appintegrations#DeleteEventIntegration" }, + { + "target": "com.amazonaws.appintegrations#GetApplication" + }, { "target": "com.amazonaws.appintegrations#GetDataIntegration" }, { "target": "com.amazonaws.appintegrations#GetEventIntegration" }, + { + "target": "com.amazonaws.appintegrations#ListApplications" + }, { "target": "com.amazonaws.appintegrations#ListDataIntegrationAssociations" }, @@ -85,6 +94,9 @@ { "target": "com.amazonaws.appintegrations#UntagResource" }, + { + "target": "com.amazonaws.appintegrations#UpdateApplication" + }, { "target": "com.amazonaws.appintegrations#UpdateDataIntegration" }, @@ -853,6 +865,118 @@ } } }, + "com.amazonaws.appintegrations#ApplicationApprovedOrigins": { + "type": "list", + "member": { + "target": "com.amazonaws.appintegrations#ApplicationTrustedSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.appintegrations#ApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\/\\._ \\-]+$" + } + }, + "com.amazonaws.appintegrations#ApplicationNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\/\\._\\-]+$" + } + }, + "com.amazonaws.appintegrations#ApplicationSourceConfig": { + "type": "structure", + "members": { + "ExternalUrlConfig": { + "target": "com.amazonaws.appintegrations#ExternalUrlConfig", + "traits": { + "smithy.api#documentation": "
The external URL source for the application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for where the application should be loaded from.
" + } + }, + "com.amazonaws.appintegrations#ApplicationSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.appintegrations#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Application.
" + } + }, + "Id": { + "target": "com.amazonaws.appintegrations#UUID", + "traits": { + "smithy.api#documentation": "A unique identifier for the Application.
" + } + }, + "Name": { + "target": "com.amazonaws.appintegrations#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "Namespace": { + "target": "com.amazonaws.appintegrations#ApplicationNamespace", + "traits": { + "smithy.api#documentation": "The namespace of the application.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appintegrations#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the application was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.appintegrations#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the application was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about the Application.
" + } + }, + "com.amazonaws.appintegrations#ApplicationTrustedSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^\\w+\\:\\/\\/.*$" + } + }, + "com.amazonaws.appintegrations#ApplicationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.appintegrations#ApplicationSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.appintegrations#Arn": { "type": "string", "traits": { @@ -863,6 +987,16 @@ "smithy.api#pattern": "^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" } }, + "com.amazonaws.appintegrations#ArnOrUUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})(:[\\w\\$]+)?$" + } + }, "com.amazonaws.appintegrations#ClientAssociationMetadata": { "type": "map", "key": { @@ -882,6 +1016,143 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.appintegrations#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.appintegrations#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.appintegrations#CreateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appintegrations#AccessDeniedException" + }, + { + "target": "com.amazonaws.appintegrations#DuplicateResourceException" + }, + { + "target": "com.amazonaws.appintegrations#InternalServiceError" + }, + { + "target": "com.amazonaws.appintegrations#InvalidRequestException" + }, + { + "target": "com.amazonaws.appintegrations#ResourceQuotaExceededException" + }, + { + "target": "com.amazonaws.appintegrations#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API is in preview release and subject to change.
\nCreates and persists an Application resource.
", + "smithy.api#examples": [ + { + "title": "To create an application", + "documentation": "The following creates an application named My Application with access url https://example.com.", + "input": { + "Name": "My Application", + "Namespace": "myapplication", + "Description": "My first application.", + "ApplicationSourceConfig": { + "ExternalUrlConfig": { + "AccessUrl": "https://example.com" + } + } + }, + "output": { + "Id": "98542c53-e8ac-4570-9c85-c6552c8d9c5e", + "Arn": "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/applications", + "code": 200 + } + } + }, + "com.amazonaws.appintegrations#CreateApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appintegrations#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
", + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.appintegrations#ApplicationNamespace", + "traits": { + "smithy.api#documentation": "The namespace of the application.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appintegrations#Description", + "traits": { + "smithy.api#documentation": "The description of the application.
" + } + }, + "ApplicationSourceConfig": { + "target": "com.amazonaws.appintegrations#ApplicationSourceConfig", + "traits": { + "smithy.api#documentation": "The configuration for where the application should be loaded from.
", + "smithy.api#required": {} + } + }, + "Subscriptions": { + "target": "com.amazonaws.appintegrations#SubscriptionList", + "traits": { + "smithy.api#documentation": "The events that the application subscribes.
" + } + }, + "Publications": { + "target": "com.amazonaws.appintegrations#PublicationList", + "traits": { + "smithy.api#documentation": "The events that the application publishes.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.appintegrations#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.appintegrations#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appintegrations#CreateApplicationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.appintegrations#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Application.
" + } + }, + "Id": { + "target": "com.amazonaws.appintegrations#UUID", + "traits": { + "smithy.api#documentation": "A unique identifier for the Application.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.appintegrations#CreateDataIntegration": { "type": "operation", "input": { @@ -1392,6 +1663,16 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\/\\._\\-]+$" } }, + "com.amazonaws.appintegrations#EventDefinitionSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + }, + "smithy.api#pattern": "^.*$" + } + }, "com.amazonaws.appintegrations#EventFilter": { "type": "structure", "members": { @@ -1519,6 +1800,37 @@ } } }, + "com.amazonaws.appintegrations#EventName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\/\\._\\-]+::[a-zA-Z0-9\\/\\._\\-]+(?:\\*)?$" + } + }, + "com.amazonaws.appintegrations#ExternalUrlConfig": { + "type": "structure", + "members": { + "AccessUrl": { + "target": "com.amazonaws.appintegrations#URL", + "traits": { + "smithy.api#documentation": "The URL to access the application.
", + "smithy.api#required": {} + } + }, + "ApprovedOrigins": { + "target": "com.amazonaws.appintegrations#ApplicationApprovedOrigins", + "traits": { + "smithy.api#documentation": "Additional URLs to allow list if different than the access URL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The external URL source for the application.
" + } + }, "com.amazonaws.appintegrations#Fields": { "type": "string", "traits": { @@ -1583,13 +1895,13 @@ } } }, - "com.amazonaws.appintegrations#GetDataIntegration": { + "com.amazonaws.appintegrations#GetApplication": { "type": "operation", "input": { - "target": "com.amazonaws.appintegrations#GetDataIntegrationRequest" + "target": "com.amazonaws.appintegrations#GetApplicationRequest" }, "output": { - "target": "com.amazonaws.appintegrations#GetDataIntegrationResponse" + "target": "com.amazonaws.appintegrations#GetApplicationResponse" }, "errors": [ { @@ -1609,21 +1921,40 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about the DataIntegration.
\nYou cannot create a DataIntegration association for a DataIntegration that has been previously associated. \nUse a different DataIntegration, or recreate the DataIntegration using the \nCreateDataIntegration API.
\nThis API is in preview release and subject to change.
\nGet an Application resource.
", + "smithy.api#examples": [ + { + "title": "To get an application", + "documentation": "The following retrives an application.", + "input": { + "Arn": "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e" + }, + "output": { + "Name": "My Application", + "Namespace": "myapplication", + "Description": "My first application.", + "ApplicationSourceConfig": { + "ExternalUrlConfig": { + "AccessUrl": "https://example.com" + } + } + } + } + ], "smithy.api#http": { "method": "GET", - "uri": "/dataIntegrations/{Identifier}", + "uri": "/applications/{Arn}", "code": 200 } } }, - "com.amazonaws.appintegrations#GetDataIntegrationRequest": { + "com.amazonaws.appintegrations#GetApplicationRequest": { "type": "structure", "members": { - "Identifier": { - "target": "com.amazonaws.appintegrations#Identifier", + "Arn": { + "target": "com.amazonaws.appintegrations#ArnOrUUID", "traits": { - "smithy.api#documentation": "A unique identifier.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1633,47 +1964,171 @@ "smithy.api#input": {} } }, - "com.amazonaws.appintegrations#GetDataIntegrationResponse": { + "com.amazonaws.appintegrations#GetApplicationResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.appintegrations#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DataIntegration.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Application.
" } }, "Id": { "target": "com.amazonaws.appintegrations#UUID", "traits": { - "smithy.api#documentation": "A unique identifier.
" + "smithy.api#documentation": "A unique identifier for the Application.
" } }, "Name": { - "target": "com.amazonaws.appintegrations#Name", + "target": "com.amazonaws.appintegrations#ApplicationName", "traits": { - "smithy.api#documentation": "The name of the DataIntegration.
" + "smithy.api#documentation": "The name of the application.
" + } + }, + "Namespace": { + "target": "com.amazonaws.appintegrations#ApplicationNamespace", + "traits": { + "smithy.api#documentation": "The namespace of the application.
" } }, "Description": { "target": "com.amazonaws.appintegrations#Description", "traits": { - "smithy.api#documentation": "The KMS key for the DataIntegration.
" + "smithy.api#documentation": "The description of the application.
" } }, - "KmsKey": { - "target": "com.amazonaws.appintegrations#NonBlankString", + "ApplicationSourceConfig": { + "target": "com.amazonaws.appintegrations#ApplicationSourceConfig", "traits": { - "smithy.api#documentation": "The KMS key for the DataIntegration.
" + "smithy.api#documentation": "The configuration for where the application should be loaded from.
" } }, - "SourceURI": { - "target": "com.amazonaws.appintegrations#SourceURI", + "Subscriptions": { + "target": "com.amazonaws.appintegrations#SubscriptionList", "traits": { - "smithy.api#documentation": "The URI of the data source.
" + "smithy.api#documentation": "The events that the application subscribes.
" } }, - "ScheduleConfiguration": { - "target": "com.amazonaws.appintegrations#ScheduleConfiguration", + "Publications": { + "target": "com.amazonaws.appintegrations#PublicationList", + "traits": { + "smithy.api#documentation": "The events that the application publishes.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appintegrations#Timestamp", + "traits": { + "smithy.api#documentation": "The created time of the Application.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.appintegrations#Timestamp", + "traits": { + "smithy.api#documentation": "The last modified time of the Application.
" + } + }, + "Tags": { + "target": "com.amazonaws.appintegrations#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appintegrations#GetDataIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.appintegrations#GetDataIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.appintegrations#GetDataIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appintegrations#AccessDeniedException" + }, + { + "target": "com.amazonaws.appintegrations#InternalServiceError" + }, + { + "target": "com.amazonaws.appintegrations#InvalidRequestException" + }, + { + "target": "com.amazonaws.appintegrations#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appintegrations#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the DataIntegration.
\nYou cannot create a DataIntegration association for a DataIntegration that has been previously associated. \nUse a different DataIntegration, or recreate the DataIntegration using the \nCreateDataIntegration API.
\nA unique identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appintegrations#GetDataIntegrationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.appintegrations#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DataIntegration.
" + } + }, + "Id": { + "target": "com.amazonaws.appintegrations#UUID", + "traits": { + "smithy.api#documentation": "A unique identifier.
" + } + }, + "Name": { + "target": "com.amazonaws.appintegrations#Name", + "traits": { + "smithy.api#documentation": "The name of the DataIntegration.
" + } + }, + "Description": { + "target": "com.amazonaws.appintegrations#Description", + "traits": { + "smithy.api#documentation": "The KMS key for the DataIntegration.
" + } + }, + "KmsKey": { + "target": "com.amazonaws.appintegrations#NonBlankString", + "traits": { + "smithy.api#documentation": "The KMS key for the DataIntegration.
" + } + }, + "SourceURI": { + "target": "com.amazonaws.appintegrations#SourceURI", + "traits": { + "smithy.api#documentation": "The URI of the data source.
" + } + }, + "ScheduleConfiguration": { + "target": "com.amazonaws.appintegrations#ScheduleConfiguration", "traits": { "smithy.api#documentation": "The name of the data and how often it should be pulled from the source.
" } @@ -1841,6 +2296,105 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.appintegrations#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.appintegrations#ListApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.appintegrations#ListApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appintegrations#AccessDeniedException" + }, + { + "target": "com.amazonaws.appintegrations#InternalServiceError" + }, + { + "target": "com.amazonaws.appintegrations#InvalidRequestException" + }, + { + "target": "com.amazonaws.appintegrations#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API is in preview release and subject to change.
\nLists applications in the account.
", + "smithy.api#examples": [ + { + "title": "To list applications in the account", + "documentation": "The following lists application summary in the account.", + "input": { + "MaxResults": 1 + }, + "output": { + "Applications": [ + { + "Id": "98542c53-e8ac-4570-9c85-c6552c8d9c5e", + "Arn": "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e", + "Name": "My Application", + "Namespace": "myapplication" + } + ], + "NextToken": "abc" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/applications", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Applications", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.appintegrations#ListApplicationsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.appintegrations#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.appintegrations#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appintegrations#ListApplicationsResponse": { + "type": "structure", + "members": { + "Applications": { + "target": "com.amazonaws.appintegrations#ApplicationsList", + "traits": { + "smithy.api#documentation": "The Applications associated with this account.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appintegrations#NextToken", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.appintegrations#ListDataIntegrationAssociations": { "type": "operation", "input": { @@ -1872,6 +2426,12 @@ "method": "GET", "uri": "/dataIntegrations/{DataIntegrationIdentifier}/associations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataIntegrationAssociations", + "pageSize": "MaxResults" } } }, @@ -1953,6 +2513,12 @@ "method": "GET", "uri": "/dataIntegrations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataIntegrations", + "pageSize": "MaxResults" } } }, @@ -2029,6 +2595,12 @@ "method": "GET", "uri": "/eventIntegrations/{EventIntegrationName}/associations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EventIntegrationAssociations", + "pageSize": "MaxResults" } } }, @@ -2110,6 +2682,12 @@ "method": "GET", "uri": "/eventIntegrations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EventIntegrations", + "pageSize": "MaxResults" } } }, @@ -2290,6 +2868,46 @@ "smithy.api#documentation": "The configuration for what data should be pulled from the source.
" } }, + "com.amazonaws.appintegrations#Publication": { + "type": "structure", + "members": { + "Event": { + "target": "com.amazonaws.appintegrations#EventName", + "traits": { + "smithy.api#documentation": "The name of the publication.
", + "smithy.api#required": {} + } + }, + "Schema": { + "target": "com.amazonaws.appintegrations#EventDefinitionSchema", + "traits": { + "smithy.api#documentation": "The JSON schema of the publication event.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appintegrations#Description", + "traits": { + "smithy.api#documentation": "The description of the publication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of an event that the application publishes.
" + } + }, + "com.amazonaws.appintegrations#PublicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.appintegrations#Publication" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.appintegrations#ResourceNotFoundException": { "type": "structure", "members": { @@ -2363,6 +2981,39 @@ "smithy.api#pattern": "^(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+$)|(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+[\\w/!@#+=.-]+[\\w/!@#+=.,-]+$)$" } }, + "com.amazonaws.appintegrations#Subscription": { + "type": "structure", + "members": { + "Event": { + "target": "com.amazonaws.appintegrations#EventName", + "traits": { + "smithy.api#documentation": "The name of the subscription.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appintegrations#Description", + "traits": { + "smithy.api#documentation": "The description of the subscription.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of an event that the application subscribes.
" + } + }, + "com.amazonaws.appintegrations#SubscriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appintegrations#Subscription" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.appintegrations#TagKey": { "type": "string", "traits": { @@ -2483,6 +3134,19 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.appintegrations#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.appintegrations#URL": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^\\w+\\:\\/\\/.*$" + } + }, "com.amazonaws.appintegrations#UUID": { "type": "string", "traits": { @@ -2551,6 +3215,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.appintegrations#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.appintegrations#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.appintegrations#UpdateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appintegrations#AccessDeniedException" + }, + { + "target": "com.amazonaws.appintegrations#InternalServiceError" + }, + { + "target": "com.amazonaws.appintegrations#InvalidRequestException" + }, + { + "target": "com.amazonaws.appintegrations#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appintegrations#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API is in preview release and subject to change.
\nUpdates and persists an Application resource.
", + "smithy.api#examples": [ + { + "title": "To update an application", + "documentation": "The following updates an existing application named with a new name.", + "input": { + "Arn": "arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e", + "Name": "My New Application Name" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "PATCH", + "uri": "/applications/{Arn}", + "code": 200 + } + } + }, + "com.amazonaws.appintegrations#UpdateApplicationRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.appintegrations#ArnOrUUID", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.appintegrations#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "Description": { + "target": "com.amazonaws.appintegrations#Description", + "traits": { + "smithy.api#documentation": "The description of the application.
" + } + }, + "ApplicationSourceConfig": { + "target": "com.amazonaws.appintegrations#ApplicationSourceConfig", + "traits": { + "smithy.api#documentation": "The configuration for where the application should be loaded from.
" + } + }, + "Subscriptions": { + "target": "com.amazonaws.appintegrations#SubscriptionList", + "traits": { + "smithy.api#documentation": "The events that the application subscribes.
" + } + }, + "Publications": { + "target": "com.amazonaws.appintegrations#PublicationList", + "traits": { + "smithy.api#documentation": "The events that the application publishes.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appintegrations#UpdateApplicationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.appintegrations#UpdateDataIntegration": { "type": "operation", "input": { @@ -2668,7 +3430,7 @@ "Description": { "target": "com.amazonaws.appintegrations#Description", "traits": { - "smithy.api#documentation": "The description of the event inegration.
" + "smithy.api#documentation": "The description of the event integration.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/apprunner.2020-05-15.json b/codegen/sdk-codegen/aws-models/apprunner.2020-05-15.json index 909433274f3..72c0c8e33e9 100644 --- a/codegen/sdk-codegen/aws-models/apprunner.2020-05-15.json +++ b/codegen/sdk-codegen/aws-models/apprunner.2020-05-15.json @@ -1288,13 +1288,13 @@ "BuildCommand": { "target": "com.amazonaws.apprunner#BuildCommand", "traits": { - "smithy.api#documentation": "The command App Runner runs to build your application.
" + "smithy.api#documentation": "The command App Runner runs to build your\n application.
" } }, "StartCommand": { "target": "com.amazonaws.apprunner#StartCommand", "traits": { - "smithy.api#documentation": "The command App Runner runs to start your application.
" + "smithy.api#documentation": "The command App Runner runs to start your\n application.
" } }, "Port": { @@ -1312,7 +1312,7 @@ "RuntimeEnvironmentSecrets": { "target": "com.amazonaws.apprunner#RuntimeEnvironmentSecrets", "traits": { - "smithy.api#documentation": "An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. \n The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
\n\n If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, \n you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.\n
\n\n Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.\n
\nAn array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported\n values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager\n Parameter Store.
\nIf the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use\n either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
\nCurrently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
\nConfiguration for building and running the service from a source code repository.
\n\n CodeConfiguration
is required only for CreateService
request.
The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute\n from root and, if not specified, defaults to the repository root.
" + } } }, "traits": { @@ -1525,7 +1531,7 @@ "AutoScalingConfigurationName": { "target": "com.amazonaws.apprunner#AutoScalingConfigurationName", "traits": { - "smithy.api#documentation": "A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number\n 1
of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
Prior to the release of Managing auto\n scaling, the name DefaultConfiguration
was reserved.
This restriction is no longer in place. You can now manage DefaultConfiguration
the same way you manage your custom auto scaling\n configurations. This means you can do the following with the DefaultConfiguration
that App Runner provides:
Create new revisions of the DefaultConfiguration
.
Delete the revisions of the DefaultConfiguration
.
Delete the auto scaling configuration for which the App Runner DefaultConfiguration
was created.
If you delete the auto scaling configuration you can create another custom auto scaling configuration with the same\n DefaultConfiguration
name. The original DefaultConfiguration
resource provided by App Runner remains in your account unless\n you make changes to it.
A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number\n 1
of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
Prior to the release of Auto scale\n configuration enhancements, the name DefaultConfiguration
was reserved.
This restriction is no longer in place. You can now manage DefaultConfiguration
the same way you manage your custom auto scaling\n configurations. This means you can do the following with the DefaultConfiguration
that App Runner provides:
Create new revisions of the DefaultConfiguration
.
Delete the revisions of the DefaultConfiguration
.
Delete the auto scaling configuration for which the App Runner DefaultConfiguration
was created.
If you delete the auto scaling configuration you can create another custom auto scaling configuration with the same\n DefaultConfiguration
name. The original DefaultConfiguration
resource provided by App Runner remains in your account unless\n you make changes to it.
An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. \n The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
\n\n If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, \n you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.\n
\n\n Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.\n
\nAn array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported\n values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager\n Parameter Store.
\nIf the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use\n either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
\nCurrently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
\nThe current state of the App Runner service. These particular values mean the following.
\n\n CREATE_FAILED
– The service failed to create. The failed service isn't usable, and still counts towards your service quota. \n To troubleshoot this failure, read the failure events and logs, change any\n parameters that need to be fixed, and rebuild your service using UpdateService
.
\n DELETE_FAILED
– The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure\n that all related resources are removed.
The current state of the App Runner service. These particular values mean the following.
\n\n CREATE_FAILED
– The service failed to create. The failed service isn't usable, and still counts towards your service quota. To\n troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using\n UpdateService
.
\n DELETE_FAILED
– The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure\n that all related resources are removed.
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when\n ObservabilityEnabled
is true
.
Specify an ARN with a name and a revision number to associate that revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
\n
Specify just the name to associate the latest revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
\n
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when\n ObservabilityEnabled
is true
.
Specify an ARN with a name and a revision number to associate that revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
\n
Specify just the name to associate the latest revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
\n
The current state of the App Runner service. These particular values mean the following.
\n\n CREATE_FAILED
– The service failed to create. The failed service isn't usable, and still counts towards your service quota. \n To troubleshoot this failure, read the failure events and logs, change any\n parameters that need to be fixed, and rebuild your service using UpdateService
.
\n DELETE_FAILED
– The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure\n that all related resources are removed.
The current state of the App Runner service. These particular values mean the following.
\n\n CREATE_FAILED
– The service failed to create. The failed service isn't usable, and still counts towards your service quota. To\n troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using\n UpdateService
.
\n DELETE_FAILED
– The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure\n that all related resources are removed.
The description of a source code repository.
\nYou must provide either this member or ImageRepository
(but not both).
The description of a source code\n repository.
\nYou must provide either this member or ImageRepository
(but not both).
Describes the source deployed to an App Runner service. It can be a code or an image repository.
" } }, + "com.amazonaws.apprunner#SourceDirectory": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^[^\\x00]+$" + } + }, "com.amazonaws.apprunner#StartCommand": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-runtime.2023-09-30.json b/codegen/sdk-codegen/aws-models/bedrock-runtime.2023-09-30.json index 0a5468ad977..1e1bef9f169 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-runtime.2023-09-30.json +++ b/codegen/sdk-codegen/aws-models/bedrock-runtime.2023-09-30.json @@ -771,7 +771,7 @@ } ], "traits": { - "smithy.api#documentation": "Invokes the specified Bedrock model to run inference using the input provided in the request body. \n You use InvokeModel to run inference for text models, image models, and embedding models.
\nFor more information about invoking models, see Using the API in the Bedrock User Guide.
\nFor example requests, see Examples (after the Errors section).
", + "smithy.api#documentation": "Invokes the specified Bedrock model to run inference using the input provided in the request body. \n You use InvokeModel to run inference for text models, image models, and embedding models.
\nFor more information, see Run inference in the Bedrock User Guide.
\nFor example requests, see Examples (after the Errors section).
", "smithy.api#http": { "code": 200, "method": "POST", @@ -786,7 +786,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" } }, "com.amazonaws.bedrockruntime#InvokeModelRequest": { @@ -892,7 +892,7 @@ } ], "traits": { - "smithy.api#documentation": "Invoke the specified Bedrock model to run inference using the input provided.\n Return the response in a stream.
\nFor more information about invoking models, see Using the API in the Bedrock User Guide.
\nFor an example request and response, see Examples (after the Errors section).
", + "smithy.api#documentation": "Invoke the specified Bedrock model to run inference using the input provided.\n Return the response in a stream.
\nFor more information, see Run inference in the Bedrock User Guide.
\nFor an example request and response, see Examples (after the Errors section).
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1104,6 +1104,9 @@ }, "throttlingException": { "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + "modelTimeoutException": { + "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock.2023-04-20.json b/codegen/sdk-codegen/aws-models/bedrock.2023-04-20.json index 9bbba4caa64..d5bba06e1a0 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.2023-04-20.json +++ b/codegen/sdk-codegen/aws-models/bedrock.2023-04-20.json @@ -780,6 +780,23 @@ "smithy.api#documentation": "CloudWatch logging configuration.
" } }, + "com.amazonaws.bedrock#CommitmentDuration": { + "type": "enum", + "members": { + "ONE_MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OneMonth" + } + }, + "SIX_MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SixMonths" + } + } + } + }, "com.amazonaws.bedrock#ConflictException": { "type": "structure", "members": { @@ -828,7 +845,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a fine-tuning job to customize a base model.
\nYou specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Training data\n contains input and output text for each record in a JSONL format. Optionally, you can specify validation data\n in the same format as the training data. Bedrock returns validation loss metrics and output generations \n after the job completes.\n
\n\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob
operation to retrieve the job status.
For more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Creates a fine-tuning job to customize a base model.
\nYou specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Training data\n contains input and output text for each record in a JSONL format. Optionally, you can specify validation data\n in the same format as the training data. Bedrock returns validation loss metrics and output generations\n after the job completes.\n
\n\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob
operation to retrieve the job status.
For more information, see Custom models in the Bedrock User Guide.
", "smithy.api#http": { "code": 201, "method": "POST", @@ -860,7 +877,7 @@ "roleArn": { "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket.\n To pass this role to Bedrock, the caller of this API must have the iam:PassRole
permission.\n
The Amazon Resource Name (ARN) of an IAM role that Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket.\n To pass this role to Bedrock, the caller of this API must have the iam:PassRole
permission.\n
VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.
", + "smithy.api#documentation": "VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.
", "smithy.api#tags": [ "model-customization-vpc" ] @@ -955,6 +972,110 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.
\nFor more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/provisioned-model-throughput" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "Unique token value that you can provide. If this token matches a previous request,\n Bedrock ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "Number of model units to allocate.
", + "smithy.api#required": {} + } + }, + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "Unique name for this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "Name or ARN of the model to associate with this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "Commitment duration requested for the provisioned throughput.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to associate with this provisioned throughput.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse": { + "type": "structure", + "members": { + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "The ARN for this provisioned throughput.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#CustomModelArn": { "type": "string", "traits": { @@ -1131,6 +1252,67 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "The ARN or name of the provisioned throughput.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#ErrorMessage": { "type": "string", "traits": { @@ -1552,7 +1734,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -1626,7 +1808,7 @@ "status": { "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", "traits": { - "smithy.api#documentation": "The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.
" + "smithy.api#documentation": "The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.
" } }, "failureMessage": { @@ -1769,6 +1951,153 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#GetProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get details for a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "The ARN or name of the provisioned throughput.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse": { + "type": "structure", + "members": { + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The current number of model units requested to be available for this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The desired number of model units that was requested to be available for this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The name of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN or name of the model associated with this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the new model to asssociate with this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "foundationModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "ARN of the foundation model.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "Status of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the creation time for this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last modified time of this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "Failure message for any issues that the create operation encounters.
" + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "Commitment duration of the provisioned throughput.
" + } + }, + "commitmentExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Commitment expiration time for the provisioned throughput.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#IdempotencyToken": { "type": "string", "traits": { @@ -2090,7 +2419,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.
\nFor more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.
\nFor more information, see Custom models in the Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2192,7 +2521,136 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrock#ListTagsForResource": { + "com.amazonaws.bedrock#ListProvisionedModelThroughputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/provisioned-model-throughputs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "provisionedModelSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return provisioned capacities created after the specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return provisioned capacities created before the specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "Return the list of provisioned capacities that match the specified status.
", + "smithy.api#httpQuery": "statusEquals" + } + }, + "modelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Return the list of provisioned capacities where their model ARN is equal to this parameter.
", + "smithy.api#httpQuery": "modelArnEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "Return the list of provisioned capacities if their name contains these characters.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "THe maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Continuation token from the previous response, for Bedrock to list the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortByProvisionedModels", + "traits": { + "smithy.api#documentation": "The field to sort by in the returned list of provisioned capacities.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order of the results.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Continuation token for the next request to list the next set of results.
" + } + }, + "provisionedModelSummaries": { + "target": "com.amazonaws.bedrock#ProvisionedModelSummaries", + "traits": { + "smithy.api#documentation": "List of summaries, one for each provisioned throughput in the response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.bedrock#ListTagsForResourceRequest" @@ -2500,7 +2958,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:amazon-bedrock:[a-zA-Z0-9-]*:(([0-9]{12})|(aws))?:(custom|built-in)-model/.+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" } }, "com.amazonaws.bedrock#ModelModality": { @@ -2593,14 +3051,186 @@ "smithy.api#pattern": "^\\S*$" } }, + "com.amazonaws.bedrock#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.bedrock#Provider": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z0-9-]{1,63}$" } }, + "com.amazonaws.bedrock#ProvisionedModelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#ProvisionedModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ProvisionedModelSummary" + } + }, + "com.amazonaws.bedrock#ProvisionedModelSummary": { + "type": "structure", + "members": { + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The name of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model associated with this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Desired model ARN.
", + "smithy.api#required": {} + } + }, + "foundationModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "Foundation model ARN.
", + "smithy.api#required": {} + } + }, + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The number of model units allocated.
", + "smithy.api#required": {} + } + }, + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "Desired model units.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "Status of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "Commitment duration for the provisioned throughput.
" + } + }, + "commitmentExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Commitment expiration time for the provisioned throughput.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this provisioned throughput was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this provisioned throughput was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Set of fields associated with a provisioned throughput.
" + } + }, "com.amazonaws.bedrock#ProvisionedModelThroughputResource": { - "type": "resource" + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputs" + }, + { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughput" + } + ] }, "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration": { "type": "operation", @@ -2749,6 +3379,17 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.bedrock#SortByProvisionedModels": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, "com.amazonaws.bedrock#SortJobsBy": { "type": "enum", "members": { @@ -3024,7 +3665,7 @@ "min": 20, "max": 1011 }, - "smithy.api#pattern": "(^arn:aws(-[^:]+)?:amazon-bedrock:[a-zA-Z0-9-]*:[0-9]{12}:(fine-tuning-job|custom-model)/.+$)|([a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:([0-9]{12}|):(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(/[a-z0-9]{12})$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}$)" + "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:provisioned-model/[a-z0-9]{12}$)))" } }, "com.amazonaws.bedrock#TaggingResource": { @@ -3074,7 +3715,7 @@ } }, "traits": { - "smithy.api#documentation": "The request contains more tags than can be associated with a resource (50 tags per resource). \n The maximum number of tags includes both existing tags and those included in your current request.
", + "smithy.api#documentation": "The request contains more tags than can be associated with a resource (50 tags per resource).\n The maximum number of tags includes both existing tags and those included in your current request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3191,6 +3832,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "The ARN or name of the provisioned throughput to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "desiredProvisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The new name for this provisioned throughput.
" + } + }, + "desiredModelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the new model to associate with this provisioned throughput.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughputResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#ValidationDataConfig": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/budgets.2016-10-20.json b/codegen/sdk-codegen/aws-models/budgets.2016-10-20.json index 495987c9b0a..90f4a70225a 100644 --- a/codegen/sdk-codegen/aws-models/budgets.2016-10-20.json +++ b/codegen/sdk-codegen/aws-models/budgets.2016-10-20.json @@ -1406,7 +1406,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 50 + "max": 1000 } } }, @@ -2756,7 +2756,7 @@ "MaxResults": { "target": "com.amazonaws.budgets#MaxResultsBudgetNotifications", "traits": { - "smithy.api#documentation": "\n\t\t\tAn integer that shows how many budget name entries a paginated response contains.\n\t\t
" + "smithy.api#documentation": "An integer that represents how many budgets a paginated response contains. The default is\n\t\t\t50.
" } }, "NextToken": { @@ -2958,14 +2958,14 @@ "AccountId": { "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "The accountId
that is associated with the budgets that you want descriptions of.
The accountId
that is associated with the budgets that you want to\n describe.
An optional integer that represents how many entries a paginated response contains. The maximum is 100.
" + "smithy.api#documentation": "An integer that represents how many budgets a paginated response contains. The default is\n 100.
" } }, "NextToken": { @@ -3048,7 +3048,7 @@ "AccountId": { "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "The accountId
that is associated with the budget whose notifications you want descriptions of.
The accountId
that is associated with the budget whose notifications you want\n descriptions of.
An optional integer that represents how many entries a paginated response contains. The maximum is 100.
" + "smithy.api#documentation": "An optional integer that represents how many entries a paginated response contains.
" } }, "NextToken": { @@ -3166,7 +3166,7 @@ "MaxResults": { "target": "com.amazonaws.budgets#MaxResults", "traits": { - "smithy.api#documentation": "An optional integer that represents how many entries a paginated response contains. The maximum is 100.
" + "smithy.api#documentation": "An optional integer that represents how many entries a paginated response contains.
" } }, "NextToken": { @@ -3577,7 +3577,16 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 50 + "max": 1000 + } + } + }, + "com.amazonaws.budgets#MaxResultsDescribeBudgets": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 } } }, @@ -3861,13 +3870,13 @@ "Unit": { "target": "com.amazonaws.budgets#UnitValue", "traits": { - "smithy.api#documentation": "The unit of measurement that's used for the budget forecast, actual spend, or budget\n\t\t\tthreshold, such as USD or GBP.
", + "smithy.api#documentation": "The unit of measurement that's used for the budget forecast, actual spend, or budget\n\t\t\tthreshold.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The amount of cost or usage that's measured for a budget.
\nFor example, a Spend
for 3 GB
of S3 usage has the following\n\t\t\tparameters:
An Amount
of 3
\n
A unit
of GB
\n
The amount of cost or usage that's measured for a budget.
\n\n Cost example: A Spend
for 3 USD
of\n\t\t\tcosts has the following parameters:
An Amount
of 3
\n
A Unit
of USD
\n
\n Usage example: A Spend
for 3 GB
of S3\n\t\t\tusage has the following parameters:
An Amount
of 3
\n
A Unit
of GB
\n
An application with the specified name with the IAM user or Amazon Web Services account already exists.
", + "smithy.api#documentation": "An application with the specified name with the user or Amazon Web Services account\n already exists.
", "smithy.api#error": "client" } }, @@ -207,7 +207,7 @@ } }, "traits": { - "smithy.api#documentation": "The application does not exist with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The application does not exist with the user or Amazon Web Services account.
", "smithy.api#error": "client" } }, @@ -625,7 +625,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the applicable\n IAM or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the applicable user\n or Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -2379,7 +2379,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of the application. This name must be unique with the applicable IAM or Amazon Web Services account.
", + "smithy.api#documentation": "The name of the application. This name must be unique with the applicable user or\n Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -2711,7 +2711,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -2846,7 +2846,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -2865,7 +2865,7 @@ "deploymentConfigName": { "target": "com.amazonaws.codedeploy#DeploymentConfigName", "traits": { - "smithy.api#documentation": "The name of a deployment configuration associated with the IAM user or\n Amazon Web Services account.
\nIf not specified, the value configured in the deployment group is used as the default.\n If the deployment group does not have a deployment configuration associated with it,\n CodeDeployDefault
.OneAtATime
is used by default.
The name of a deployment configuration associated with the user or Amazon Web Services account.
\nIf not specified, the value configured in the deployment group is used as the default.\n If the deployment group does not have a deployment configuration associated with it,\n CodeDeployDefault
.OneAtATime
is used by default.
Allows you to specify information about alarms associated with a deployment. The alarm\n configuration that you specify here will override the alarm configuration at the\n deployment group level. Consider overriding the alarm configuration if you have set up\n alarms at the deployment group level that are causing deployment failures. In this case,\n you would call CreateDeployment
to create a new deployment that uses a\n previous application revision that is known to work, and set its alarm configuration to\n turn off alarm polling. Turning off alarm polling ensures that the new deployment\n proceeds without being blocked by the alarm that was generated by the previous, failed,\n deployment.
If you specify an overrideAlarmConfiguration
, you need the\n UpdateDeploymentGroup
IAM permission when calling\n CreateDeployment
.
Allows you to specify information about alarms associated with a deployment. The alarm\n configuration that you specify here will override the alarm configuration at the\n deployment group level. Consider overriding the alarm configuration if you have set up\n alarms at the deployment group level that are causing deployment failures. In this case,\n you would call CreateDeployment
to create a new deployment that uses a\n previous application revision that is known to work, and set its alarm configuration to\n turn off alarm polling. Turning off alarm polling ensures that the new deployment\n proceeds without being blocked by the alarm that was generated by the previous, failed,\n deployment.
If you specify an overrideAlarmConfiguration
, you need the\n UpdateDeploymentGroup
\n IAM permission when calling CreateDeployment
.
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } } @@ -3004,7 +3004,7 @@ "deploymentConfigName": { "target": "com.amazonaws.codedeploy#DeploymentConfigName", "traits": { - "smithy.api#documentation": "The name of a deployment configuration associated with the IAM user or\n Amazon Web Services account.
", + "smithy.api#documentation": "The name of a deployment configuration associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } } @@ -3049,7 +3049,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -3149,7 +3149,7 @@ "target": "com.amazonaws.codedeploy#DeleteResourcesByExternalIdOutput" }, "traits": { - "smithy.api#documentation": "Deletes resources linked to an external ID.
" + "smithy.api#documentation": "Deletes resources linked to an external ID. This action only applies if you have\n configured blue/green deployments through CloudFormation.
\nIt is not necessary to call this action directly. CloudFormation calls it\n on your behalf when it needs to delete stack resources. This action is offered\n publicly in case you need to delete resources to comply with General Data Protection\n Regulation (GDPR) requirements.
\nA deployment configuration with the specified name with the IAM user or\n Amazon Web Services account already exists.
", + "smithy.api#documentation": "A deployment configuration with the specified name with the user or Amazon Web Services account already exists.
", "smithy.api#error": "client" } }, @@ -3214,7 +3214,7 @@ } }, "traits": { - "smithy.api#documentation": "The deployment configuration does not exist with the IAM user or\n Amazon Web Services account.
", + "smithy.api#documentation": "The deployment configuration does not exist with the user or Amazon Web Services account.
", "smithy.api#error": "client" } }, @@ -3383,7 +3383,7 @@ } }, "traits": { - "smithy.api#documentation": "The deployment with the IAM user or Amazon Web Services account does not\n exist.
", + "smithy.api#documentation": "The deployment with the user or Amazon Web Services account does not exist.
", "smithy.api#error": "client" } }, @@ -3398,7 +3398,7 @@ } }, "traits": { - "smithy.api#documentation": "A deployment group with the specified name with the IAM user or Amazon Web Services account already exists.
", + "smithy.api#documentation": "A deployment group with the specified name with the user or Amazon Web Services account\n already exists.
", "smithy.api#error": "client" } }, @@ -3413,7 +3413,7 @@ } }, "traits": { - "smithy.api#documentation": "The named deployment group with the IAM user or Amazon Web Services account does not exist.
", + "smithy.api#documentation": "The named deployment group with the user or Amazon Web Services account does not\n exist.
", "smithy.api#error": "client" } }, @@ -4558,12 +4558,12 @@ "name": { "target": "com.amazonaws.codedeploy#ELBName", "traits": { - "smithy.api#documentation": "For blue/green deployments, the name of the load balancer that is used to route\n traffic from original instances to replacement instances in a blue/green deployment. For\n in-place deployments, the name of the load balancer that instances are deregistered from\n so they are not serving traffic during a deployment, and then re-registered with after\n the deployment is complete.
" + "smithy.api#documentation": "For blue/green deployments, the name of the Classic Load Balancer that is used to route\n traffic from original instances to replacement instances in a blue/green deployment. For\n in-place deployments, the name of the Classic Load Balancer that instances are deregistered from\n so they are not serving traffic during a deployment, and then re-registered with after\n the deployment is complete.
" } } }, "traits": { - "smithy.api#documentation": "Information about a load balancer in Elastic Load Balancing to use in a deployment.\n Instances are registered directly with a load balancer, and traffic is routed to the\n load balancer.
" + "smithy.api#documentation": "Information about a Classic Load Balancer in Elastic Load Balancing to use in a deployment.\n Instances are registered directly with a load balancer, and traffic is routed to the\n load balancer.
" } }, "com.amazonaws.codedeploy#ELBInfoList": { @@ -4912,7 +4912,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } } @@ -5111,7 +5111,7 @@ "deploymentConfigName": { "target": "com.amazonaws.codedeploy#DeploymentConfigName", "traits": { - "smithy.api#documentation": "The name of a deployment configuration associated with the IAM user or\n Amazon Web Services account.
", + "smithy.api#documentation": "The name of a deployment configuration associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } } @@ -5177,7 +5177,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -5215,7 +5215,7 @@ "deploymentId": { "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { - "smithy.api#documentation": "The unique ID of a deployment associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The unique ID of a deployment associated with the user or Amazon Web Services account.\n
", "smithy.api#required": {} } } @@ -5543,7 +5543,7 @@ } }, "traits": { - "smithy.api#documentation": "No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.
", + "smithy.api#documentation": "No IAM ARN was included in the request. You must use an IAM session ARN or user ARN in the request.
", "smithy.api#error": "client" } }, @@ -5579,7 +5579,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified IAM user ARN is already registered with an on-premises\n instance.
", + "smithy.api#documentation": "The specified user ARN is already registered with an on-premises instance.
", "smithy.api#error": "client" } }, @@ -5594,7 +5594,7 @@ } }, "traits": { - "smithy.api#documentation": "An IAM user ARN was not specified.
", + "smithy.api#documentation": "An user ARN was not specified.
", "smithy.api#error": "client" } }, @@ -5675,13 +5675,13 @@ "iamSessionArn": { "target": "com.amazonaws.codedeploy#IamSessionArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM session associated with the on-premises instance.
" + "smithy.api#documentation": "The ARN of the IAM session associated with the on-premises\n instance.
" } }, "iamUserArn": { "target": "com.amazonaws.codedeploy#IamUserArn", "traits": { - "smithy.api#documentation": "The IAM user ARN associated with the on-premises instance.
" + "smithy.api#documentation": "The user ARN associated with the on-premises instance.
" } }, "instanceArn": { @@ -6364,7 +6364,7 @@ } }, "traits": { - "smithy.api#documentation": "The IAM user ARN was specified in an invalid format.
", + "smithy.api#documentation": "The user ARN was specified in an invalid format.
", "smithy.api#error": "client" } }, @@ -7138,7 +7138,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -7219,7 +7219,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the applications registered with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "Lists the applications registered with the user or Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -7277,7 +7277,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the deployment configurations with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "Lists the deployment configurations with the user or Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -7344,7 +7344,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the deployment groups for an application registered with the IAM\n user or Amazon Web Services account.
", + "smithy.api#documentation": "Lists the deployment groups for an application registered with the Amazon Web Services\n user or Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -7358,7 +7358,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -7445,7 +7445,7 @@ "smithy.api#deprecated": { "message": "This operation is deprecated, use ListDeploymentTargets instead." }, - "smithy.api#documentation": " The newer BatchGetDeploymentTargets
should be used instead because\n it works with all compute types. ListDeploymentInstances
throws an\n exception if it is used with a compute platform other than EC2/On-premises or\n Lambda.
Lists the instance for a deployment associated with the IAM user or\n Amazon Web Services account.
", + "smithy.api#documentation": " The newer BatchGetDeploymentTargets
should be used instead because\n it works with all compute types. ListDeploymentInstances
throws an\n exception if it is used with a compute platform other than EC2/On-premises or\n Lambda.
Lists the instance for a deployment associated with the user or Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -7636,7 +7636,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the deployments in a deployment group for an application registered with the\n IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "Lists the deployments in a deployment group for an application registered with the\n user or Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -7650,7 +7650,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
\nIf applicationName
is specified, then\n deploymentGroupName
must be specified. If it is not specified, then\n deploymentGroupName
must not be specified.
The name of an CodeDeploy application associated with the user or Amazon Web Services account.
\nIf applicationName
is specified, then\n deploymentGroupName
must be specified. If it is not specified, then\n deploymentGroupName
must not be specified.
An array that contains information about the load balancer to use for load balancing\n in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load\n Balancers.
\nAdding more than one load balancer to the array is not supported.
\nAn array that contains information about the load balancers to use for load balancing\n in a deployment. If you're using Classic Load Balancers, specify those load balancers\n in this array.
\nYou can add up to 10 load balancers to the array.
\nIf you're using Application Load Balancers or Network Load Balancers, use the\n targetGroupInfoList
array instead of this one.
An array that contains information about the target group to use for load balancing in\n a deployment. In Elastic Load Balancing, target groups are used with Application Load\n Balancers.
\nAdding more than one target group to the array is not supported.
\nAn array that contains information about the target groups to use for load balancing\n in a deployment. If you're using Application Load Balancers and Network Load Balancers,\n specify their associated target groups in this array.
\nYou can add up to 10 target groups to the array.
\nIf you're using Classic Load Balancers, use the elbInfoList
array\n instead of this one.
Information about the Elastic Load Balancing load balancer or target group used in a\n deployment.
" + "smithy.api#documentation": "Information about the Elastic Load Balancing load balancer or target group used in a\n deployment.
\nYou can use load balancers and target groups in combination. For example, if you have\n two Classic Load Balancers, and five target groups tied to an Application Load Balancer,\n you can specify the two Classic Load Balancers in elbInfoList
, and the five\n target groups in targetGroupInfoList
.
Both an IAM user ARN and an IAM session ARN were\n included in the request. Use only one ARN type.
", + "smithy.api#documentation": "Both an user ARN and an IAM session ARN were included in the request.\n Use only one ARN type.
", "smithy.api#error": "client" } }, @@ -8233,7 +8233,7 @@ "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The name of an CodeDeploy application associated with the user or Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -8319,7 +8319,7 @@ "iamUserArn": { "target": "com.amazonaws.codedeploy#IamUserArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM user to associate with the on-premises\n instance.
" + "smithy.api#documentation": "The ARN of the user to associate with the on-premises instance.
" } } }, @@ -8467,7 +8467,7 @@ } }, "traits": { - "smithy.api#documentation": "The named revision does not exist with the IAM user or Amazon Web Services account.
", + "smithy.api#documentation": "The named revision does not exist with the user or Amazon Web Services account.
", "smithy.api#error": "client" } }, @@ -8653,7 +8653,7 @@ "bundleType": { "target": "com.amazonaws.codedeploy#BundleType", "traits": { - "smithy.api#documentation": "The file type of the application revision. Must be one of the following:
\n\n tar
: A tar archive file.
\n tgz
: A compressed tar archive file.
\n zip
: A zip archive file.
The file type of the application revision. Must be one of the following:
\n\n tar
: A tar archive file.
\n tgz
: A compressed tar archive file.
\n zip
: A zip archive file.
\n YAML
: A YAML-formatted file.
\n JSON
: A JSON-formatted file.
The replacement list of Auto Scaling groups to be included in the deployment\n group, if you want to change them.
\nTo keep the Auto Scaling groups, enter their names or do not specify this\n parameter.
\nTo remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to\n launch and receive the error \"Heartbeat Timeout\" in the\n CodeDeploy User Guide.
\nThe replacement list of Auto Scaling groups to be included in the deployment\n group, if you want to change them.
\nTo keep the Auto Scaling groups, enter their names or do not specify this\n parameter.
\nTo remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to\n launch and receive the error \"Heartbeat Timeout\" in the\n CodeDeploy User Guide.
\nThe username for the user. Must be unique within the user pool. Must be a UTF-8 string\n between 1 and 128 characters. After the user is created, the username can't be\n changed.
", + "smithy.api#documentation": "The value that you want to set as the username sign-in attribute. The following\n conditions apply to the username parameter.
\nThe username can't be a duplicate of another username in the same user\n pool.
\nYou can't change the value of a username after you create it.
\nYou can only provide a value if usernames are a valid sign-in attribute for\n your user pool. If your user pool only supports phone numbers or email addresses\n as sign-in attributes, Amazon Cognito automatically generates a username value. For more\n information, see Customizing sign-in attributes.
\nThe Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs.\n The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account\n as your user pool.
\nTo send logs to log groups with a resource policy of a size greater than 5120\n characters, configure a log group with a path that starts with\n /aws/vendedlogs
. For more information, see Enabling\n logging from certain Amazon Web Services services.
The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs.\n The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account\n as your user pool.
\nTo send logs to log groups with a resource policy of a size greater than 5120\n characters, configure a log group with a path that starts with\n /aws/vendedlogs
. For more information, see Enabling\n logging from certain Amazon Web Services services.
The user pool status in a user pool description.
" } }, @@ -15439,6 +15442,9 @@ "Status": { "target": "com.amazonaws.cognitoidentityprovider#StatusType", "traits": { + "smithy.api#deprecated": { + "message": "This property is no longer available." + }, "smithy.api#documentation": "The status of a user pool.
" } }, diff --git a/codegen/sdk-codegen/aws-models/connect.2017-08-08.json b/codegen/sdk-codegen/aws-models/connect.2017-08-08.json index ed1168ebeee..6285c163d88 100644 --- a/codegen/sdk-codegen/aws-models/connect.2017-08-08.json +++ b/codegen/sdk-codegen/aws-models/connect.2017-08-08.json @@ -978,6 +978,9 @@ { "target": "com.amazonaws.connect#ListSecurityKeys" }, + { + "target": "com.amazonaws.connect#ListSecurityProfileApplications" + }, { "target": "com.amazonaws.connect#ListSecurityProfilePermissions" }, @@ -2059,6 +2062,50 @@ "smithy.api#documentation": "Configuration of the answering machine detection.
" } }, + "com.amazonaws.connect#Application": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.connect#Namespace", + "traits": { + "smithy.api#documentation": "Namespace of the application that you want to give access to.
" + } + }, + "ApplicationPermissions": { + "target": "com.amazonaws.connect#ApplicationPermissions", + "traits": { + "smithy.api#documentation": "The permissions that the agent is granted on the application. Only the ACCESS
permission is supported.
This API is in preview release for Amazon Connect and is subject to change.
\nA third party application's metadata.
" + } + }, + "com.amazonaws.connect#ApplicationPermissions": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Permission" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.connect#Applications": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Application" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.connect#ApproximateTotalCount": { "type": "long" }, @@ -5184,7 +5231,7 @@ "Name": { "target": "com.amazonaws.connect#QuickConnectName", "traits": { - "smithy.api#documentation": "The name of the quick connect.
", + "smithy.api#documentation": "A unique name of the quick connect.
", "smithy.api#required": {} } }, @@ -5571,6 +5618,12 @@ "traits": { "smithy.api#documentation": "The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
|\n SecurityProfile
| Queue
| RoutingProfile
\n
This API is in preview release for Amazon Connect and is subject to change.
\nA list of third party applications that the security profile will give access to.
" + } } }, "traits": { @@ -14627,6 +14680,12 @@ "traits": { "smithy.api#enumValue": "CASES_DOMAIN" } + }, + "APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION" + } } } }, @@ -16523,7 +16582,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about the phone numbers for the specified Amazon Connect instance.
\nFor more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.
\nWe recommend using ListPhoneNumbersV2 to\n return phone number types. ListPhoneNumbers doesn't support number types UIFN
,\n SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
. While it returns\n numbers of those types, it incorrectly lists them as TOLL_FREE
or DID
.
The phone number Arn
value that is returned from each of the items in the\n PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail\n with a ResourceNotFoundException
. Instead, use the ListPhoneNumbersV2 API.\n It returns the new phone number ARN that can be used to tag phone number resources.
Provides information about the phone numbers for the specified Amazon Connect instance.
\nFor more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.
\nWe recommend using ListPhoneNumbersV2 to\n return phone number types. ListPhoneNumbers doesn't support number types UIFN
,\n SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
. While it\n returns numbers of those types, it incorrectly lists them as TOLL_FREE
or\n DID
.
The phone number Arn
value that is returned from each of the items in the\n PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail\n with a ResourceNotFoundException
. Instead, use the ListPhoneNumbersV2 API.\n It returns the new phone number ARN that can be used to tag phone number resources.
The type of phone number.
", + "smithy.api#documentation": "The type of phone number.
\nWe recommend using ListPhoneNumbersV2 to\n return phone number types. While ListPhoneNumbers returns number types UIFN
,\n SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
, it\n incorrectly lists them as TOLL_FREE
or DID
.
Returns a list of third party applications in a specific security profile.
", + "smithy.api#http": { + "method": "GET", + "uri": "/security-profiles-applications/{InstanceId}/{SecurityProfileId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Applications", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListSecurityProfileApplicationsRequest": { + "type": "structure", + "members": { + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "The security profile identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. The next set of results can be retrieved by using the \n token value returned in the previous response when making the next request.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ListSecurityProfileApplicationsResponse": { + "type": "structure", + "members": { + "Applications": { + "target": "com.amazonaws.connect#Applications", + "traits": { + "smithy.api#documentation": "A list of the third party application's metadata.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. The next set of results can be retrieved by using the \n token value returned in the previous response when making the next request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ListSecurityProfilePermissions": { "type": "operation", "input": { @@ -18962,6 +19120,15 @@ "smithy.api#pattern": "^(^[\\S].*[\\S]$)|(^[\\S]$)$" } }, + "com.amazonaws.connect#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.connect#NextToken": { "type": "string" }, @@ -19402,6 +19569,15 @@ } } }, + "com.amazonaws.connect#Permission": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.connect#PermissionsList": { "type": "list", "member": { @@ -23043,19 +23219,19 @@ "EventBridgeAction": { "target": "com.amazonaws.connect#EventBridgeActionDefinition", "traits": { - "smithy.api#documentation": "Information about the EventBridge action.
" + "smithy.api#documentation": "Information about the EventBridge action.
\nSupported only for TriggerEventSource
values:\n OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
|\n OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
|\n OnMetricDataUpdate
\n
Information about the contact category action.
" + "smithy.api#documentation": "Information about the contact category action.
\nSupported only for TriggerEventSource
values:\n OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
|\n OnPostChatAnalysisAvailable
| OnZendeskTicketCreate
|\n OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
\n
Information about the send notification action.
" + "smithy.api#documentation": "Information about the send notification action.
\nSupported only for TriggerEventSource
values:\n OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
|\n OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
|\n OnMetricDataUpdate
\n
The name of the event source. This field is required if TriggerEventSource
is one of the\n following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
|\n OnSalesforceCaseCreate
\n
The name of the event source. This field is required if TriggerEventSource
is one of the\n following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
|\n OnSalesforceCaseCreate
| OnContactEvaluationSubmit
|\n OnMetricDataUpdate
.
The list of resources that a security profile applies tag restrictions to in Amazon Connect.
" } + }, + "Applications": { + "target": "com.amazonaws.connect#Applications", + "traits": { + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nA list of the third party application's metadata.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json index c4e51dc02fb..513b55bd698 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json @@ -5246,6 +5246,18 @@ "traits": { "smithy.api#documentation": "The number of items exported.
" } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT
or INCREMENTAL_EXPORT
. If INCREMENTAL_EXPORT
is provided, the IncrementalExportSpecification
must also be used.
Optional object containing the parameters specific to an incremental export.
" + } } }, "traits": { @@ -5272,6 +5284,9 @@ } } }, + "com.amazonaws.dynamodb#ExportFromTime": { + "type": "timestamp" + }, "com.amazonaws.dynamodb#ExportManifest": { "type": "string" }, @@ -5336,6 +5351,12 @@ "traits": { "smithy.api#documentation": "Export can be in one of the following states: IN_PROGRESS, COMPLETED, or\n FAILED.
" } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT
or INCREMENTAL_EXPORT
. If INCREMENTAL_EXPORT
is provided, the IncrementalExportSpecification
must also be used.
The format for the exported data. Valid values for ExportFormat
are\n DYNAMODB_JSON
or ION
.
Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT
or INCREMENTAL_EXPORT
. If INCREMENTAL_EXPORT
is provided, the IncrementalExportSpecification
must also be used.
Optional object containing the parameters specific to an incremental export.
" + } } }, "traits": { @@ -5456,6 +5489,43 @@ "com.amazonaws.dynamodb#ExportTime": { "type": "timestamp" }, + "com.amazonaws.dynamodb#ExportToTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportType": { + "type": "enum", + "members": { + "FULL_EXPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_EXPORT" + } + }, + "INCREMENTAL_EXPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_EXPORT" + } + } + } + }, + "com.amazonaws.dynamodb#ExportViewType": { + "type": "enum", + "members": { + "NEW_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_IMAGE" + } + }, + "NEW_AND_OLD_IMAGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_AND_OLD_IMAGES" + } + } + } + }, "com.amazonaws.dynamodb#ExpressionAttributeNameMap": { "type": "map", "key": { @@ -6426,6 +6496,32 @@ } } }, + "com.amazonaws.dynamodb#IncrementalExportSpecification": { + "type": "structure", + "members": { + "ExportFromTime": { + "target": "com.amazonaws.dynamodb#ExportFromTime", + "traits": { + "smithy.api#documentation": "Time in the past which provides the inclusive start range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state including and after this point in time.
" + } + }, + "ExportToTime": { + "target": "com.amazonaws.dynamodb#ExportToTime", + "traits": { + "smithy.api#documentation": "Time in the past which provides the exclusive end range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state just prior to this point in time. If this is not provided, the latest time with data available will be used.
" + } + }, + "ExportViewType": { + "target": "com.amazonaws.dynamodb#ExportViewType", + "traits": { + "smithy.api#documentation": "Choice of whether to output the previous item image prior to the start time of the incremental export. Valid values are NEW_AND_OLD_IMAGES
and NEW_IMAGES
.
Optional object containing the parameters specific to an incremental export.
" + } + }, "com.amazonaws.dynamodb#IndexName": { "type": "string", "traits": { @@ -6961,7 +7057,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "List backups associated with an Amazon Web Services account. To list backups for a\n given table, specify TableName
. ListBackups
returns a\n paginated list of results with at most 1 MB worth of items in a page. You can also\n specify a maximum number of entries to be returned in a page.
In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.
\nYou can call ListBackups
a maximum of five times per second.
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. \n To list these backups for a given table, specify TableName
. ListBackups
returns a\n paginated list of results with at most 1 MB worth of items in a page. You can also\n specify a maximum number of entries to be returned in a page.
In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.
\nYou can call ListBackups
a maximum of five times per second.
If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the \n Amazon Web Services Backup list API.\n
" } }, "com.amazonaws.dynamodb#ListBackupsInput": { diff --git a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json index ee7045e56bf..8d9b31253f2 100644 --- a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json +++ b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json @@ -14233,7 +14233,7 @@ "type": "structure", "members": { "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#AvailabilityZoneName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Availability Zone in which to create the default subnet.
", @@ -20036,6 +20036,12 @@ "smithy.api#default": false, "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation
. \n Otherwise, it is UnauthorizedOperation
.
\n Options for server side encryption.\n
" + } } }, "traits": { @@ -20123,6 +20129,12 @@ "smithy.api#default": false, "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation
. \n Otherwise, it is UnauthorizedOperation
.
\n Options for server side encryption.\n
" + } } }, "traits": { @@ -20187,6 +20199,14 @@ "smithy.api#default": false, "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation
. \n Otherwise, it is UnauthorizedOperation
.
Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.
" + } } }, "traits": { @@ -20355,6 +20375,12 @@ "smithy.api#default": false, "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation
. \n Otherwise, it is UnauthorizedOperation
.
\n Options for server side encryption.\n
" + } } }, "traits": { @@ -64580,6 +64606,54 @@ "traits": { "smithy.api#enumValue": "mac2-m2pro.metal" } + }, + "r7iz_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.large" + } + }, + "r7iz_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.xlarge" + } + }, + "r7iz_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.2xlarge" + } + }, + "r7iz_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.4xlarge" + } + }, + "r7iz_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.8xlarge" + } + }, + "r7iz_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.12xlarge" + } + }, + "r7iz_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.16xlarge" + } + }, + "r7iz_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.32xlarge" + } } } }, @@ -67888,6 +67962,9 @@ } } }, + "com.amazonaws.ec2#KmsKeyArn": { + "type": "string" + }, "com.amazonaws.ec2#KmsKeyId": { "type": "string" }, @@ -75447,8 +75524,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "The status of the Verified Access policy.
", - "smithy.api#required": {} + "smithy.api#documentation": "The status of the Verified Access policy.
" } }, "PolicyDocument": { @@ -75471,6 +75547,12 @@ "smithy.api#default": false, "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation
. \n Otherwise, it is UnauthorizedOperation
.
\n Options for server side encryption.\n
" + } } }, "traits": { @@ -75497,6 +75579,14 @@ "smithy.api#documentation": "The Verified Access policy document.
", "smithy.api#xmlName": "policyDocument" } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "\n Describes the options in use for server side encryption.\n
", + "smithy.api#xmlName": "sseSpecification" + } } }, "traits": { @@ -75623,8 +75713,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "The status of the Verified Access policy.
", - "smithy.api#required": {} + "smithy.api#documentation": "The status of the Verified Access policy.
" } }, "PolicyDocument": { @@ -75647,6 +75736,12 @@ "smithy.api#default": false, "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation
. \n Otherwise, it is UnauthorizedOperation
.
\n Options for server side encryption.\n
" + } } }, "traits": { @@ -75673,6 +75768,14 @@ "smithy.api#documentation": "The Verified Access policy document.
", "smithy.api#xmlName": "policyDocument" } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "\n Describes the options in use for server side encryption.\n
", + "smithy.api#xmlName": "sseSpecification" + } } }, "traits": { @@ -75969,6 +76072,12 @@ "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", "smithy.api#idempotencyToken": {} } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationRequest", + "traits": { + "smithy.api#documentation": "\n Options for server side encryption.\n
" + } } }, "traits": { @@ -88962,7 +89071,7 @@ "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressResult" }, "traits": { - "smithy.api#documentation": "Removes the specified inbound (ingress) rules from a security group.
\nYou can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.
\nFor a default VPC, if the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.
\nAmazon Web Services recommends that you describe the security group to verify that the rules were removed.
\nRule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.
" + "smithy.api#documentation": "Removes the specified inbound (ingress) rules from a security group.
\nYou can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.
\nFor a default VPC, if the values you specify do not match the existing rule's values,\n no error is returned, and the output describes the security group rules that were not\n revoked.
\nFor a non-default VPC, if the values you specify do not match the existing rule's\n values, an InvalidPermission.NotFound
client error is returned, and no\n rules are revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
\nRule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.
" } }, "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest": { @@ -101630,6 +101739,14 @@ "smithy.api#documentation": "The tags.
", "smithy.api#xmlName": "tagSet" } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "\n Describes the options in use for server side encryption.\n
", + "smithy.api#xmlName": "sseSpecification" + } } }, "traits": { @@ -101930,6 +102047,14 @@ "smithy.api#documentation": "The tags.
", "smithy.api#xmlName": "tagSet" } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "\n Describes the options in use for server side encryption.\n
", + "smithy.api#xmlName": "sseSpecification" + } } }, "traits": { @@ -102007,6 +102132,16 @@ "smithy.api#documentation": "The tags.
", "smithy.api#xmlName": "tagSet" } + }, + "FipsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "FipsEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Describes whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.
", + "smithy.api#xmlName": "fipsEnabled" + } } }, "traits": { @@ -102397,6 +102532,54 @@ "smithy.api#documentation": "Describes the options for Verified Access logs.
" } }, + "com.amazonaws.ec2#VerifiedAccessSseSpecificationRequest": { + "type": "structure", + "members": { + "CustomerManagedKeyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "\n Enable or disable the use of customer managed KMS keys for server side encryption.\n
\nValid values: True
| False
\n
\n The ARN of the KMS key.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Verified Access provides server side encryption by default to data at rest using Amazon Web Services-owned KMS keys. You also have the option of using customer managed KMS keys, which can be specified using the options below. \n
" + } + }, + "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse": { + "type": "structure", + "members": { + "CustomerManagedKeyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "CustomerManagedKeyEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "\n Describes the use of customer managed KMS keys for server side encryption.\n
\nValid values: True
| False
\n
\n Describes the ARN of the KMS key.\n
", + "smithy.api#xmlName": "kmsKeyArn" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Describes the options in use for server side encryption.\n
" + } + }, "com.amazonaws.ec2#VerifiedAccessTrustProvider": { "type": "structure", "members": { @@ -102487,6 +102670,14 @@ "smithy.api#documentation": "The tags.
", "smithy.api#xmlName": "tagSet" } + }, + "SseSpecification": { + "target": "com.amazonaws.ec2#VerifiedAccessSseSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SseSpecification", + "smithy.api#documentation": "\n Describes the options in use for server side encryption.\n
", + "smithy.api#xmlName": "sseSpecification" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json b/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json index 53befa1a513..02d7c3456e0 100644 --- a/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json +++ b/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json @@ -690,6 +690,28 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.firehose#AuthenticationConfiguration": { + "type": "structure", + "members": { + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", + "traits": { + "smithy.api#documentation": "The ARN of the role used to access the Amazon MSK cluster.
", + "smithy.api#required": {} + } + }, + "Connectivity": { + "target": "com.amazonaws.firehose#Connectivity", + "traits": { + "smithy.api#documentation": "The type of connectivity used to access the Amazon MSK cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The authentication configuration of the Amazon MSK cluster.
" + } + }, "com.amazonaws.firehose#BlockSizeBytes": { "type": "integer", "traits": { @@ -764,7 +786,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "^jdbc:(redshift|postgresql)://((?!-)[A-Za-z0-9-]{1,63}(?The destination in the Serverless offering for Amazon OpenSearch Service. You can\n specify only one destination." } + }, + "MSKSourceConfiguration": { + "target": "com.amazonaws.firehose#MSKSourceConfiguration" } }, "traits": { @@ -1488,6 +1530,12 @@ "traits": { "smithy.api#enumValue": "KinesisStreamAsSource" } + }, + "MSKAsSource": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MSKAsSource" + } } } }, @@ -4293,6 +4341,77 @@ "smithy.api#pattern": "^[^:*]*$" } }, + "com.amazonaws.firehose#MSKClusterARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^arn:" + } + }, + "com.amazonaws.firehose#MSKSourceConfiguration": { + "type": "structure", + "members": { + "MSKClusterARN": { + "target": "com.amazonaws.firehose#MSKClusterARN", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon MSK cluster.
", + "smithy.api#required": {} + } + }, + "TopicName": { + "target": "com.amazonaws.firehose#TopicName", + "traits": { + "smithy.api#documentation": "The topic name within the Amazon MSK cluster.
", + "smithy.api#required": {} + } + }, + "AuthenticationConfiguration": { + "target": "com.amazonaws.firehose#AuthenticationConfiguration", + "traits": { + "smithy.api#documentation": "The authentication configuration of the Amazon MSK cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the Amazon MSK cluster to be used as the source for a delivery\n stream.
" + } + }, + "com.amazonaws.firehose#MSKSourceDescription": { + "type": "structure", + "members": { + "MSKClusterARN": { + "target": "com.amazonaws.firehose#MSKClusterARN", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon MSK cluster.
" + } + }, + "TopicName": { + "target": "com.amazonaws.firehose#TopicName", + "traits": { + "smithy.api#documentation": "The topic name within the Amazon MSK cluster.
" + } + }, + "AuthenticationConfiguration": { + "target": "com.amazonaws.firehose#AuthenticationConfiguration", + "traits": { + "smithy.api#documentation": "The authentication configuration of the Amazon MSK cluster.
" + } + }, + "DeliveryStartTimestamp": { + "target": "com.amazonaws.firehose#DeliveryStartTimestamp", + "traits": { + "smithy.api#documentation": "Kinesis Data Firehose starts retrieving records from the topic within the Amazon MSK\n cluster starting with this timestamp.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the Amazon MSK cluster used as the source for a Kinesis Data Firehose\n delivery stream.
" + } + }, "com.amazonaws.firehose#NoEncryptionConfig": { "type": "enum", "members": { @@ -4740,6 +4859,12 @@ "traits": { "smithy.api#enumValue": "Delimiter" } + }, + "COMPRESSION_FORMAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CompressionFormat" + } } } }, @@ -4762,6 +4887,12 @@ "smithy.api#enumValue": "RecordDeAggregation" } }, + "Decompression": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Decompression" + } + }, "Lambda": { "target": "smithy.api#Unit", "traits": { @@ -4814,7 +4945,7 @@ } ], "traits": { - "smithy.api#documentation": "Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To\n write multiple data records into a delivery stream, use PutRecordBatch.\n Applications using these operations are referred to as producers.
\nBy default, each delivery stream can take in up to 2,000 transactions per second,\n 5,000 records per second, or 5 MB per second. If you use PutRecord and\n PutRecordBatch, the limits are an aggregate across these two\n operations for each delivery stream. For more information about limits and how to request\n an increase, see Amazon\n Kinesis Data Firehose Limits.
\nYou must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000\n KiB in size, and any kind of data. For example, it can be a segment from a log file,\n geographic location data, website clickstream data, and so on.
\nKinesis Data Firehose buffers records before delivering them to the destination. To\n disambiguate the data blobs at the destination, a common solution is to use delimiters in\n the data, such as a newline (\\n
) or some other character unique within the\n data. This allows the consumer application to parse individual data items when reading the\n data from the destination.
The PutRecord
operation returns a RecordId
, which is a\n unique string assigned to each record. Producer applications can use this ID for purposes\n such as auditability and investigation.
If the PutRecord
operation throws a\n ServiceUnavailableException
, back off and retry. If the exception persists,\n it is possible that the throughput limits have been exceeded for the delivery stream.
Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they\n are added to a delivery stream as it tries to send the records to the destination. If the\n destination is unreachable for more than 24 hours, the data is no longer\n available.
\nDon't concatenate two or more base64 strings to form the data fields of your records.\n Instead, concatenate the raw data, then perform base64 encoding.
\nWrites a single data record into an Amazon Kinesis Data Firehose delivery stream. To\n write multiple data records into a delivery stream, use PutRecordBatch.\n Applications using these operations are referred to as producers.
\nBy default, each delivery stream can take in up to 2,000 transactions per second,\n 5,000 records per second, or 5 MB per second. If you use PutRecord and\n PutRecordBatch, the limits are an aggregate across these two\n operations for each delivery stream. For more information about limits and how to request\n an increase, see Amazon\n Kinesis Data Firehose Limits.
\nKinesis Data Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
\nYou must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000\n KiB in size, and any kind of data. For example, it can be a segment from a log file,\n geographic location data, website clickstream data, and so on.
\nKinesis Data Firehose buffers records before delivering them to the destination. To\n disambiguate the data blobs at the destination, a common solution is to use delimiters in\n the data, such as a newline (\\n
) or some other character unique within the\n data. This allows the consumer application to parse individual data items when reading the\n data from the destination.
The PutRecord
operation returns a RecordId
, which is a\n unique string assigned to each record. Producer applications can use this ID for purposes\n such as auditability and investigation.
If the PutRecord
operation throws a\n ServiceUnavailableException
, the API is automatically reinvoked (retried) 3\n times. If the exception persists, it is possible that the throughput limits have been\n exceeded for the delivery stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can\n result in data duplicates. For larger data assets, allow for a longer time out before\n retrying Put API operations.
\nData records sent to Kinesis Data Firehose are stored for 24 hours from the time they\n are added to a delivery stream as it tries to send the records to the destination. If the\n destination is unreachable for more than 24 hours, the data is no longer\n available.
\nDon't concatenate two or more base64 strings to form the data fields of your records.\n Instead, concatenate the raw data, then perform base64 encoding.
\nWrites multiple data records into a delivery stream in a single call, which can\n achieve higher throughput per producer than when writing single records. To write single\n data records into a delivery stream, use PutRecord. Applications using\n these operations are referred to as producers.
\nFor information about service quota, see Amazon Kinesis Data Firehose\n Quota.
\nEach PutRecordBatch request supports up to 500 records. Each record\n in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB\n for the entire request. These limits cannot be changed.
\nYou must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000\n KB in size, and any kind of data. For example, it could be a segment from a log file,\n geographic location data, website clickstream data, and so on.
\nKinesis Data Firehose buffers records before delivering them to the destination. To\n disambiguate the data blobs at the destination, a common solution is to use delimiters in\n the data, such as a newline (\\n
) or some other character unique within the\n data. This allows the consumer application to parse individual data items when reading the\n data from the destination.
The PutRecordBatch response includes a count of failed records,\n FailedPutCount
, and an array of responses, RequestResponses
.\n Even if the PutRecordBatch call succeeds, the value of\n FailedPutCount
may be greater than 0, indicating that there are records for\n which the operation didn't succeed. Each entry in the RequestResponses
array\n provides additional information about the processed record. It directly correlates with a\n record in the request array using the same ordering, from the top to the bottom. The\n response array always includes the same number of records as the request array.\n RequestResponses
includes both successfully and unsuccessfully processed\n records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing\n of subsequent records.
A successfully processed record includes a RecordId
value, which is\n unique for the record. An unsuccessfully processed record includes ErrorCode
\n and ErrorMessage
values. ErrorCode
reflects the type of error,\n and is one of the following values: ServiceUnavailableException
or\n InternalFailure
. ErrorMessage
provides more detailed\n information about the error.
If there is an internal server error or a timeout, the write might have completed or\n it might have failed. If FailedPutCount
is greater than 0, retry the request,\n resending only those records that might have failed processing. This minimizes the possible\n duplicate records and also reduces the total bytes sent (and corresponding charges). We\n recommend that you handle any duplicates at the destination.
If PutRecordBatch throws ServiceUnavailableException
,\n back off and retry. If the exception persists, it is possible that the throughput limits\n have been exceeded for the delivery stream.
Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they\n are added to a delivery stream as it attempts to send the records to the destination. If\n the destination is unreachable for more than 24 hours, the data is no longer\n available.
\nDon't concatenate two or more base64 strings to form the data fields of your records.\n Instead, concatenate the raw data, then perform base64 encoding.
\nWrites multiple data records into a delivery stream in a single call, which can\n achieve higher throughput per producer than when writing single records. To write single\n data records into a delivery stream, use PutRecord. Applications using\n these operations are referred to as producers.
\nKinesis Data Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
\nFor information about service quota, see Amazon Kinesis Data Firehose\n Quota.
\nEach PutRecordBatch request supports up to 500 records. Each record\n in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB\n for the entire request. These limits cannot be changed.
\nYou must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000\n KB in size, and any kind of data. For example, it could be a segment from a log file,\n geographic location data, website clickstream data, and so on.
\nKinesis Data Firehose buffers records before delivering them to the destination. To\n disambiguate the data blobs at the destination, a common solution is to use delimiters in\n the data, such as a newline (\\n
) or some other character unique within the\n data. This allows the consumer application to parse individual data items when reading the\n data from the destination.
The PutRecordBatch response includes a count of failed records,\n FailedPutCount
, and an array of responses, RequestResponses
.\n Even if the PutRecordBatch call succeeds, the value of\n FailedPutCount
may be greater than 0, indicating that there are records for\n which the operation didn't succeed. Each entry in the RequestResponses
array\n provides additional information about the processed record. It directly correlates with a\n record in the request array using the same ordering, from the top to the bottom. The\n response array always includes the same number of records as the request array.\n RequestResponses
includes both successfully and unsuccessfully processed\n records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing\n of subsequent records.
A successfully processed record includes a RecordId
value, which is\n unique for the record. An unsuccessfully processed record includes ErrorCode
\n and ErrorMessage
values. ErrorCode
reflects the type of error,\n and is one of the following values: ServiceUnavailableException
or\n InternalFailure
. ErrorMessage
provides more detailed\n information about the error.
If there is an internal server error or a timeout, the write might have completed or\n it might have failed. If FailedPutCount
is greater than 0, retry the request,\n resending only those records that might have failed processing. This minimizes the possible\n duplicate records and also reduces the total bytes sent (and corresponding charges). We\n recommend that you handle any duplicates at the destination.
If PutRecordBatch throws ServiceUnavailableException
,\n the API is automatically reinvoked (retried) 3 times. If the exception persists, it is\n possible that the throughput limits have been exceeded for the delivery stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can\n result in data duplicates. For larger data assets, allow for a longer time out before\n retrying Put API operations.
\nData records sent to Kinesis Data Firehose are stored for 24 hours from the time they\n are added to a delivery stream as it attempts to send the records to the destination. If\n the destination is unreachable for more than 24 hours, the data is no longer\n available.
\nDon't concatenate two or more base64 strings to form the data fields of your records.\n Instead, concatenate the raw data, then perform base64 encoding.
\nThe KinesisStreamSourceDescription value for the source Kinesis\n data stream.
" } + }, + "MSKSourceDescription": { + "target": "com.amazonaws.firehose#MSKSourceDescription", + "traits": { + "smithy.api#documentation": "The configuration description for the Amazon MSK cluster to be used as the source for a delivery\n stream.
" + } } }, "traits": { @@ -5902,7 +6039,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables server-side encryption (SSE) for the delivery stream.
\nThis operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data\n Firehose first sets the encryption status of the stream to ENABLING
, and then\n to ENABLED
. The encryption status of a delivery stream is the\n Status
property in DeliveryStreamEncryptionConfiguration.\n If the operation fails, the encryption status changes to ENABLING_FAILED
. You\n can continue to read and write data to your delivery stream while the encryption status is\n ENABLING
, but the data is not encrypted. It can take up to 5 seconds after\n the encryption status changes to ENABLED
before all records written to the\n delivery stream are encrypted. To find out whether a record or a batch of records was\n encrypted, check the response elements PutRecordOutput$Encrypted and\n PutRecordBatchOutput$Encrypted, respectively.
To check the encryption status of a delivery stream, use DescribeDeliveryStream.
\nEven if encryption is currently enabled for a delivery stream, you can still invoke this\n operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this\n method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK
,\n Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. If the new\n CMK is of type CUSTOMER_MANAGED_CMK
, Kinesis Data Firehose creates a grant\n that enables it to use the new CMK to encrypt and decrypt data and to manage the\n grant.
If a delivery stream already has encryption enabled and then you invoke this operation\n to change the ARN of the CMK or both its type and ARN and you get\n ENABLING_FAILED
, this only means that the attempt to change the CMK failed.\n In this case, encryption remains enabled with the old CMK.
If the encryption status of your delivery stream is ENABLING_FAILED
, you\n can invoke this operation again with a valid CMK. The CMK must be enabled and the key\n policy mustn't explicitly deny the permission for Kinesis Data Firehose to invoke KMS\n encrypt and decrypt operations.
You can enable SSE for a delivery stream only if it's a delivery stream that uses\n DirectPut
as its source.
The StartDeliveryStreamEncryption
and\n StopDeliveryStreamEncryption
operations have a combined limit of 25 calls\n per delivery stream per 24 hours. For example, you reach the limit if you call\n StartDeliveryStreamEncryption
13 times and\n StopDeliveryStreamEncryption
12 times for the same delivery stream in a\n 24-hour period.
Enables server-side encryption (SSE) for the delivery stream.
\nThis operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data\n Firehose first sets the encryption status of the stream to ENABLING
, and then\n to ENABLED
. The encryption status of a delivery stream is the\n Status
property in DeliveryStreamEncryptionConfiguration.\n If the operation fails, the encryption status changes to ENABLING_FAILED
. You\n can continue to read and write data to your delivery stream while the encryption status is\n ENABLING
, but the data is not encrypted. It can take up to 5 seconds after\n the encryption status changes to ENABLED
before all records written to the\n delivery stream are encrypted. To find out whether a record or a batch of records was\n encrypted, check the response elements PutRecordOutput$Encrypted and\n PutRecordBatchOutput$Encrypted, respectively.
To check the encryption status of a delivery stream, use DescribeDeliveryStream.
\nEven if encryption is currently enabled for a delivery stream, you can still invoke this\n operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this\n method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK
,\n Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. If the new\n CMK is of type CUSTOMER_MANAGED_CMK
, Kinesis Data Firehose creates a grant\n that enables it to use the new CMK to encrypt and decrypt data and to manage the\n grant.
For the KMS grant creation to be successful, Kinesis Data Firehose APIs StartDeliveryStreamEncryption
and CreateDeliveryStream
should not be called with session credentials that are more than 6 hours old.
If a delivery stream already has encryption enabled and then you invoke this operation\n to change the ARN of the CMK or both its type and ARN and you get\n ENABLING_FAILED
, this only means that the attempt to change the CMK failed.\n In this case, encryption remains enabled with the old CMK.
If the encryption status of your delivery stream is ENABLING_FAILED
, you\n can invoke this operation again with a valid CMK. The CMK must be enabled and the key\n policy mustn't explicitly deny the permission for Kinesis Data Firehose to invoke KMS\n encrypt and decrypt operations.
You can enable SSE for a delivery stream only if it's a delivery stream that uses\n DirectPut
as its source.
The StartDeliveryStreamEncryption
and\n StopDeliveryStreamEncryption
operations have a combined limit of 25 calls\n per delivery stream per 24 hours. For example, you reach the limit if you call\n StartDeliveryStreamEncryption
13 times and\n StopDeliveryStreamEncryption
12 times for the same delivery stream in a\n 24-hour period.
The criteria that determine if a device is behaving normally in regard to\n the metric
.
The criteria that determine if a device is behaving normally in regard to the metric
.
In the IoT console, you can choose to be sent an alert through Amazon SNS when IoT Device Defender detects that a device is behaving anomalously.
\nCreates an X.509 certificate using the specified certificate signing\n request.\n
\nRequires permission to access the CreateCertificateFromCsr action.\n
\nThe CSR must include a public key that is either an\n RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. \n For supported certificates, consult \n Certificate signing algorithms supported by IoT.\n
\nReusing the same certificate signing request (CSR)\n results in a distinct certificate.
\nYou can create multiple certificates in a batch by creating a directory, copying\n multiple .csr
files into that directory, and then specifying that directory on the command\n line. The following commands show how to create a batch of certificates given a batch of\n CSRs. In the following commands, we assume that a set of CSRs are located inside of the\n directory my-csr-directory:
On Linux and OS X, the command is:
\n\n $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}
\n
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name\n to the aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for\n the corresponding CSR.
You can also run the aws iot create-certificate-from-csr
part of the\n command in parallel to speed up the certificate creation process:
\n $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}\n
\n
On Windows PowerShell, the command to create certificates for all CSRs in\n my-csr-directory is:
\n\n > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/$_}\n
\n
On a Windows command prompt, the command to create certificates for all CSRs in\n my-csr-directory is:
\n\n > forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr\n --certificate-signing-request file://@path\"\n
\n
Creates an X.509 certificate using the specified certificate signing\n request.\n
\nRequires permission to access the CreateCertificateFromCsr action.\n
\nThe CSR must include a public key that is either an RSA key with a length of at least\n 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521 curves. For supported\n certificates, consult Certificate signing algorithms supported by IoT.
\nReusing the same certificate signing request (CSR)\n results in a distinct certificate.
\nYou can create multiple certificates in a batch by creating a directory, copying\n multiple .csr
files into that directory, and then specifying that directory on the command\n line. The following commands show how to create a batch of certificates given a batch of\n CSRs. In the following commands, we assume that a set of CSRs are located inside of the\n directory my-csr-directory:
On Linux and OS X, the command is:
\n\n $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}
\n
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name\n to the aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for\n the corresponding CSR.
You can also run the aws iot create-certificate-from-csr
part of the\n command in parallel to speed up the certificate creation process:
\n $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}\n
\n
On Windows PowerShell, the command to create certificates for all CSRs in\n my-csr-directory is:
\n\n > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/$_}\n
\n
On a Windows command prompt, the command to create certificates for all CSRs in\n my-csr-directory is:
\n\n > forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr\n --certificate-signing-request file://@path\"\n
\n
An S3 link to the job document to use in the template. Required if you don't specify a value for document
.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
\nThe placeholder link is of the following form:
\n\n ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
\n
where bucket is your bucket name and key is the object in the bucket to which you are linking.
\nAn S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document
.
For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
\n
For more information, see Methods for accessing a bucket.
" } }, "document": { @@ -7705,7 +7705,7 @@ "additionalParameters": { "target": "com.amazonaws.iot#AdditionalParameterMap", "traits": { - "smithy.api#documentation": "A list of additional OTA update parameters which are name-value pairs.
" + "smithy.api#documentation": "A list of additional OTA update parameters, which are name-value pairs. \n They won't be sent to devices as a part of the Job document.
" } }, "tags": { @@ -7798,7 +7798,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the new package.
", + "smithy.api#documentation": "The name of the new software package.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7834,7 +7834,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the package.
" + "smithy.api#documentation": "The name of the software package.
" } }, "packageArn": { @@ -7895,7 +7895,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the associated package.
", + "smithy.api#documentation": "The name of the associated software package.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7951,7 +7951,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the associated package.
" + "smithy.api#documentation": "The name of the associated software package.
" } }, "versionName": { @@ -10560,7 +10560,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the target package.
", + "smithy.api#documentation": "The name of the target software package.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10605,7 +10605,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specific version from a software package.
\n\n Note: If a package version is designated as default, you must remove the designation from the package using the UpdatePackage action.
", + "smithy.api#documentation": "Deletes a specific version from a software package.
\n\n Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.
", "smithy.api#http": { "method": "DELETE", "uri": "/packages/{packageName}/versions/{versionName}", @@ -10620,7 +10620,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the associated package.
", + "smithy.api#documentation": "The name of the associated software package.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12811,7 +12811,7 @@ "endpointType": { "target": "com.amazonaws.iot#EndpointType", "traits": { - "smithy.api#documentation": "The endpoint type. Valid endpoint types include:
\n\n iot:Data
- Returns a VeriSign signed data endpoint.
\n iot:Data-ATS
- Returns an ATS signed data endpoint.
\n iot:CredentialProvider
- Returns an IoT credentials provider API\n endpoint.
\n iot:Jobs
- Returns an IoT device management Jobs API\n endpoint.
We strongly recommend that customers use the newer iot:Data-ATS
endpoint type to avoid \n issues related to the widespread distrust of Symantec certificate authorities.
The endpoint type. Valid endpoint types include:
\n\n iot:Data
- Returns a VeriSign signed data endpoint.
\n iot:Data-ATS
- Returns an ATS signed data endpoint.
\n iot:CredentialProvider
- Returns an IoT credentials provider API\n endpoint.
\n iot:Jobs
- Returns an IoT device management Jobs API\n endpoint.
We strongly recommend that customers use the newer iot:Data-ATS
endpoint type to avoid \n issues related to the widespread distrust of Symantec certificate authorities. ATS Signed Certificates\n are more secure and are trusted by most popular browsers.
The name of the target package.
", + "smithy.api#documentation": "The name of the target software package.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17158,7 +17158,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the package.
" + "smithy.api#documentation": "The name of the software package.
" } }, "packageArn": { @@ -17263,7 +17263,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the package.
" + "smithy.api#documentation": "The name of the software package.
" } }, "versionName": { @@ -19397,12 +19397,70 @@ "smithy.api#documentation": "Properties of the Apache Kafka producer client.
", "smithy.api#required": {} } + }, + "headers": { + "target": "com.amazonaws.iot#KafkaHeaders", + "traits": { + "smithy.api#documentation": "The list of Kafka headers that you specify.
" + } } }, "traits": { "smithy.api#documentation": "Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
" } }, + "com.amazonaws.iot#KafkaActionHeader": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.iot#KafkaHeaderKey", + "traits": { + "smithy.api#documentation": "The key of the Kafka header.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.iot#KafkaHeaderValue", + "traits": { + "smithy.api#documentation": "The value of the Kafka header.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action.\n You can use these headers to route data from IoT clients to downstream Kafka clusters\n without modifying your message payload.
\nFor more information about Rule's Kafka action, see Apache Kafka.\n
" + } + }, + "com.amazonaws.iot#KafkaHeaderKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16384 + } + } + }, + "com.amazonaws.iot#KafkaHeaderValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16384 + } + } + }, + "com.amazonaws.iot#KafkaHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#KafkaActionHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.iot#Key": { "type": "string" }, @@ -22243,7 +22301,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the target package.
", + "smithy.api#documentation": "The name of the target software package.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -25234,6 +25292,18 @@ "traits": { "smithy.api#enumValue": "PRINCIPAL_ID" } + }, + "EVENT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT_TYPE" + } + }, + "DEVICE_DEFENDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVICE_DEFENDER" + } } } }, @@ -26100,7 +26170,7 @@ "attributes": { "target": "com.amazonaws.iot#AttributesMap", "traits": { - "smithy.api#documentation": "A list of name/attribute pairs.
" + "smithy.api#documentation": "A list of name-attribute pairs. They won't be sent to devices as a part of the Job document.
" } } }, @@ -26445,7 +26515,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name for the target package.
" + "smithy.api#documentation": "The name for the target software package.
" } }, "defaultVersionName": { @@ -28895,13 +28965,13 @@ "startTime": { "target": "com.amazonaws.iot#StringDateTime", "traits": { - "smithy.api#documentation": "The time a job will begin rollout of the job document to all devices in the target\n group for a job. The startTime
can be scheduled up to a year in advance and\n must be scheduled a minimum of thirty minutes from the current time. The date and time\n format for the startTime
is YYYY-MM-DD for the date and HH:MM for the\n time.
The time a job will begin rollout of the job document to all devices in the target\n group for a job. The startTime
can be scheduled up to a year in advance and\n must be scheduled a minimum of thirty minutes from the current time. The date and time\n format for the startTime
is YYYY-MM-DD for the date and HH:MM for the\n time.
For more information on the syntax for startTime
when using an API\n command or the Command Line Interface, see Timestamp.
The time a job will stop rollout of the job document to all devices in the target\n group for a job. The endTime
must take place no later than two years from\n the current time and be scheduled a minimum of thirty minutes from the current time. The\n minimum duration between startTime
and endTime
is thirty\n minutes. The maximum duration between startTime
and endTime
is\n two years. The date and time format for the endTime
is YYYY-MM-DD for the\n date and HH:MM for the time.
The time a job will stop rollout of the job document to all devices in the target\n group for a job. The endTime
must take place no later than two years from\n the current time and be scheduled a minimum of thirty minutes from the current time. The\n minimum duration between startTime
and endTime
is thirty\n minutes. The maximum duration between startTime
and endTime
is\n two years. The date and time format for the endTime
is YYYY-MM-DD for the\n date and HH:MM for the time.
For more information on the syntax for endTime
when using an API command\n or the Command Line Interface, see Timestamp.
Updates the supported fields for a specific package.
\nRequires permission to access the UpdatePackage and GetIndexingConfiguration actions.
", + "smithy.api#documentation": "Updates the supported fields for a specific software package.
\nRequires permission to access the UpdatePackage and GetIndexingConfiguration actions.
", "smithy.api#http": { "method": "PATCH", "uri": "/packages/{packageName}", @@ -33891,7 +33961,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the package configuration.
\nRequires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
", + "smithy.api#documentation": "Updates the software package configuration.
\nRequires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
", "smithy.api#http": { "method": "PATCH", "uri": "/package-configuration", @@ -33935,7 +34005,7 @@ "packageName": { "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the target package.
", + "smithy.api#documentation": "The name of the target software package.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -34038,7 +34108,7 @@ "attributes": { "target": "com.amazonaws.iot#ResourceAttributes", "traits": { - "smithy.api#documentation": "Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.
\n\n Note: Attributes can be updated only when the package version\n is in a draft state.
\nThe combined size of all the attributes on a package version is limited to 3KB.
" + "smithy.api#documentation": "Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.
\n\n Note: Attributes can be updated only when the package version\n is in a draft state.
\nThe combined size of all the attributes on a package version is limited to 3KB.
" } }, "action": { diff --git a/codegen/sdk-codegen/aws-models/iotfleetwise.2021-06-17.json b/codegen/sdk-codegen/aws-models/iotfleetwise.2021-06-17.json index 5690793377c..76225ad4526 100644 --- a/codegen/sdk-codegen/aws-models/iotfleetwise.2021-06-17.json +++ b/codegen/sdk-codegen/aws-models/iotfleetwise.2021-06-17.json @@ -911,7 +911,7 @@ "dataDestinationConfigs": { "target": "com.amazonaws.iotfleetwise#DataDestinationConfigs", "traits": { - "smithy.api#documentation": "The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
\nAmazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
\nYou can use Amazon Timestream to access and analyze time series data, and Timestream to query\n vehicle data so that you can identify trends and patterns.
" + "smithy.api#documentation": "The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
\nAmazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
\nYou can use Amazon Timestream to access and analyze time series data, and Timestream to query\n vehicle data so that you can identify trends and patterns.
" } } } @@ -2165,6 +2165,40 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotfleetwise#EncryptionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "FAILURE", + "name": "FAILURE" + } + ] + } + }, + "com.amazonaws.iotfleetwise#EncryptionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KMS_BASED_ENCRYPTION", + "name": "KMS_BASED_ENCRYPTION" + }, + { + "value": "FLEETWISE_DEFAULT_ENCRYPTION", + "name": "FLEETWISE_DEFAULT_ENCRYPTION" + } + ] + } + }, "com.amazonaws.iotfleetwise#FleetAssociationResource": { "type": "resource", "identifiers": { @@ -2556,6 +2590,94 @@ } } }, + "com.amazonaws.iotfleetwise#GetEncryptionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#GetEncryptionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#GetEncryptionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
", + "smithy.api#http": { + "method": "GET", + "uri": "/encryptionConfiguration", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.iotfleetwise#GetEncryptionConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotfleetwise#GetEncryptionConfigurationResponse": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the KMS key that is used for encryption.
" + } + }, + "encryptionStatus": { + "target": "com.amazonaws.iotfleetwise#EncryptionStatus", + "traits": { + "smithy.api#documentation": "The encryption status.
", + "smithy.api#required": {} + } + }, + "encryptionType": { + "target": "com.amazonaws.iotfleetwise#EncryptionType", + "traits": { + "smithy.api#documentation": "The type of encryption. Set to KMS_BASED_ENCRYPTION
to use an KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION
to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.
The error message that describes why encryption settings couldn't be configured, if applicable.
" + } + }, + "creationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + }, + "lastModificationTime": { + "target": "com.amazonaws.iotfleetwise#timestamp", + "traits": { + "smithy.api#documentation": "The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iotfleetwise#GetFleet": { "type": "operation", "input": { @@ -3546,6 +3668,9 @@ { "target": "com.amazonaws.iotfleetwise#BatchUpdateVehicle" }, + { + "target": "com.amazonaws.iotfleetwise#GetEncryptionConfiguration" + }, { "target": "com.amazonaws.iotfleetwise#GetLoggingOptions" }, @@ -3558,6 +3683,9 @@ { "target": "com.amazonaws.iotfleetwise#ListTagsForResource" }, + { + "target": "com.amazonaws.iotfleetwise#PutEncryptionConfiguration" + }, { "target": "com.amazonaws.iotfleetwise#PutLoggingOptions" }, @@ -5996,6 +6124,92 @@ } } }, + "com.amazonaws.iotfleetwise#PutEncryptionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleetwise#PutEncryptionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iotfleetwise#PutEncryptionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleetwise#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotfleetwise#ConflictException" + }, + { + "target": "com.amazonaws.iotfleetwise#InternalServerException" + }, + { + "target": "com.amazonaws.iotfleetwise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise Developer Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/encryptionConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.iotfleetwise#PutEncryptionConfigurationRequest": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the KMS key that is used for encryption.
" + } + }, + "encryptionType": { + "target": "com.amazonaws.iotfleetwise#EncryptionType", + "traits": { + "smithy.api#documentation": "The type of encryption. Choose KMS_BASED_ENCRYPTION
to use a KMS key or FLEETWISE_DEFAULT_ENCRYPTION
to use an Amazon Web Services managed key.
The ID of the KMS key that is used for encryption.
" + } + }, + "encryptionStatus": { + "target": "com.amazonaws.iotfleetwise#EncryptionStatus", + "traits": { + "smithy.api#documentation": "The encryption status.
", + "smithy.api#required": {} + } + }, + "encryptionType": { + "target": "com.amazonaws.iotfleetwise#EncryptionType", + "traits": { + "smithy.api#documentation": "The type of encryption. Set to KMS_BASED_ENCRYPTION
to use an KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION
to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.
Enforce Lake Formation permissions for the given databases, tables, and principals.
", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateLakeFormationOptIn", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#CreateLakeFormationOptInRequest": { + "type": "structure", + "members": { + "Principal": { + "target": "com.amazonaws.lakeformation#DataLakePrincipal", + "traits": { + "smithy.api#required": {} + } + }, + "Resource": { + "target": "com.amazonaws.lakeformation#Resource", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lakeformation#CreateLakeFormationOptInResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger": { "type": "integer", "traits": { @@ -2501,6 +2574,70 @@ "smithy.api#output": {} } }, + "com.amazonaws.lakeformation#DeleteLakeFormationOptIn": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#DeleteLakeFormationOptInRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#DeleteLakeFormationOptInResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteLakeFormationOptIn", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#DeleteLakeFormationOptInRequest": { + "type": "structure", + "members": { + "Principal": { + "target": "com.amazonaws.lakeformation#DataLakePrincipal", + "traits": { + "smithy.api#required": {} + } + }, + "Resource": { + "target": "com.amazonaws.lakeformation#Resource", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lakeformation#DeleteLakeFormationOptInResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lakeformation#DeleteObjectInput": { "type": "structure", "members": { @@ -4331,7 +4468,7 @@ "TagValues": { "target": "com.amazonaws.lakeformation#TagValueList", "traits": { - "smithy.api#documentation": "A list of possible values an attribute can take.
", + "smithy.api#documentation": "A list of possible values an attribute can take.
\nThe maximum number of values that can be defined for a LF-Tag is 1000. A single API call\n supports 50 values. You can use multiple API calls to add more values.
", "smithy.api#required": {} } } @@ -4482,6 +4619,38 @@ } } }, + "com.amazonaws.lakeformation#LakeFormationOptInsInfo": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.lakeformation#Resource" + }, + "Principal": { + "target": "com.amazonaws.lakeformation#DataLakePrincipal" + }, + "LastModified": { + "target": "com.amazonaws.lakeformation#LastModifiedTimestamp", + "traits": { + "smithy.api#documentation": "The last modified date and time of the record.
" + } + }, + "LastUpdatedBy": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The user who updated the record.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A single principal-resource pair that has Lake Formation permissins enforced.
" + } + }, + "com.amazonaws.lakeformation#LakeFormationOptInsInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#LakeFormationOptInsInfo" + } + }, "com.amazonaws.lakeformation#LastModifiedTimestamp": { "type": "timestamp" }, @@ -4660,6 +4829,91 @@ "smithy.api#output": {} } }, + "com.amazonaws.lakeformation#ListLakeFormationOptIns": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#ListLakeFormationOptInsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#ListLakeFormationOptInsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListLakeFormationOptIns", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lakeformation#ListLakeFormationOptInsRequest": { + "type": "structure", + "members": { + "Principal": { + "target": "com.amazonaws.lakeformation#DataLakePrincipal" + }, + "Resource": { + "target": "com.amazonaws.lakeformation#Resource", + "traits": { + "smithy.api#documentation": "A structure for the resource.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lakeformation#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is not the first call to retrieve this list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lakeformation#ListLakeFormationOptInsResponse": { + "type": "structure", + "members": { + "LakeFormationOptInsInfoList": { + "target": "com.amazonaws.lakeformation#LakeFormationOptInsInfoList", + "traits": { + "smithy.api#documentation": "A list of principal-resource pairs that have Lake Formation permissins enforced.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is not the first call to retrieve this list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lakeformation#ListPermissions": { "type": "operation", "input": { @@ -5445,6 +5699,18 @@ "traits": { "smithy.api#documentation": "This attribute can be used to return any additional details of PrincipalResourcePermissions
. Currently returns only as a RAM resource share ARN.
The date and time when the resource was last updated.
" + } + }, + "LastUpdatedBy": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The user who updated the record.
" + } } }, "traits": { @@ -5675,6 +5941,12 @@ "traits": { "smithy.api#documentation": "Whether or not the resource is a federated resource.
" } + }, + "HybridAccessEnabled": { + "target": "com.amazonaws.lakeformation#NullableBoolean", + "traits": { + "smithy.api#documentation": "\n Specifies whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.\n
" + } } }, "traits": { @@ -5855,6 +6127,12 @@ "traits": { "smithy.api#documentation": "Whether or not the resource is a federated resource.
" } + }, + "HybridAccessEnabled": { + "target": "com.amazonaws.lakeformation#NullableBoolean", + "traits": { + "smithy.api#documentation": "\n Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.\n
" + } } }, "traits": { @@ -7104,6 +7382,12 @@ "traits": { "smithy.api#documentation": "Whether or not the resource is a federated resource.
" } + }, + "HybridAccessEnabled": { + "target": "com.amazonaws.lakeformation#NullableBoolean", + "traits": { + "smithy.api#documentation": "\n Specifies whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.\n
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json b/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json index 3f1caebf716..391394c7562 100644 --- a/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json +++ b/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json @@ -612,7 +612,7 @@ "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "The unique identifier of the network for the node.
\nEthereum public networks have the following NetworkId
s:
\n n-ethereum-mainnet
\n
\n n-ethereum-goerli
\n
\n n-ethereum-rinkeby
\n
The unique identifier of the network for the node.
\nEthereum public networks have the following NetworkId
s:
\n n-ethereum-mainnet
\n
\n n-ethereum-goerli
\n
The unique identifier of the network that the node is on.
\nEthereum public networks have the following NetworkId
s:
\n n-ethereum-mainnet
\n
\n n-ethereum-goerli
\n
\n n-ethereum-rinkeby
\n
The unique identifier of the network that the node is on.
\nEthereum public networks have the following NetworkId
s:
\n n-ethereum-mainnet
\n
\n n-ethereum-goerli
\n
The Ethereum CHAIN_ID
associated with the Ethereum network. Chain IDs are as follows:
mainnet = 1
\n
goerli = 5
\n
rinkeby = 4
\n
The Ethereum CHAIN_ID
associated with the Ethereum network. Chain IDs are as follows:
mainnet = 1
\n
goerli = 5
\n
Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
", + "smithy.api#documentation": "Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.
", "smithy.api#http": { "method": "PUT", "uri": "/v1/apps/{ApplicationId}/attributes/{AttributeType}", diff --git a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json index 8ffdc277a65..53241d63217 100644 --- a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json @@ -2721,6 +2721,12 @@ "com.amazonaws.rds#CertificateMessage": { "type": "structure", "members": { + "DefaultCertificateForNewLaunches": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override \n set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the \n ModifyCertificates
operation.
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
", + "smithy.api#documentation": "Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -19156,7 +19162,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether major version upgrades are allowed.
\nValid for Cluster Type: Aurora DB clusters only
\nConstraints:
\nYou must allow major version upgrades when specifying a value for the\n EngineVersion
parameter that is a different major version than the DB\n cluster's current version.
Specifies whether major version upgrades are allowed.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nYou must allow major version upgrades when specifying a value for the\n EngineVersion
parameter that is a different major version than the DB\n cluster's current version.
The new compute and memory capacity of the DB instance, for example db.m4.large
. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately
in your request.
Default: Uses existing setting
" + "smithy.api#documentation": "The new compute and memory capacity of the DB instance, for example db.m4.large
. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately
in your request.
Default: Uses existing setting
\nConstraints:
\nIf you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the \n specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to modify the DB instance class, \n and then run it again to upgrade the engine version.
\nThe version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately
parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS updates the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance
, \n or call DescribeDBEngineVersions
.
If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or higher than the version that the source DB instance\n or cluster is running.
\nIn RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE
lifecycle.
The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately
parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS updates the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance
, \n or call DescribeDBEngineVersions
.
If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or higher than the version that the source DB instance\n or cluster is running.
\nIn RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE
lifecycle.
Constraints:
\nIf you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the \n specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to modify the DB instance class, \n and then run it again to upgrade the engine version.
\nThe name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the custom DB cluster parameter group to associate with this DB cluster.
\nIf the DBClusterParameterGroupName
parameter is omitted, the default DB cluster parameter group for the specified\n engine is used.
Constraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DeletionProtection": { @@ -24526,7 +24532,7 @@ "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see \n DB instance class in the \n Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" } }, "StorageType": { @@ -25404,7 +25410,7 @@ } ], "traits": { - "smithy.api#documentation": "Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
\nThe target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.
\nThis command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime
.
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime
property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod
property.
The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.
\nThis command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime
.
The name of the new DB instance to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the new DB instance to create.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe date and time to restore from.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nCan't be specified if the UseLatestRestorableTime
parameter is enabled
Example: 2009-09-07T23:45:00Z
\n
The date and time to restore from.
\nConstraints:
\nMust be a time in Universal Coordinated Time (UTC) format.
\nMust be before the latest restorable time for the DB instance.
\nCan't be specified if the UseLatestRestorableTime
parameter is enabled.
Example: 2009-09-07T23:45:00Z
\n
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.
\nConstraints: Can't be specified if the RestoreTime
parameter is provided.
Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.
\nConstraints:
\nCan't be specified if the RestoreTime
parameter is provided.
The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.
\nDefault: The same DBInstanceClass as the original DB instance.
" + "smithy.api#documentation": "The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.
\nDefault: The same DB instance class as the original DB instance.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the database accepts connections.
\nConstraints: Value must be 1150-65535
\n
Default: The same port as the original DB instance.
" + "smithy.api#documentation": "The port number on which the database accepts connections.
\nDefault: The same port as the original DB instance.
\nConstraints:
\nThe value must be 1150-65535
.
The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
\n
The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraints:
\nYou can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
\n
The DB subnet group name to use for the new instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup
\n
The DB subnet group name to use for the new instance.
\nConstraints:
\nIf supplied, must match the name of an existing DB subnet group.
\nExample: mydbsubnetgroup
\n
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone
parameter if the DB instance is a \n Multi-AZ deployment.
Secifies whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nYou can't specify the AvailabilityZone
parameter if the DB instance is a \n Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "Specifies whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\nValid values: license-included
| bring-your-own-license
| general-public-license
\n
The license model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nValid Values: license-included
| bring-your-own-license
| general-public-license
\n
Default: Same as the source.
" } }, "DBName": { @@ -25583,25 +25589,25 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\nValid Values:
\n\n mariadb
\n
\n mysql
\n
\n oracle-ee
\n
\n oracle-ee-cdb
\n
\n oracle-se2
\n
\n oracle-se2-cdb
\n
\n postgres
\n
\n sqlserver-ee
\n
\n sqlserver-se
\n
\n sqlserver-ex
\n
\n sqlserver-web
\n
The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nValid Values:
\n\n mariadb
\n
\n mysql
\n
\n oracle-ee
\n
\n oracle-ee-cdb
\n
\n oracle-se2
\n
\n oracle-se2-cdb
\n
\n postgres
\n
\n sqlserver-ee
\n
\n sqlserver-se
\n
\n sqlserver-ex
\n
\n sqlserver-web
\n
Default: The same as source
\nConstraints:
\nMust be compatible with the engine of the source.
\nThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
\nConstraints: Must be an integer greater than 1000.
\n\n SQL Server\n
\nSetting the IOPS value for the SQL Server database engine isn't supported.
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
\nThis setting doesn't apply to SQL Server.
\nConstraints:
\nMust be an integer greater than 1000.
\nThe name of the option group to be used for the restored DB instance.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The name of the option group to use for the restored DB instance.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
\nThis setting doesn't apply to RDS Custom.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
" + "smithy.api#documentation": "Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
" } }, "Tags": { @@ -25610,7 +25616,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard
\n
If you specify io1
or gp3
, you must also include a value for the\n Iops
parameter.
Default: io1
if the Iops
parameter\n is specified, otherwise gp2
\n
The storage type to associate with the DB instance.
\nValid Values: gp2 | gp3 | io1 | standard
\n
Default: io1
, if the Iops
parameter\n is specified. Otherwise, gp2
.
Constraints:
\nIf you specify io1
or gp3
, you must also include a value for the\n Iops
parameter.
Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nThis setting doesn't apply to RDS Custom.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nThis setting doesn't apply to RDS Custom.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" } }, "DomainIAMRoleName": { @@ -25670,7 +25676,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnableCloudwatchLogsExports": { @@ -25694,13 +25700,13 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName
, then the default DBParameterGroup
\n for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName
, then the default DBParameterGroup
\n for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DB parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nA value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" + "smithy.api#documentation": "Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" } }, "SourceDbiResourceId": { @@ -25718,13 +25724,13 @@ "SourceDBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "CustomIamInstanceProfile": { @@ -25742,13 +25748,13 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4
\n
\n DUAL
\n
The network type is determined by the DBSubnetGroup
specified for the DB instance. \n A DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL
).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nThe network type is determined by the DBSubnetGroup
specified for the DB instance. \n A DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL
).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
\nValid Values:
\n\n IPV4
\n
\n DUAL
\n
Specifies the storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "The storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" } }, "AllocatedStorage": { diff --git a/codegen/sdk-codegen/aws-models/s3.2006-03-01.json b/codegen/sdk-codegen/aws-models/s3.2006-03-01.json index d63436f320d..f119125dd9e 100644 --- a/codegen/sdk-codegen/aws-models/s3.2006-03-01.json +++ b/codegen/sdk-codegen/aws-models/s3.2006-03-01.json @@ -17285,16 +17285,13 @@ "smithy.api#documentation": "Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming\n rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. To constrain the bucket creation to a\n specific Region, you can use \n LocationConstraint
\n condition key. You might choose a Region to\n optimize latency, minimize costs, or address regulatory requirements. For example, if you\n reside in Europe, you will probably find it advantageous to create buckets in the Europe\n (Ireland) Region. For more information, see Accessing a\n bucket.
If you send your create bucket request to the s3.amazonaws.com
endpoint,\n the request goes to the us-east-1
Region. Accordingly, the signature\n calculations in Signature Version 4 must use us-east-1
as the Region, even\n if the location constraint in the request specifies another Region where the bucket is\n to be created. If you create a bucket in a Region other than US East (N. Virginia), your\n application must be able to handle 307 redirect. For more information, see Virtual hosting of\n buckets.
In addition to s3:CreateBucket
, the following permissions are\n required when your CreateBucket
request includes specific\n headers:
\n Access control lists (ACLs) - If your\n CreateBucket
request specifies access control list (ACL)\n permissions and the ACL is public-read, public-read-write,\n authenticated-read, or if you specify access permissions explicitly through\n any other ACL, both s3:CreateBucket
and\n s3:PutBucketAcl
permissions are needed. If the ACL for the\n CreateBucket
request is private or if the request doesn't\n specify any ACLs, only s3:CreateBucket
permission is needed.\n
\n Object Lock - If\n ObjectLockEnabledForBucket
is set to true in your\n CreateBucket
request,\n s3:PutBucketObjectLockConfiguration
and\n s3:PutBucketVersioning
permissions are required.
\n S3 Object Ownership - If your\n CreateBucket
request includes the\n x-amz-object-ownership
header, then the\n s3:PutBucketOwnershipControls
permission is required. By\n default, ObjectOwnership
is set to\n BucketOWnerEnforced
and ACLs are disabled. We recommend\n keeping ACLs disabled, except in uncommon use cases where you must control\n access for each object individually. If you want to change the\n ObjectOwnership
setting, you can use the\n x-amz-object-ownership
header in your\n CreateBucket
request to set the ObjectOwnership
\n setting of your choice. For more information about S3 Object Ownership, see\n Controlling\n object ownership in the\n Amazon S3 User Guide.
\n S3 Block Public Access - If your\n specific use case requires granting public access to your S3 resources, you\n can disable Block Public Access. You can create a new bucket with Block\n Public Access enabled, then separately call the \n DeletePublicAccessBlock
\n API. To use this operation, you must have the\n s3:PutBucketPublicAccessBlock
permission. By default, all\n Block Public Access settings are enabled for new buckets. To avoid\n inadvertent exposure of your resources, we recommend keeping the S3 Block\n Public Access settings enabled. For more information about S3 Block Public\n Access, see Blocking\n public access to your Amazon S3 storage in the\n Amazon S3 User Guide.
If your CreateBucket
request sets BucketOwnerEnforced
for\n Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external\n Amazon Web Services account, your request fails with a 400
error and returns the\n InvalidBucketAcLWithObjectOwnership
error code. For more information,\n see Setting Object\n Ownership on an existing bucket in the Amazon S3 User Guide.\n
The following operations are related to CreateBucket
:
\n PutObject\n
\n\n DeleteBucket\n
\nRemoves the entire tag set from the specified object. For more information about\n managing object tags, see Object Tagging.
\nTo use this operation, you must have permission to perform the\n s3:DeleteObjectTagging
action.
To delete tags of a specific object version, add the versionId
query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging
action.
The following operations are related to DeleteObjectTagging
:
\n PutObjectTagging\n
\n\n GetObjectTagging\n
\nThis action lists in-progress multipart uploads. An in-progress multipart upload is a\n multipart upload that has been initiated using the Initiate Multipart Upload request, but\n has not yet been completed or aborted.
\nThis action returns at most 1,000 multipart uploads in the response. 1,000 multipart\n uploads is the maximum number of uploads a response can include, which is also the default\n value. You can further limit the number of uploads in a response by specifying the\n max-uploads
parameter in the response. If additional multipart uploads\n satisfy the list criteria, the response will contain an IsTruncated
element\n with the value true. To list the additional multipart uploads, use the\n key-marker
and upload-id-marker
request parameters.
In the response, the uploads are sorted by key. If your application has initiated more\n than one multipart upload using the same object key, then uploads in the response are first\n sorted by key. Additionally, uploads are sorted in ascending order within each key by the\n upload initiation time.
\nFor more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information on permissions required to use the multipart upload API, see Multipart Upload\n and Permissions.
\nThe following operations are related to ListMultipartUploads
:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nAdds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.
\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject
to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock.
\nTo ensure that data is not corrupted traversing the network, use the\n Content-MD5
header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
To successfully complete the PutObject
request, you must have the\n s3:PutObject
in your IAM permissions.
To successfully change the objects acl of your PutObject
request,\n you must have the s3:PutObjectAcl
in your IAM permissions.
To successfully set the tag-set with your PutObject
request, you\n must have the s3:PutObjectTagging
in your IAM permissions.
The Content-MD5
header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information about Amazon S3 Object Lock, see Amazon S3 Object Lock\n Overview in the Amazon S3 User Guide.
You have four mutually exclusive options to protect data using server-side encryption in\n Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the\n encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or\n DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side\n encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to\n encrypt data at rest by using server-side encryption with other key options. For more\n information, see Using Server-Side\n Encryption.
\nWhen adding a new object, you can use headers to grant ACL-based permissions to\n individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are\n then added to the ACL on the object. By default, all objects are private. Only the owner\n has full access control. For more information, see Access Control List (ACL) Overview\n and Managing\n ACLs Using the REST API.
\nIf the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control
\n canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that\n contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400
error with the error code AccessControlListNotSupported
.\n For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
If your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\nFor more information about related Amazon S3 APIs, see the following:
\n\n CopyObject\n
\n\n DeleteObject\n
\nThe value associated with a feature, in string format. Note that features types can be\n String, Integral, or Fractional. This value represents all three types as a string.
", - "smithy.api#required": {} + "smithy.api#documentation": "The value in string format associated with a feature. Used when your\n CollectionType
is None
. Note that features types can be\n String
, Integral
, or Fractional
. This value\n represents all three types as a string.
The list of values in string format associated with a feature. Used when your\n CollectionType
is a List
, Set
, or\n Vector
. Note that features types can be String
,\n Integral
, or Fractional
. These values represents all three\n types as a string.
The list of all content type headers that SageMaker will treat as CSV and capture\n accordingly.
" + "smithy.api#documentation": "The list of all content type headers that Amazon SageMaker will treat as CSV and\n capture accordingly.
" } }, "JsonContentTypes": { "target": "com.amazonaws.sagemaker#JsonContentTypes", "traits": { - "smithy.api#documentation": "The list of all content type headers that SageMaker will treat as JSON and capture\n accordingly.
" + "smithy.api#documentation": "The list of all content type headers that SageMaker will treat as JSON and\n capture accordingly.
" } } }, "traits": { - "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified\n SageMaker will by default base64 encode when capturing the data.
" + "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified\n Amazon SageMaker will by default base64 encode when capturing the data.
" } }, "com.amazonaws.sagemaker#CaptureMode": { @@ -5759,6 +5759,20 @@ "smithy.api#pattern": "^[\\w-]+_[0-9a-zA-Z]+$" } }, + "com.amazonaws.sagemaker#CollectionConfig": { + "type": "union", + "members": { + "VectorConfig": { + "target": "com.amazonaws.sagemaker#VectorConfig", + "traits": { + "smithy.api#documentation": "Configuration for your vector collection type.
\n\n Dimension
: The number of elements in your vector.
Configuration for your collection.
" + } + }, "com.amazonaws.sagemaker#CollectionConfiguration": { "type": "structure", "members": { @@ -5816,6 +5830,29 @@ } } }, + "com.amazonaws.sagemaker#CollectionType": { + "type": "enum", + "members": { + "LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "List" + } + }, + "SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Set" + } + }, + "VECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Vector" + } + } + } + }, "com.amazonaws.sagemaker#CompilationJobArn": { "type": "string", "traits": { @@ -6872,7 +6909,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
\nWe recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.
\n\n CreateAutoMLJobV2
can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob
, as well as non-tabular problem types\n such as image or text classification.
Find guidelines about how to migrate a CreateAutoMLJob
to\n CreateAutoMLJobV2
in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.
" + "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
\nWe recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.
\n\n CreateAutoMLJobV2
can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob
, as well as time-series forecasting,\n and non-tabular problem types such as image or text classification.
Find guidelines about how to migrate a CreateAutoMLJob
to\n CreateAutoMLJobV2
in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.
" } }, "com.amazonaws.sagemaker#CreateAutoMLJobRequest": { @@ -6980,7 +7017,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
\n\n CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob\n and DescribeAutoMLJob which offer backward compatibility.
\n\n CreateAutoMLJobV2
can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob
, as well as non-tabular problem types\n such as image or text classification.
Find guidelines about how to migrate a CreateAutoMLJob
to\n CreateAutoMLJobV2
in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
For the list of available problem types supported by CreateAutoMLJobV2
, see\n AutoMLProblemTypeConfig.
You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.
" + "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
\n\n CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob\n and DescribeAutoMLJob which offer backward compatibility.
\n\n CreateAutoMLJobV2
can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob
, as well as time-series forecasting,\n and non-tabular problem types such as image or text classification.
Find guidelines about how to migrate a CreateAutoMLJob
to\n CreateAutoMLJobV2
in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
For the list of available problem types supported by CreateAutoMLJobV2
, see\n AutoMLProblemTypeConfig.
You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.
" } }, "com.amazonaws.sagemaker#CreateAutoMLJobV2Request": { @@ -7316,7 +7353,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a definition for a job that monitors data quality and drift. For information\n about model monitor, see Amazon SageMaker Model Monitor.
" + "smithy.api#documentation": "Creates a definition for a job that monitors data quality and drift. For information\n about model monitor, see Amazon SageMaker Model\n Monitor.
" } }, "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionRequest": { @@ -7370,7 +7407,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to\n perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can \n assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -7380,7 +7417,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost\n Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -8974,7 +9011,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -9019,7 +9056,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to\n perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can \n assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -9029,7 +9066,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost\n Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -9241,7 +9278,7 @@ "ModelExplainabilityAppSpecification": { "target": "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification", "traits": { - "smithy.api#documentation": "Configures the model explainability job to run a specified Docker container\n image.
", + "smithy.api#documentation": "Configures the model explainability job to run a specified Docker container image.
", "smithy.api#required": {} } }, @@ -9273,7 +9310,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to\n perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can \n assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -9283,7 +9320,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost\n Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -9548,25 +9585,25 @@ "Domain": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning domain of your model package and its components. Common \n machine learning domains include computer vision and natural language processing.
" + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.
" } }, "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine \n learning tasks include object detection and image classification. The following \n tasks are supported by Inference Recommender: \n \"IMAGE_CLASSIFICATION\"
| \"OBJECT_DETECTION\"
| \"TEXT_GENERATION\"
|\"IMAGE_SEGMENTATION\"
| \n \"FILL_MASK\"
| \"CLASSIFICATION\"
| \"REGRESSION\"
| \"OTHER\"
.
Specify \"OTHER\" if none of the tasks listed fit your use case.
" + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification. The following\n tasks are supported by Inference Recommender:\n \"IMAGE_CLASSIFICATION\"
| \"OBJECT_DETECTION\"
| \"TEXT_GENERATION\"
|\"IMAGE_SEGMENTATION\"
|\n \"FILL_MASK\"
| \"CLASSIFICATION\"
| \"REGRESSION\"
| \"OTHER\"
.
Specify \"OTHER\" if none of the tasks listed fit your use case.
" } }, "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point \n to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files\n that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the\n InvokeEndpoint call.
" + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point\n to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files\n that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the\n InvokeEndpoint call.
" } }, "AdditionalInferenceSpecifications": { "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional \n Inference Specification specifies artifacts based on this model package that can \n be used on inference endpoints. Generally used with SageMaker Neo to store the \n compiled artifacts.
" + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the\n compiled artifacts.
" } }, "SkipModelValidation": { @@ -9613,7 +9650,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a definition for a job that monitors model quality and drift. For information\n about model monitor, see Amazon SageMaker Model Monitor.
" + "smithy.api#documentation": "Creates a definition for a job that monitors model quality and drift. For information\n about model monitor, see Amazon SageMaker Model\n Monitor.
" } }, "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionRequest": { @@ -9667,7 +9704,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to\n perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can \n assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -9677,7 +9714,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost\n Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -9717,7 +9754,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data\n captured for an Amazon SageMaker Endpoint.
" + "smithy.api#documentation": "Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to\n monitor the data captured for an Amazon SageMaker Endpoint.
" } }, "com.amazonaws.sagemaker#CreateMonitoringScheduleRequest": { @@ -9726,14 +9763,14 @@ "MonitoringScheduleName": { "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { - "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
", + "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.
", "smithy.api#required": {} } }, "MonitoringScheduleConfig": { "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", "traits": { - "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the\n monitoring job.
", + "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", "smithy.api#required": {} } }, @@ -11364,7 +11401,7 @@ "InitialSamplingPercentage": { "target": "com.amazonaws.sagemaker#SamplingPercentage", "traits": { - "smithy.api#documentation": "The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints\n with high traffic.
", + "smithy.api#documentation": "The percentage of requests SageMaker will capture. A lower value is recommended\n for Endpoints with high traffic.
", "smithy.api#required": {} } }, @@ -11378,7 +11415,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
\n
The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker\n uses to encrypt the captured data at rest using Amazon S3 server-side\n encryption.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
\n
Configuration specifying how to treat different headers. If no headers are specified\n SageMaker will by default base64 encode when capturing the data.
" + "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified\n SageMaker will by default base64 encode when capturing the data.
" } } }, @@ -11558,13 +11595,13 @@ "RecordPreprocessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can\n base64 decode the payload and convert it into a flatted json so that the built-in container\n can use the converted data. Applicable only for the built-in (first party)\n containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" } }, "PostAnalyticsProcessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed.\n Applicable only for the built-in (first party) containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" } }, "Environment": { @@ -11595,7 +11632,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline\n resources are compared against the results of the current job from the series of jobs\n scheduled to collect data periodically.
" + "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" } }, "com.amazonaws.sagemaker#DataQualityJobInput": { @@ -15151,7 +15188,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to\n perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can \n assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -18002,7 +18039,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -18054,7 +18091,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management\n (IAM) role that has read permission to the input data location and write permission to the\n output data location in Amazon S3.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.
", "smithy.api#required": {} } }, @@ -18357,7 +18394,7 @@ "ModelExplainabilityAppSpecification": { "target": "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification", "traits": { - "smithy.api#documentation": "Configures the model explainability job to run a specified Docker container\n image.
", + "smithy.api#documentation": "Configures the model explainability job to run a specified Docker container image.
", "smithy.api#required": {} } }, @@ -18389,7 +18426,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management\n (IAM) role that has read permission to the input data location and write permission to the\n output data location in Amazon S3.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.
", "smithy.api#required": {} } }, @@ -18720,25 +18757,25 @@ "Domain": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning domain of the model package you specified. Common machine \n learning domains include computer vision and natural language processing.
" + "smithy.api#documentation": "The machine learning domain of the model package you specified. Common machine\n learning domains include computer vision and natural language processing.
" } }, "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task you specified that your model package accomplishes. \n Common machine learning tasks include object detection and image classification.
" + "smithy.api#documentation": "The machine learning task you specified that your model package accomplishes.\n Common machine learning tasks include object detection and image classification.
" } }, "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single \n gzip compressed tar archive (.tar.gz suffix).
" + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single\n gzip compressed tar archive (.tar.gz suffix).
" } }, "AdditionalInferenceSpecifications": { "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional \n Inference Specification specifies artifacts based on this model package that can \n be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
" + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
" } }, "SkipModelValidation": { @@ -18849,7 +18886,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to\n perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can \n assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -18946,7 +18983,7 @@ "MonitoringScheduleConfig": { "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", "traits": { - "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the\n monitoring job.
", + "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", "smithy.api#required": {} } }, @@ -21596,6 +21633,15 @@ "target": "com.amazonaws.sagemaker#Device" } }, + "com.amazonaws.sagemaker#Dimension": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 8192 + } + } + }, "com.amazonaws.sagemaker#DirectInternetAccess": { "type": "enum", "members": { @@ -23003,7 +23049,7 @@ "S3DataDistributionType": { "target": "com.amazonaws.sagemaker#ProcessingS3DataDistributionType", "traits": { - "smithy.api#documentation": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.\n Defaults to FullyReplicated
\n
Whether input data distributed in Amazon S3 is fully replicated or sharded by an\n Amazon S3 key. Defaults to FullyReplicated
\n
The value type of a feature. Valid values are Integral, Fractional, or String.
" } + }, + "CollectionType": { + "target": "com.amazonaws.sagemaker#CollectionType", + "traits": { + "smithy.api#documentation": "A grouping of elements where each element within the collection must have the same\n feature type (String
, Integral
, or\n Fractional
).
\n List
: An ordered collection of elements.
\n Set
: An unordered collection of unique elements.
\n Vector
: A specialized list that represents a fixed-size array of\n elements. The vector dimension is determined by you. Must have elements with\n fractional feature types.
Configuration for your collection.
" + } } }, "traits": { @@ -25507,7 +25565,7 @@ "CountryCode": { "target": "com.amazonaws.sagemaker#CountryCode", "traits": { - "smithy.api#documentation": "The country code for the holiday calendar.
\nFor the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your\n choice.
" + "smithy.api#documentation": "The country code for the holiday calendar.
\nFor the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your\n choice.
" } } }, @@ -31497,7 +31555,7 @@ "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "The sort order for results. The default is Descending
.
Whether to sort the results in Ascending
or Descending
order. \n The default is Descending
.
Whether to sort results by the Name
or CreationTime
field. The\n default is CreationTime
.
Whether to sort results by the Name
or CreationTime
field. \n The default is CreationTime
.
Whether to sort the results in Ascending
or Descending
order.\n The default is Descending
.
Whether to sort the results in Ascending
or Descending
order. \n The default is Descending
.
The token returned if the response is truncated. To retrieve the next set of job\n executions, use it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" } }, "MaxResults": { @@ -34000,7 +34058,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs,\n use it in the subsequent request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" } } }, @@ -34343,19 +34401,19 @@ "SortBy": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", "traits": { - "smithy.api#documentation": "Whether to sort results by the Name
or CreationTime
field. The\n default is CreationTime
.
Whether to sort results by the Name
or CreationTime
field. \n The default is CreationTime
.
Whether to sort the results in Ascending
or Descending
order.\n The default is Descending
.
Whether to sort the results in Ascending
or Descending
order. \n The default is Descending
.
The token returned if the response is truncated. To retrieve the next set of job\n executions, use it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" } }, "MaxResults": { @@ -34400,7 +34458,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs,\n use it in the subsequent request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" } } }, @@ -34705,7 +34763,7 @@ "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "The sort order for results. The default is Descending
.
Whether to sort the results in Ascending
or Descending
order. \n The default is Descending
.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model\n quality monitoring job definitions, use it in the next request.
" + "smithy.api#documentation": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the\n next set of model quality monitoring job definitions, use it in the next request.
" } } }, @@ -35064,19 +35122,19 @@ "SortBy": { "target": "com.amazonaws.sagemaker#MonitoringExecutionSortKey", "traits": { - "smithy.api#documentation": "Whether to sort results by Status
, CreationTime
,\n ScheduledTime
field. The default is CreationTime
.
Whether to sort the results by the Status
, CreationTime
, or \n ScheduledTime
field. The default is CreationTime
.
Whether to sort the results in Ascending
or Descending
order.\n The default is Descending
.
Whether to sort the results in Ascending
or Descending
order. \n The default is Descending
.
The token returned if the response is truncated. To retrieve the next set of job\n executions, use it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" } }, "MaxResults": { @@ -35157,7 +35215,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs,\n use it in the subsequent reques
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" } } }, @@ -35195,19 +35253,19 @@ "SortBy": { "target": "com.amazonaws.sagemaker#MonitoringScheduleSortKey", "traits": { - "smithy.api#documentation": "Whether to sort results by Status
, CreationTime
,\n ScheduledTime
field. The default is CreationTime
.
Whether to sort the results by the Status
, CreationTime
, or \n ScheduledTime
field. The default is CreationTime
.
Whether to sort the results in Ascending
or Descending
order.\n The default is Descending
.
Whether to sort the results in Ascending
or Descending
order. \n The default is Descending
.
The token returned if the response is truncated. To retrieve the next set of job\n executions, use it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" } }, "MaxResults": { @@ -35282,7 +35340,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs,\n use it in the subsequent request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" } } }, @@ -38938,7 +38996,7 @@ "ConfigUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "JSON formatted S3 file that defines explainability parameters. For more information on\n this JSON configuration file, see Configure model explainability parameters.
", + "smithy.api#documentation": "JSON formatted Amazon S3 file that defines explainability parameters. For more\n information on this JSON configuration file, see Configure model explainability parameters.
", "smithy.api#required": {} } }, @@ -39375,19 +39433,19 @@ "Domain": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning domain of your model package and its components. Common \n machine learning domains include computer vision and natural language processing.
" + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.
" } }, "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine \n learning tasks include object detection and image classification.
" + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification.
" } }, "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to \n a single gzip compressed tar archive (.tar.gz suffix).
" + "smithy.api#documentation": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to\n a single gzip compressed tar archive (.tar.gz suffix).
" } }, "AdditionalInferenceSpecifications": { @@ -40015,13 +40073,13 @@ "RecordPreprocessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can\n base64 decode the payload and convert it into a flatted json so that the built-in container\n can use the converted data. Applicable only for the built-in (first party)\n containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" } }, "PostAnalyticsProcessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed.\n Applicable only for the built-in (first party) containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" } }, "ProblemType": { @@ -40055,7 +40113,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline\n resources are compared against the results of the current job from the series of jobs\n scheduled to collect data periodically.
" + "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" } }, "com.amazonaws.sagemaker#ModelQualityJobInput": { @@ -40079,7 +40137,7 @@ } }, "traits": { - "smithy.api#documentation": "The input for the model quality monitoring job. Currently endponts are supported for\n input for model quality monitoring jobs.
" + "smithy.api#documentation": "The input for the model quality monitoring job. Currently endpoints are supported for\n input for model quality monitoring jobs.
" } }, "com.amazonaws.sagemaker#ModelRegisterSettings": { @@ -40536,13 +40594,13 @@ "RecordPreprocessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can\n base64 decode the payload and convert it into a flatted json so that the built-in container\n can use the converted data. Applicable only for the built-in (first party)\n containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" } }, "PostAnalyticsProcessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed.\n Applicable only for the built-in (first party) containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" } } }, @@ -40568,12 +40626,12 @@ "StatisticsResource": { "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource", "traits": { - "smithy.api#documentation": "The baseline statistics file in Amazon S3 that the current monitoring job should be\n validated against.
" + "smithy.api#documentation": "The baseline statistics file in Amazon S3 that the current monitoring job should\n be validated against.
" } } }, "traits": { - "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline\n resources are compared against the results of the current job from the series of jobs\n scheduled to collect data periodically.
" + "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" } }, "com.amazonaws.sagemaker#MonitoringClusterConfig": { @@ -40603,7 +40661,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon\n SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s)\n that run the model monitoring job.
" + "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker uses to\n encrypt data on the storage volume attached to the ML compute instance(s) that run the\n model monitoring job.
" } } }, @@ -40871,14 +40929,14 @@ "MonitoringInputs": { "target": "com.amazonaws.sagemaker#MonitoringInputs", "traits": { - "smithy.api#documentation": "The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker\n Endpoint.
", + "smithy.api#documentation": "The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
", "smithy.api#required": {} } }, "MonitoringOutputConfig": { "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", "traits": { - "smithy.api#documentation": "The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage\n Service (Amazon S3).
", + "smithy.api#documentation": "The array of outputs from the monitoring job to be uploaded to Amazon S3.
", "smithy.api#required": {} } }, @@ -40917,7 +40975,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can \n assume to perform tasks on your behalf.
", "smithy.api#required": {} } } @@ -41012,7 +41070,7 @@ "target": "com.amazonaws.sagemaker#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates if the file should be read as a json object per line.
" + "smithy.api#documentation": "Indicates if the file should be read as a JSON object per line.
" } } }, @@ -41061,7 +41119,7 @@ "S3Output": { "target": "com.amazonaws.sagemaker#MonitoringS3Output", "traits": { - "smithy.api#documentation": "The Amazon S3 storage location where the results of a monitoring job are saved.
", + "smithy.api#documentation": "The Amazon S3 storage location where the results of a monitoring job are\n saved.
", "smithy.api#required": {} } } @@ -41083,7 +41141,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
" + "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker uses to\n encrypt the model artifacts at rest using Amazon S3 server-side encryption.
" } } }, @@ -41154,14 +41212,14 @@ "S3Uri": { "target": "com.amazonaws.sagemaker#MonitoringS3Uri", "traits": { - "smithy.api#documentation": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a\n monitoring job.
", + "smithy.api#documentation": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker\n saves the results of a monitoring job.
", "smithy.api#required": {} } }, "LocalPath": { "target": "com.amazonaws.sagemaker#ProcessingLocalPath", "traits": { - "smithy.api#documentation": "The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a\n monitoring job. LocalPath is an absolute path for the output data.
", + "smithy.api#documentation": "The local path to the Amazon S3 storage location where Amazon SageMaker\n saves the results of a monitoring job. LocalPath is an absolute path for the output\n data.
", "smithy.api#required": {} } }, @@ -42392,6 +42450,12 @@ "traits": { "smithy.api#documentation": "Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt
= EventTime
+ TtlDuration
. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Option for different tiers of low latency storage for real-time data retrieval.
\n\n Standard
: A managed low latency data store for feature groups.
\n InMemory
: A managed data store for feature groups that supports very\n low latency retrieval.
A cron expression that describes details about the monitoring schedule.
\nThe supported cron expressions are:
\nIf you want to set the job to start every hour, use the following:
\n\n Hourly: cron(0 * ? * * *)
\n
If you want to start the job daily:
\n\n cron(0 [00-23] ? * * *)
\n
For example, the following are valid cron expressions:
\nDaily at noon UTC: cron(0 12 ? * * *)
\n
Daily at midnight UTC: cron(0 0 ? * * *)
\n
To support running every 6, 12 hours, the following are also supported:
\n\n cron(0 [00-23]/[01-24] ? * * *)
\n
For example, the following are valid cron expressions:
\nEvery 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
\n
Every two hours starting at midnight: cron(0 0/2 ? * * *)
\n
Even though the cron expression is set to start at 5PM UTC, note that there\n could be a delay of 0-20 minutes from the actual requested time to run the\n execution.
\nWe recommend that if you would like a daily schedule, you do not provide this\n parameter. Amazon SageMaker will pick a time for running every day.
\nYou can also specify the keyword NOW
to run the monitoring job immediately, one time,\n without recurring.
A cron expression that describes details about the monitoring schedule.
\nThe supported cron expressions are:
\nIf you want to set the job to start every hour, use the following:
\n\n Hourly: cron(0 * ? * * *)
\n
If you want to start the job daily:
\n\n cron(0 [00-23] ? * * *)
\n
If you want to run the job one time, immediately, use the following\n keyword:
\n\n NOW
\n
For example, the following are valid cron expressions:
\nDaily at noon UTC: cron(0 12 ? * * *)
\n
Daily at midnight UTC: cron(0 0 ? * * *)
\n
To support running every 6, 12 hours, the following are also supported:
\n\n cron(0 [00-23]/[01-24] ? * * *)
\n
For example, the following are valid cron expressions:
\nEvery 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
\n
Every two hours starting at midnight: cron(0 0/2 ? * * *)
\n
Even though the cron expression is set to start at 5PM UTC, note that there\n could be a delay of 0-20 minutes from the actual requested time to run the\n execution.
\nWe recommend that if you would like a daily schedule, you do not provide this\n parameter. Amazon SageMaker will pick a time for running every day.
\nYou can also specify the keyword NOW
to run the monitoring job immediately,\n one time, without recurring.
Specifies a limit to how long a model training job or model compilation job can run.\n It also specifies how long a managed spot training job has to complete. When the job\n reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap\n model training costs.
\nTo stop a training job, SageMaker sends the algorithm the SIGTERM
signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel
.
The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.
\nThe collection of holidays featurization attributes used to incorporate national holiday\n information into your forecasting model.
" + "smithy.api#documentation": "The collection of holiday featurization attributes used to incorporate national holiday\n information into your forecasting model.
" } } }, @@ -58122,7 +58203,7 @@ "FeatureGroupName": { "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the feature group containing the feature that \n you're updating.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the feature group containing the feature that\n you're updating.
", "smithy.api#required": {} } }, @@ -58730,14 +58811,14 @@ "MonitoringScheduleName": { "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { - "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
", + "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.
", "smithy.api#required": {} } }, "MonitoringScheduleConfig": { "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", "traits": { - "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the\n monitoring job.
", + "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", "smithy.api#required": {} } } @@ -60007,6 +60088,21 @@ } } }, + "com.amazonaws.sagemaker#VectorConfig": { + "type": "structure", + "members": { + "Dimension": { + "target": "com.amazonaws.sagemaker#Dimension", + "traits": { + "smithy.api#documentation": "The number of elements in your vector.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for your vector collection type.
" + } + }, "com.amazonaws.sagemaker#VendorGuidance": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/sso.2019-06-10.json b/codegen/sdk-codegen/aws-models/sso.2019-06-10.json index 9804c216731..5d32bc16399 100644 --- a/codegen/sdk-codegen/aws-models/sso.2019-06-10.json +++ b/codegen/sdk-codegen/aws-models/sso.2019-06-10.json @@ -760,6 +760,31 @@ ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://portal.sso.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -1233,7 +1258,7 @@ "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://portal.sso-fips.us-gov-east-1.amazonaws.com" + "url": "https://portal.sso.us-gov-east-1.amazonaws.com" } }, "params": { diff --git a/codegen/sdk-codegen/aws-models/sts.2011-06-15.json b/codegen/sdk-codegen/aws-models/sts.2011-06-15.json index d49956a1f71..ad261493c74 100644 --- a/codegen/sdk-codegen/aws-models/sts.2011-06-15.json +++ b/codegen/sdk-codegen/aws-models/sts.2011-06-15.json @@ -1665,9 +1665,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1684,10 +1684,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1", - "UseGlobalEndpoint": true + "Region": "ap-northeast-1" } }, { @@ -1697,9 +1697,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1716,10 +1716,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1", - "UseGlobalEndpoint": true + "Region": "ap-south-1" } }, { @@ -1729,9 +1729,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1748,10 +1748,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1", - "UseGlobalEndpoint": true + "Region": "ap-southeast-1" } }, { @@ -1761,9 +1761,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1780,10 +1780,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2", - "UseGlobalEndpoint": true + "Region": "ap-southeast-2" } }, { @@ -1793,9 +1793,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1812,10 +1812,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "aws-global", - "UseGlobalEndpoint": true + "Region": "aws-global" } }, { @@ -1825,9 +1825,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1844,10 +1844,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1", - "UseGlobalEndpoint": true + "Region": "ca-central-1" } }, { @@ -1857,9 +1857,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1876,10 +1876,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1", - "UseGlobalEndpoint": true + "Region": "eu-central-1" } }, { @@ -1889,9 +1889,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1908,10 +1908,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1", - "UseGlobalEndpoint": true + "Region": "eu-north-1" } }, { @@ -1921,9 +1921,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1940,10 +1940,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1", - "UseGlobalEndpoint": true + "Region": "eu-west-1" } }, { @@ -1953,9 +1953,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1972,10 +1972,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2", - "UseGlobalEndpoint": true + "Region": "eu-west-2" } }, { @@ -1985,9 +1985,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2004,10 +2004,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3", - "UseGlobalEndpoint": true + "Region": "eu-west-3" } }, { @@ -2017,9 +2017,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2036,10 +2036,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "sa-east-1", - "UseGlobalEndpoint": true + "Region": "sa-east-1" } }, { @@ -2049,9 +2049,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2068,10 +2068,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", - "UseGlobalEndpoint": true + "Region": "us-east-1" } }, { @@ -2081,9 +2081,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2100,10 +2100,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2", - "UseGlobalEndpoint": true + "Region": "us-east-2" } }, { @@ -2113,9 +2113,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2132,10 +2132,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-1", - "UseGlobalEndpoint": true + "Region": "us-west-1" } }, { @@ -2145,9 +2145,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2164,10 +2164,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2", - "UseGlobalEndpoint": true + "Region": "us-west-2" } }, { @@ -2177,9 +2177,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-3", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2196,10 +2196,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-3", - "UseGlobalEndpoint": true + "Region": "us-east-3" } }, { @@ -2220,10 +2220,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, "Region": "us-west-1", - "UseGlobalEndpoint": true, "Endpoint": "https://example.com" } }, @@ -2235,10 +2235,10 @@ } }, "params": { + "UseGlobalEndpoint": false, "UseDualStack": false, "UseFIPS": false, - "Endpoint": "https://example.com", - "UseGlobalEndpoint": false + "Endpoint": "https://example.com" } } ], @@ -2339,7 +2339,7 @@ } }, "Policy": { - "target": "com.amazonaws.sts#sessionPolicyDocumentType", + "target": "com.amazonaws.sts#unrestrictedSessionPolicyDocumentType", "traits": { "smithy.api#documentation": "An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize
response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
A list of the types of analysis to perform. Add TABLES to the list to return information\n about the tables that are detected in the input document. Add FORMS to return detected form\n data. Add SIGNATURES to return the locations of detected signatures. To perform both forms \n and table analysis, add TABLES and FORMS to FeatureTypes
. To detect signatures within\n form data and table data, add SIGNATURES to either TABLES or FORMS.\n All lines and words detected in the document are included in the response (including text\n that isn't related to the value of FeatureTypes
).
A list of the types of analysis to perform. Add TABLES to the list to return information\n about the tables that are detected in the input document. Add FORMS to return detected form\n data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list\n to return information about the layout of the document. To perform both forms\n and table analysis, add TABLES and FORMS to FeatureTypes
. To detect signatures\n within the document and within form data and table data, add SIGNATURES to either TABLES or\n FORMS. All lines and words detected in the document are included in the response (including\n text that isn't related to the value of FeatureTypes
).
The type of text item that's recognized. In operations for text detection, the following\n types are returned:
\n\n PAGE - Contains a list of the LINE Block
objects\n that are detected on a document page.
\n WORD - A word detected on a document page. A word is one or\n more ISO basic Latin script characters that aren't separated by spaces.
\n\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\nIn text analysis operations, the following types are returned:
\n\n PAGE - Contains a list of child Block
objects\n that are detected on a document page.
\n KEY_VALUE_SET - Stores the KEY and VALUE Block
\n objects for linked text that's detected on a document page. Use the\n EntityType
field to determine if a KEY_VALUE_SET object is a KEY\n Block
object or a VALUE Block
object.
\n WORD - A word that's detected on a document page. A word is\n one or more ISO basic Latin script characters that aren't separated by spaces.
\n\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\n\n TABLE - A table that's detected on a document page. A table\n is grid-based information with two or more rows or columns, with a cell span of one\n row and one column each.
\n\n TABLE_TITLE - The title of a table. A title is typically a\n line of text above or below a table, or embedded as the first row of a table.
\n\n TABLE_FOOTER - The footer associated with a table. A footer\n is typically a line or lines of text below a table or embedded as the last row of a\n table.
\n\n CELL - A cell within a detected table. The cell is the parent\n of the block that contains the text in the cell.
\n\n MERGED_CELL - A cell in a table whose content spans more than\n one row or column. The Relationships
array for this cell contain data\n from individual cells.
\n SELECTION_ELEMENT - A selection element such as an option\n button (radio button) or a check box that's detected on a document page. Use the\n value of SelectionStatus
to determine the status of the selection\n element.
\n SIGNATURE - The location and confidene score of a signature detected on a\n document page. Can be returned as part of a Key-Value pair or a detected cell.
\n\n QUERY - A question asked during the call of AnalyzeDocument. Contains an\n alias and an ID that attaches it to its answer.
\n\n QUERY_RESULT - A response to a question asked during the call\n of analyze document. Comes with an alias and ID for ease of locating in a \n response. Also contains location and confidence score.
\nThe type of text item that's recognized. In operations for text detection, the following\n types are returned:
\n\n PAGE - Contains a list of the LINE Block
objects\n that are detected on a document page.
\n WORD - A word detected on a document page. A word is one or\n more ISO basic Latin script characters that aren't separated by spaces.
\n\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\nIn text analysis operations, the following types are returned:
\n\n PAGE - Contains a list of child Block
objects\n that are detected on a document page.
\n KEY_VALUE_SET - Stores the KEY and VALUE Block
\n objects for linked text that's detected on a document page. Use the\n EntityType
field to determine if a KEY_VALUE_SET object is a KEY\n Block
object or a VALUE Block
object.
\n WORD - A word that's detected on a document page. A word is\n one or more ISO basic Latin script characters that aren't separated by spaces.
\n\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\n\n TABLE - A table that's detected on a document page. A table\n is grid-based information with two or more rows or columns, with a cell span of one\n row and one column each.
\n\n TABLE_TITLE - The title of a table. A title is typically a\n line of text above or below a table, or embedded as the first row of a table.
\n\n TABLE_FOOTER - The footer associated with a table. A footer\n is typically a line or lines of text below a table or embedded as the last row of a\n table.
\n\n CELL - A cell within a detected table. The cell is the parent\n of the block that contains the text in the cell.
\n\n MERGED_CELL - A cell in a table whose content spans more than\n one row or column. The Relationships
array for this cell contain data\n from individual cells.
\n SELECTION_ELEMENT - A selection element such as an option\n button (radio button) or a check box that's detected on a document page. Use the\n value of SelectionStatus
to determine the status of the selection\n element.
\n SIGNATURE - The location and confidence score of a signature detected on a\n document page. Can be returned as part of a Key-Value pair or a detected cell.
\n\n QUERY - A question asked during the call of AnalyzeDocument. Contains an\n alias and an ID that attaches it to its answer.
\n\n QUERY_RESULT - A response to a question asked during the call\n of analyze document. Comes with an alias and ID for ease of locating in a \n response. Also contains location and confidence score.
\nThe page on which a block was detected. Page
is returned by synchronous and\n asynchronous operations. Page values greater than 1 are only returned for multipage\n documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an\n asynchronous operation, even if it contains multiple document pages, is considered a\n single-page document. This means that for scanned images the value of Page
is\n always 1. Synchronous operations will also return a Page
value of 1\n because every input document is considered to be a single-page document.
The page on which a block was detected. Page
is returned by synchronous and\n asynchronous operations. Page values greater than 1 are only returned for multipage\n documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an\n asynchronous operation, even if it contains multiple document pages, is considered a\n single-page document. This means that for scanned images the value of Page
is\n always 1.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to LOGICAL
.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType
is LOGICAL
, you must provide mappings,\n using the HomeDirectoryMappings
parameter. If, on the other hand,\n HomeDirectoryType
is PATH
, you provide an absolute path\n using the HomeDirectory
parameter. You cannot have both\n HomeDirectory
and HomeDirectoryMappings
in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to LOGICAL
.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType
is LOGICAL
, you must provide mappings,\n using the HomeDirectoryMappings
parameter. If, on the other hand,\n HomeDirectoryType
is PATH
, you provide an absolute path\n using the HomeDirectory
parameter. You cannot have both\n HomeDirectory
and HomeDirectoryMappings
in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to LOGICAL
.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType
is LOGICAL
, you must provide mappings,\n using the HomeDirectoryMappings
parameter. If, on the other hand,\n HomeDirectoryType
is PATH
, you provide an absolute path\n using the HomeDirectory
parameter. You cannot have both\n HomeDirectory
and HomeDirectoryMappings
in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to LOGICAL
.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType
is LOGICAL
, you must provide mappings,\n using the HomeDirectoryMappings
parameter. If, on the other hand,\n HomeDirectoryType
is PATH
, you provide an absolute path\n using the HomeDirectory
parameter. You cannot have both\n HomeDirectory
and HomeDirectoryMappings
in your\n template.
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
", + "smithy.api#documentation": "This exception is thrown when an error occurs in the Transfer Family service.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -4952,7 +4952,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "When you can get additional results from the ListUsers
call, a\n NextToken
parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken
parameter to continue listing additional\n users.
If there are additional results from the ListUsers
call, a\n NextToken
parameter is returned in the output. You can then pass \n the NextToken
to a subsequent ListUsers
command, to continue listing additional\n users.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to LOGICAL
.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType
is LOGICAL
, you must provide mappings,\n using the HomeDirectoryMappings
parameter. If, on the other hand,\n HomeDirectoryType
is PATH
, you provide an absolute path\n using the HomeDirectory
parameter. You cannot have both\n HomeDirectory
and HomeDirectoryMappings
in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to LOGICAL
.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType
is LOGICAL
, you must provide mappings,\n using the HomeDirectoryMappings
parameter. If, on the other hand,\n HomeDirectoryType
is PATH
, you provide an absolute path\n using the HomeDirectory
parameter. You cannot have both\n HomeDirectory
and HomeDirectoryMappings
in your\n template.
The requested resource does not exist.
", + "smithy.api#documentation": "The requested resource does not exist, or exists in a region other than the one specified for the command.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -6385,7 +6385,7 @@ "TrustedHostKeys": { "target": "com.amazonaws.transfer#SftpConnectorTrustedHostKeyList", "traits": { - "smithy.api#documentation": "The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting. You can use the ssh-keyscan
command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are
,\n , and an optional
, with spaces\n between each element.
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the key type is ssh-rsa
.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256
,\n ecdsa-sha2-nistp384
, or ecdsa-sha2-nistp521
, depending on the\n size of the key you generated.
The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting. You can use the ssh-keyscan
command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are
,\n , and an optional
, with spaces\n between each element. Specify only the
and : do not enter the
portion of the key.
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the key type is ssh-rsa
.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256
,\n ecdsa-sha2-nistp384
, or ecdsa-sha2-nistp521
, depending on the\n size of the key you generated.
Tests whether your SFTP connector is set up successfully. We highly recommend that you call this\n operation to test your ability to transfer files between a Transfer Family server and a trading partner's\n SFTP server.
" + "smithy.api#documentation": "Tests whether your SFTP connector is set up successfully. We highly recommend that you call this\n operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's\n SFTP server.
" } }, "com.amazonaws.transfer#TestConnectionRequest": { @@ -6983,7 +6983,7 @@ "StatusMessage": { "target": "com.amazonaws.transfer#Message", "traits": { - "smithy.api#documentation": "Returns Connection succeeded
if the test is successful. Or, returns a descriptive error message \n if the test fails. The following list provides the details for some error messages and troubleshooting steps for each.
\n Unable to access secrets manager: Verify that your secret name aligns with the one in\n Transfer Role permissions.
\n\n Unknown Host/Connection failed: Verify the server URL in the connector\n configuration , and\n verify that the login credentials work successfully outside of the connector.
\n\n Private key not found: Verify that the secret exists and is formatted correctly.
\n\n Invalid trusted host keys: Verify that the trusted host key in the connector\n configuration matches the ssh-keyscan
output.
Returns Connection succeeded
if the test is successful. Or, returns a descriptive error message \n if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.
Verify that your secret name aligns with the one in\n Transfer Role permissions.
\nVerify the server URL in the connector\n configuration , and verify that the login credentials work successfully outside of the connector.
\nVerify that the secret exists and is formatted correctly.
\nVerify that the trusted host key in the connector\n configuration matches the ssh-keyscan
output.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to LOGICAL
.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType
is LOGICAL
, you must provide mappings,\n using the HomeDirectoryMappings
parameter. If, on the other hand,\n HomeDirectoryType
is PATH
, you provide an absolute path\n using the HomeDirectory
parameter. You cannot have both\n HomeDirectory
and HomeDirectoryMappings
in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory
example is /bucket_name/home/mydirectory
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to LOGICAL
.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL
, you need to provide mappings in the HomeDirectoryMappings
for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType
is LOGICAL
, you must provide mappings,\n using the HomeDirectoryMappings
parameter. If, on the other hand,\n HomeDirectoryType
is PATH
, you provide an absolute path\n using the HomeDirectory
parameter. You cannot have both\n HomeDirectory
and HomeDirectoryMappings
in your\n template.
A string value that you want WAF to search for. WAF searches only in the part of\n web requests that you designate for inspection in FieldToMatch. The\n maximum length of the value is 200 bytes.
\nValid values depend on the component that you specify for inspection in\n FieldToMatch
:
\n Method
: The HTTP method that you want WAF to search for. This\n indicates the type of operation specified in the request.
\n UriPath
: The value that you want WAF to search for in the URI path,\n for example, /images/daily-ad.jpg
.
\n JA3Fingerprint
: The string to match against the web request's JA3 fingerprint header. The header contains a hash fingerprint of the TLS Client Hello packet for \n the request.
\n HeaderOrder
: The comma-separated list of header names to match for. WAF creates a \n string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If SearchString
includes alphabetic characters A-Z and a-z, note that the\n value is case sensitive.
\n If you're using the WAF API\n
\nSpecify a base64-encoded version of the value. The maximum length of the value before\n you base64-encode it is 200 bytes.
\nFor example, suppose the value of Type
is HEADER
and the value\n of Data
is User-Agent
. If you want to search the\n User-Agent
header for the value BadBot
, you base64-encode\n BadBot
using MIME base64-encoding and include the resulting value,\n QmFkQm90
, in the value of SearchString
.
\n If you're using the CLI or one of the Amazon Web Services SDKs\n
\nThe value that you want WAF to search for. The SDK automatically base64 encodes the\n value.
", + "smithy.api#documentation": "A string value that you want WAF to search for. WAF searches only in the part of\n web requests that you designate for inspection in FieldToMatch. The\n maximum length of the value is 200 bytes.
\nValid values depend on the component that you specify for inspection in\n FieldToMatch
:
\n Method
: The HTTP method that you want WAF to search for. This\n indicates the type of operation specified in the request.
\n UriPath
: The value that you want WAF to search for in the URI path,\n for example, /images/daily-ad.jpg
.
\n JA3Fingerprint
: Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. You can use this choice only with a string match ByteMatchStatement
with the PositionalConstraint
set to \n EXACTLY
.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. \n\t\t\t\t\t\tIf WAF is able to calculate the fingerprint, it includes it in the logs. \n\t\t\t\t\t\tFor information about the logging fields, \nsee Log fields in the WAF Developer Guide.
\n\n HeaderOrder
: The comma-separated list of header names to match for. WAF creates a \n string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If SearchString
includes alphabetic characters A-Z and a-z, note that the\n value is case sensitive.
\n If you're using the WAF API\n
\nSpecify a base64-encoded version of the value. The maximum length of the value before\n you base64-encode it is 200 bytes.
\nFor example, suppose the value of Type
is HEADER
and the value\n of Data
is User-Agent
. If you want to search the\n User-Agent
header for the value BadBot
, you base64-encode\n BadBot
using MIME base64-encoding and include the resulting value,\n QmFkQm90
, in the value of SearchString
.
\n If you're using the CLI or one of the Amazon Web Services SDKs\n
\nThe value that you want WAF to search for. The SDK automatically base64 encodes the\n value.
", "smithy.api#required": {} } }, @@ -5460,7 +5460,7 @@ "JA3Fingerprint": { "target": "com.amazonaws.wafv2#JA3Fingerprint", "traits": { - "smithy.api#documentation": "Match against the request's JA3 fingerprint header. The header contains a hash fingerprint of the TLS Client Hello packet for the request.
\nYou can use this choice only with a string match ByteMatchStatement
with the PositionalConstraint
set to \n EXACTLY
.
Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each\n\t\t\t\t\t\trequest that has enough TLS Client Hello information for the calculation. Almost \n all web requests include this information.
\nYou can use this choice only with a string match ByteMatchStatement
with the PositionalConstraint
set to \n EXACTLY
.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. \n\t\t\t\t\t\tIf WAF is able to calculate the fingerprint, it includes it in the logs. \n\t\t\t\t\t\tFor information about the logging fields, \nsee Log fields in the WAF Developer Guide.
\nProvide the JA3 fingerprint string from the logs in your string match statement\n\t\t\t\t\t\t\tspecification, to match with any future requests that have the same TLS configuration.
" } } }, @@ -7010,7 +7010,7 @@ } }, "traits": { - "smithy.api#documentation": "Match against the request's JA3 fingerprint header. The header contains a hash fingerprint of the TLS Client Hello packet for the request.
\nYou can use this choice only with a string match ByteMatchStatement
with the PositionalConstraint
set to \n EXACTLY
.
Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each\n\t\t\t\t\t\trequest that has enough TLS Client Hello information for the calculation. Almost \n all web requests include this information.
\nYou can use this choice only with a string match ByteMatchStatement
with the PositionalConstraint
set to \n EXACTLY
.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. \n\t\t\t\t\t\tIf WAF is able to calculate the fingerprint, it includes it in the logs. \n\t\t\t\t\t\tFor information about the logging fields, \nsee Log fields in the WAF Developer Guide.
\nProvide the JA3 fingerprint string from the logs in your string match statement\n\t\t\t\t\t\t\tspecification, to match with any future requests that have the same TLS configuration.
" } }, "com.amazonaws.wafv2#JsonBody": {