The maximum number of records to list in a single response.
", @@ -5006,6 +5006,16 @@ } }, "com.amazonaws.amplify#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.amplify#MaxResultsForListApps": { "type": "integer", "traits": { "smithy.api#default": 0, 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 91517580eab..2f91d279eea 100644 --- a/codegen/sdk-codegen/aws-models/appintegrations.2020-07-29.json +++ b/codegen/sdk-codegen/aws-models/appintegrations.2020-07-29.json @@ -115,7 +115,7 @@ "sdkId": "AppIntegrations", "arnNamespace": "app-integrations", "cloudFormationName": "AppIntegrations", - "cloudTrailEventSource": "appintegrations.amazonaws.com", + "cloudTrailEventSource": "app-integrations.amazonaws.com", "endpointPrefix": "app-integrations" }, "aws.auth#sigv4": { diff --git a/codegen/sdk-codegen/aws-models/appsync.2017-07-25.json b/codegen/sdk-codegen/aws-models/appsync.2017-07-25.json index 925e9273fe0..2ad99c15cad 100644 --- a/codegen/sdk-codegen/aws-models/appsync.2017-07-25.json +++ b/codegen/sdk-codegen/aws-models/appsync.2017-07-25.json @@ -7332,7 +7332,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:[a-z-]*:secretsmanager:[a-z0-9-]*:\\d{12}:secret:[0-9A-Za-z_/-]*$" + "smithy.api#pattern": "^arn:[a-z-]*:secretsmanager:[a-z0-9-]*:\\d{12}:secret:[0-9A-Za-z_/+=.@!-]*$" } }, "com.amazonaws.appsync#RdsHttpEndpointConfig": { @@ -8936,7 +8936,8 @@ "authenticationType": { "target": "com.amazonaws.appsync#AuthenticationType", "traits": { - "smithy.api#documentation": "The new authentication type for the GraphqlApi object.
The new authentication type for the GraphqlApi object.
The file name of the document contained in the wrapper object.
", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrockagentruntime#ContentType", + "traits": { + "smithy.api#documentation": "The MIME type of the document contained in the wrapper object.
", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.bedrockagentruntime#ByteContentBlob", + "traits": { + "smithy.api#documentation": "The byte value of the file to upload, encoded as a Base-64 string.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This property contains the document to chat with, along with its attributes.
" + } + }, "com.amazonaws.bedrockagentruntime#Citation": { "type": "structure", "members": { @@ -1055,6 +1094,12 @@ "target": "com.amazonaws.bedrockagentruntime#Parameters" } }, + "com.amazonaws.bedrockagentruntime#ContentType": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-z]{1,20}/.{1,20}" + } + }, "com.amazonaws.bedrockagentruntime#CreationMode": { "type": "enum", "members": { @@ -1091,6 +1136,104 @@ "smithy.api#httpError": 424 } }, + "com.amazonaws.bedrockagentruntime#ExternalSource": { + "type": "structure", + "members": { + "sourceType": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSourceType", + "traits": { + "smithy.api#documentation": "The source type of the external source wrapper object.
", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagentruntime#S3ObjectDoc", + "traits": { + "smithy.api#documentation": "The S3 location of the external source wrapper object.
" + } + }, + "byteContent": { + "target": "com.amazonaws.bedrockagentruntime#ByteContentDoc", + "traits": { + "smithy.api#documentation": "The identifier, contentType, and data of the external source wrapper object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The unique external source of the content contained in the wrapper object.
" + } + }, + "com.amazonaws.bedrockagentruntime#ExternalSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "BYTE_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE_CONTENT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#ExternalSources": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#ExternalSourcesGenerationConfiguration": { + "type": "structure", + "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrockagentruntime#PromptTemplate", + "traits": { + "smithy.api#documentation": "Contain the textPromptTemplate string for the external source wrapper object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the generation configuration of the external source wrapper object.
" + } + }, + "com.amazonaws.bedrockagentruntime#ExternalSourcesRetrieveAndGenerateConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The modelArn used with the external source wrapper object in the retrieveAndGenerate function.
", + "smithy.api#required": {} + } + }, + "sources": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSources", + "traits": { + "smithy.api#documentation": "The document used with the external source wrapper object in the retrieveAndGenerate function.
", + "smithy.api#required": {} + } + }, + "generationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSourcesGenerationConfiguration", + "traits": { + "smithy.api#documentation": "The prompt used with the external source wrapper object with the retrieveAndGenerate function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configurations of the external source wrapper object in the retrieveAndGenerate function.
" + } + }, "com.amazonaws.bedrockagentruntime#FailureReasonString": { "type": "string", "traits": { @@ -1298,6 +1441,16 @@ "smithy.api#documentation": "Contains configurations for response generation based on the knowledge base query results.
\nThis data type is used in the following API operations:
\nContains details about the resource being queried.
" } + }, + "externalSourcesConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSourcesRetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "The configuration used with the external source wrapper object in the retrieveAndGenerate function.
" + } } }, "traits": { @@ -2840,6 +2999,12 @@ "traits": { "smithy.api#enumValue": "KNOWLEDGE_BASE" } + }, + "EXTERNAL_SOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL_SOURCES" + } } } }, @@ -2972,6 +3137,31 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#S3ObjectDoc": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagentruntime#S3Uri", + "traits": { + "smithy.api#documentation": "The file location of the S3 wrapper object.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The unique wrapper object of the document from the S3 location.
" + } + }, + "com.amazonaws.bedrockagentruntime#S3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" + } + }, "com.amazonaws.bedrockagentruntime#SearchType": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.2023-06-05.json b/codegen/sdk-codegen/aws-models/bedrock-agent.2023-06-05.json index 8acc8289a0c..b1733e1e6be 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.2023-06-05.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.2023-06-05.json @@ -51,7 +51,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains details about the Lambda function containing the business logic that is carried out upon invoking the action.
" + "smithy.api#documentation": "Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" } }, "com.amazonaws.bedrockagent#ActionGroupResource": { @@ -346,7 +346,7 @@ "actionGroupExecutor": { "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" } }, "apiSchema": { @@ -449,6 +449,12 @@ "smithy.api#documentation": "The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
\nCREATING – The agent alias is being created.
\nPREPARED – The agent alias is finished being created or updated and is ready to be invoked.
\nFAILED – The agent alias API operation failed.
\nUPDATING – The agent alias is being updated.
\nDELETING – The agent alias is being deleted.
\nInformation on the failure of Provisioned Throughput assigned to an agent alias.
" + } } }, "traits": { @@ -528,8 +534,13 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "The version of the agent with which the alias is associated.
", - "smithy.api#required": {} + "smithy.api#documentation": "The version of the agent with which the alias is associated.
" + } + }, + "provisionedThroughput": { + "target": "com.amazonaws.bedrockagent#ProvisionedModelIdentifier", + "traits": { + "smithy.api#documentation": "Information on the Provisioned Throughput assigned to an agent alias.
" } } }, @@ -1933,6 +1944,16 @@ "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}))$" } }, + "com.amazonaws.bedrockagent#BucketOwnerAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.bedrockagent#ChunkingConfiguration": { "type": "structure", "members": { @@ -2136,7 +2157,7 @@ "actionGroupExecutor": { "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" } }, "apiSchema": { @@ -2451,6 +2472,12 @@ "smithy.api#required": {} } }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy assigned to the data source.
" + } + }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", "traits": { @@ -2622,6 +2649,23 @@ } } }, + "com.amazonaws.bedrockagent#DataDeletionPolicy": { + "type": "enum", + "members": { + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, "com.amazonaws.bedrockagent#DataSource": { "type": "structure", "members": { @@ -2678,6 +2722,12 @@ "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" } }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for a data source.
" + } + }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { @@ -2691,6 +2741,12 @@ "smithy.api#documentation": "The time at which the data source was last updated.
", "smithy.api#required": {} } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "The detailed reasons on the failure to delete a data source.
" + } } }, "traits": { @@ -2752,6 +2808,12 @@ "traits": { "smithy.api#enumValue": "DELETING" } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } } } }, @@ -4847,6 +4909,12 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } } } }, @@ -4876,6 +4944,12 @@ "traits": { "smithy.api#enumValue": "RDS" } + }, + "MONGO_DB_ATLAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONGO_DB_ATLAS" + } } } }, @@ -5798,6 +5872,137 @@ "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.bedrockagent#MongoDbAtlasCollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName", + "traits": { + "smithy.api#documentation": "The database name in your MongoDB Atlas cluster for your knowledge base.
", + "smithy.api#required": {} + } + }, + "collectionName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName", + "traits": { + "smithy.api#documentation": "The collection name of the knowledge base in MongoDB Atlas.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasIndexName", + "traits": { + "smithy.api#documentation": "The name of the MongoDB Atlas vector search index.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + }, + "endpointServiceName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName", + "traits": { + "smithy.api#documentation": "The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, "com.amazonaws.bedrockagent#Name": { "type": "string", "traits": { @@ -6246,6 +6451,16 @@ } } }, + "com.amazonaws.bedrockagent#ProvisionedModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?){1,63})|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + } + }, "com.amazonaws.bedrockagent#RdsArn": { "type": "string", "traits": { @@ -6499,6 +6714,12 @@ "traits": { "smithy.api#documentation": "A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
" } + }, + "bucketOwnerAccountId": { + "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", + "traits": { + "smithy.api#documentation": "The bucket account owner ID for the S3 bucket.
" + } } }, "traits": { @@ -6756,6 +6977,12 @@ "traits": { "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" } + }, + "mongoDbAtlasConfiguration": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in MongoDB Atlas.
" + } } }, "traits": { @@ -7578,6 +7805,12 @@ "smithy.api#required": {} } }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy of the updated data source.
" + } + }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", "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 c3f00c8025e..e19538049ae 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 @@ -32,7 +32,7 @@ "name": "bedrock" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Describes the API operations for running inference using Bedrock models.
", + "smithy.api#documentation": "Describes the API operations for running inference using Amazon Bedrock models.
", "smithy.api#title": "Amazon Bedrock Runtime", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -709,6 +709,21 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockruntime#GuardrailIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, + "com.amazonaws.bedrockruntime#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + } + }, "com.amazonaws.bedrockruntime#InferenceResource": { "type": "resource", "operations": [ @@ -771,7 +786,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, see Run inference in the Bedrock User Guide.
\nFor example requests, see Examples (after the Errors section).
", + "smithy.api#documentation": "Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. \n You use model inference to generate text, images, and embeddings.
\nFor example code, see Invoke model code examples in the Amazon Bedrock User Guide.\n
\nThis operation requires permission for the bedrock:InvokeModel action.
Input data in the format specified in the content-type request header. To see the format and content of this field for different models, refer to Inference parameters.
", + "smithy.api#documentation": "The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.
The desired MIME type of the inference body in the response. The default value is\n application/json.
The desired MIME type of the inference body in the response. The default value is application/json.
Identifier of the model.
", + "smithy.api#documentation": "The unique identifier of the model to invoke to run inference.
\nThe modelId to provide depends on the type of model that you use:
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
\nIf you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
\nIf you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
\nSpecifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-Trace" + } + }, + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockruntime#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied\n to the invocation.
\nAn error will be thrown in the following situations.
\nYou don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.
You enable the guardrail but the contentType isn't application/json.
You provide a guardrail identifier, but guardrailVersion isn't specified.
The version number for the guardrail. The value can also be DRAFT.
Inference response from the model in the format specified in the content-type header field. To see the format and content of this field for different models, refer to Inference parameters.
", + "smithy.api#documentation": "Inference response from the model in the format specified in the contentType header. To see the format and content of the request and response bodies for different models, refer to Inference parameters.
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#documentation": "Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.
\nTo see if a model supports streaming, call GetFoundationModel\n and check the responseStreamingSupported field in the response.
The CLI doesn't support InvokeModelWithResponseStream.
For example code, see Invoke model with streaming code\n example in the Amazon Bedrock User Guide.\n
\nThis operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.
Inference input in the format specified by the \n content-type. To see the format and content of this field for different models, refer to Inference parameters.
", + "smithy.api#documentation": "The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.
Id of the model to invoke using the streaming request.
", + "smithy.api#documentation": "The unique identifier of the model to invoke to run inference.
\nThe modelId to provide depends on the type of model that you use:
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
\nIf you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
\nIf you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
\nSpecifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-Trace" + } + }, + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockruntime#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied\n to the invocation.
\nAn error is thrown in the following situations.
\nYou don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.
You enable the guardrail but the contentType isn't application/json.
You provide a guardrail identifier, but guardrailVersion isn't specified.
The version number for the guardrail. The value can also be DRAFT.
Inference response from the model in the format specified by Content-Type. To see the format and content of this field for different models, refer to Inference parameters.
", + "smithy.api#documentation": "Inference response from the model in the format specified by the contentType header. To see the format and content of this field for different models, refer to Inference parameters.
An error occurred while streaming the response.
", + "smithy.api#documentation": "An error occurred while streaming the response. Retry your request.
", "smithy.api#error": "client", "smithy.api#httpError": 424 } @@ -1094,19 +1151,34 @@ } }, "internalServerException": { - "target": "com.amazonaws.bedrockruntime#InternalServerException" + "target": "com.amazonaws.bedrockruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
" + } }, "modelStreamErrorException": { - "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException" + "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException", + "traits": { + "smithy.api#documentation": "An error occurred while streaming the response. Retry your request.
" + } }, "validationException": { - "target": "com.amazonaws.bedrockruntime#ValidationException" + "target": "com.amazonaws.bedrockruntime#ValidationException", + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" + } }, "throttlingException": { - "target": "com.amazonaws.bedrockruntime#ThrottlingException" + "target": "com.amazonaws.bedrockruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "The number or frequency of requests exceeds the limit. Resubmit your request later.
" + } }, "modelTimeoutException": { - "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" + "target": "com.amazonaws.bedrockruntime#ModelTimeoutException", + "traits": { + "smithy.api#documentation": "The request took too long to process. Processing time exceeded the model timeout length.
" + } } }, "traits": { @@ -1149,6 +1221,23 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.bedrockruntime#Trace": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.bedrockruntime#ValidationException": { "type": "structure", "members": { 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 e866df5a4d7..ab3ccfd847e 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.2023-04-20.json +++ b/codegen/sdk-codegen/aws-models/bedrock.2023-04-20.json @@ -18,6 +18,12 @@ "type": "service", "version": "2023-04-20", "resources": [ + { + "target": "com.amazonaws.bedrock#EvaluationJobResource" + }, + { + "target": "com.amazonaws.bedrock#GuardrailsResource" + }, { "target": "com.amazonaws.bedrock#LoggingResource" }, @@ -46,7 +52,7 @@ "name": "bedrock" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Describes the API operations for creating and managing Amazon Bedrock models.
", + "smithy.api#documentation": "Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.
", "smithy.api#title": "Amazon Bedrock", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -714,6 +720,21 @@ } } }, + "com.amazonaws.bedrock#AutomatedEvaluationConfig": { + "type": "structure", + "members": { + "datasetMetricConfigs": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs", + "traits": { + "smithy.api#documentation": "Specifies the required elements for an automatic model evaluation job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Use to specify a automatic model evaluation job. The EvaluationDatasetMetricConfig object is used to specify the prompt datasets, task type, and metric names.
The role ARN.
", + "smithy.api#documentation": "The role Amazon Resource Name (ARN).
", "smithy.api#required": {} } }, @@ -810,13 +831,13 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.bedrock#CreateModelCustomizationJob": { + "com.amazonaws.bedrock#CreateEvaluationJob": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJobRequest" + "target": "com.amazonaws.bedrock#CreateEvaluationJobRequest" }, "output": { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJobResponse" + "target": "com.amazonaws.bedrock#CreateEvaluationJobResponse" }, "errors": [ { @@ -837,130 +858,95 @@ { "target": "com.amazonaws.bedrock#ThrottlingException" }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, { "target": "com.amazonaws.bedrock#ValidationException" } ], "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. Amazon 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": "API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluations.
", "smithy.api#http": { - "code": 201, + "code": 202, "method": "POST", - "uri": "/model-customization-jobs" + "uri": "/evaluation-jobs" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { + "com.amazonaws.bedrock#CreateEvaluationJobRequest": { "type": "structure", "members": { "jobName": { - "target": "com.amazonaws.bedrock#JobName", + "target": "com.amazonaws.bedrock#EvaluationJobName", "traits": { - "smithy.api#documentation": "Enter a unique name for the fine-tuning job.
", + "smithy.api#documentation": "The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.
", "smithy.api#required": {} } }, - "customModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "Enter a name for the custom model.
", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Amazon 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 Amazon Bedrock, the caller of this API must have the iam:PassRole permission.\n
A description of the model evaluation job.
" } }, "clientRequestToken": { "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "Unique token value that you can provide. The GetModelCustomizationJob response includes the same token value.
", + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, - "baseModelIdentifier": { - "target": "com.amazonaws.bedrock#BaseModelIdentifier", + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "Name of the base model.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.
The customization type.
" - } - }, - "customModelKmsKeyId": { + "customerEncryptionKeyId": { "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#documentation": "The custom model is encrypted at rest using this key.
" + "smithy.api#documentation": "Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
" } }, "jobTags": { "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "Assign tags to the job.
" - } - }, - "customModelTags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "Assign tags to the custom model.
" + "smithy.api#documentation": "Tags to attach to the model evaluation job.
" } }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", "traits": { - "smithy.api#documentation": "Information about the training dataset.
", + "smithy.api#documentation": "Specifies whether the model evaluation job is automatic or uses human worker.
", "smithy.api#required": {} } }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", - "traits": { - "smithy.api#documentation": "Information about the validation dataset.
" - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", "traits": { - "smithy.api#documentation": "S3 location for the output data.
", + "smithy.api#documentation": "Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.
", "smithy.api#required": {} } }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", "traits": { - "smithy.api#documentation": "Parameters related to tuning the model.
", + "smithy.api#documentation": "An object that defines where the results of model evaluation job will be saved in Amazon S3.
", "smithy.api#required": {} } - }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "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.
" - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#CreateModelCustomizationJobResponse": { + "com.amazonaws.bedrock#CreateEvaluationJobResponse": { "type": "structure", "members": { "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "target": "com.amazonaws.bedrock#EvaluationJobArn", "traits": { - "smithy.api#documentation": "ARN of the fine tuning job
", + "smithy.api#documentation": "The ARN of the model evaluation job.
", "smithy.api#required": {} } } @@ -969,18 +955,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { + "com.amazonaws.bedrock#CreateGuardrail": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" + "target": "com.amazonaws.bedrock#CreateGuardrailRequest" }, "output": { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" + "target": "com.amazonaws.bedrock#CreateGuardrailResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -1001,177 +990,135 @@ } ], "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#documentation": "Creates a guardrail to block topics and to filter out harmful content.
\nSpecify a name and optional description.
Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.
Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic.
Give a name and description so that the guardrail can properly identify the topic.
Specify DENY in the type field.
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list.
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.
Specify the category in the type field.
Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig.
(Optional) For security, include the ARN of a KMS key in the kmsKeyId field.
(Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources.
Unique token value that you can provide. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error.
", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "The name to give the guardrail.
", + "smithy.api#required": {} } }, - "modelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", "traits": { - "smithy.api#documentation": "Number of model units to allocate.
", - "smithy.api#required": {} + "smithy.api#documentation": "A description of the guardrail.
" } }, - "provisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", + "topicPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", + "traits": { + "smithy.api#documentation": "The topic policies to configure for the guardrail.
" + } + }, + "contentPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", + "traits": { + "smithy.api#documentation": "The content filter policies to configure for the guardrail.
" + } + }, + "wordPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", + "traits": { + "smithy.api#documentation": "The word policy you configure for the guardrail.
" + } + }, + "sensitiveInformationPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", + "traits": { + "smithy.api#documentation": "The sensitive information policy to configure for the guardrail.
" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { - "smithy.api#documentation": "Unique name for this provisioned throughput.
", + "smithy.api#documentation": "The message to return when the guardrail blocks a prompt.
", "smithy.api#required": {} } }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { - "smithy.api#documentation": "Name or ARN of the model to associate with this provisioned throughput.
", + "smithy.api#documentation": "The message to return when the guardrail blocks a model response.
", "smithy.api#required": {} } }, - "commitmentDuration": { - "target": "com.amazonaws.bedrock#CommitmentDuration", + "kmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#documentation": "Commitment duration requested for the provisioned throughput.
" + "smithy.api#documentation": "The ARN of the KMS key that you use to encrypt the guardrail.
" } }, "tags": { "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "Tags to associate with this provisioned throughput.
" + "smithy.api#documentation": "The tags that you want to attach to the guardrail.
" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse": { - "type": "structure", - "members": { - "provisionedModelArn": { - "target": "com.amazonaws.bedrock#ProvisionedModelArn", + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "The ARN for this provisioned throughput.
", - "smithy.api#required": {} + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request \n completes no more than once. If this token matches a previous request, \n Amazon Bedrock ignores the request, but does not return an error. \n For more information, see Ensuring \n idempotency in the Amazon S3 User Guide.
", + "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CustomModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 1011 - }, - "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-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" - } - }, - "com.amazonaws.bedrock#CustomModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#CustomModelSummary": { + "com.amazonaws.bedrock#CreateGuardrailResponse": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", "traits": { - "smithy.api#documentation": "The ARN of the custom model.
", + "smithy.api#documentation": "The unique identifier of the guardrail that was created.
", "smithy.api#required": {} } }, - "modelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "The name of the custom model.
", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", "traits": { - "smithy.api#documentation": "Creation time of the model.
", + "smithy.api#documentation": "The ARN of the guardrail that was created.
", "smithy.api#required": {} } }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "version": { + "target": "com.amazonaws.bedrock#GuardrailDraftVersion", "traits": { - "smithy.api#documentation": "The base model ARN.
", + "smithy.api#documentation": "The version of the guardrail that was created. This value should be 1.
", "smithy.api#required": {} } }, - "baseModelName": { - "target": "com.amazonaws.bedrock#ModelName", + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "The base model name.
", + "smithy.api#documentation": "The time at which the guardrail was created.
", "smithy.api#required": {} } - }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
" - } } }, "traits": { - "smithy.api#documentation": "Summary information for a custom model.
" - } - }, - "com.amazonaws.bedrock#CustomModelSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#CustomModelSummary" - } - }, - "com.amazonaws.bedrock#CustomizationType": { - "type": "enum", - "members": { - "FINE_TUNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FINE_TUNING" - } - }, - "CONTINUED_PRE_TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" - } - } + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#DeleteCustomModel": { + "com.amazonaws.bedrock#CreateGuardrailVersion": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeleteCustomModelRequest" + "target": "com.amazonaws.bedrock#CreateGuardrailVersionRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeleteCustomModelResponse" + "target": "com.amazonaws.bedrock#CreateGuardrailVersionResponse" }, "errors": [ { @@ -1186,6 +1133,9 @@ { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, @@ -1194,381 +1144,435 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a custom model that you created earlier. For more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Creates a version of the guardrail. Use this API to create a snapshot of the \n guardrail when you are satisfied with a configuration, or to compare the configuration with another version.
", "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/custom-models/{modelIdentifier}" - }, - "smithy.api#idempotent": {} + "code": 202, + "method": "POST", + "uri": "/guardrails/{guardrailIdentifier}" + } } }, - "com.amazonaws.bedrock#DeleteCustomModelRequest": { + "com.amazonaws.bedrock#CreateGuardrailVersionRequest": { "type": "structure", "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "Name of the model to delete.
", + "smithy.api#documentation": "The unique identifier of the guardrail.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "A description of the guardrail version.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request \n completes no more than once. If this token matches a previous request, \n Amazon Bedrock ignores the request, but does not return an error. \n For more information, see Ensuring \n idempotency in the Amazon S3 User Guide.
", + "smithy.api#idempotencyToken": {} + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#DeleteCustomModelResponse": { + "com.amazonaws.bedrock#CreateGuardrailVersionResponse": { "type": "structure", - "members": {}, + "members": { + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "traits": { + "smithy.api#documentation": "The number of the version of the guardrail.
", + "smithy.api#required": {} + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration": { + "com.amazonaws.bedrock#CreateModelCustomizationJob": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest" + "target": "com.amazonaws.bedrock#CreateModelCustomizationJobRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse" + "target": "com.amazonaws.bedrock#CreateModelCustomizationJobResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, { - "target": "com.amazonaws.bedrock#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "Delete the invocation logging.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/logging/modelinvocations" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "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#ResourceNotFoundException" }, { - "target": "com.amazonaws.bedrock#InternalServerException" + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" }, { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "target": "com.amazonaws.bedrock#ThrottlingException" }, { - "target": "com.amazonaws.bedrock#ThrottlingException" + "target": "com.amazonaws.bedrock#TooManyTagsException" }, { "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#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. Amazon Bedrock returns validation loss metrics and output generations after the job completes.\n
\nFor information on the format of training and validation data, see Prepare the datasets.
\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 Amazon Bedrock User Guide.
", "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/provisioned-model-throughput/{provisionedModelId}" + "code": 201, + "method": "POST", + "uri": "/model-customization-jobs" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest": { + "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { "type": "structure", "members": { - "provisionedModelId": { - "target": "com.amazonaws.bedrock#ProvisionedModelId", + "jobName": { + "target": "com.amazonaws.bedrock#JobName", "traits": { - "smithy.api#documentation": "The ARN or name of the provisioned throughput.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "A name for the fine-tuning job.
", "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": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrock#FineTuningJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } }, - "COMPLETED": { - "target": "smithy.api#Unit", + "customModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", "traits": { - "smithy.api#enumValue": "Completed" + "smithy.api#documentation": "A name for the resulting custom model.
", + "smithy.api#required": {} } }, - "FAILED": { - "target": "smithy.api#Unit", + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#enumValue": "Failed" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Amazon 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 Amazon Bedrock, the caller of this API must have the iam:PassRole permission.\n
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} } }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.bedrock#FoundationModelArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$" - } - }, - "com.amazonaws.bedrock#FoundationModelDetails": { - "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "baseModelIdentifier": { + "target": "com.amazonaws.bedrock#BaseModelIdentifier", "traits": { - "smithy.api#documentation": "The model ARN.
", + "smithy.api#documentation": "Name of the base model.
", "smithy.api#required": {} } }, - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", "traits": { - "smithy.api#documentation": "The model identifier.
", - "smithy.api#required": {} + "smithy.api#documentation": "The customization type.
" } }, - "modelName": { - "target": "com.amazonaws.bedrock#BrandedName", + "customModelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#documentation": "The model name.
" + "smithy.api#documentation": "The custom model is encrypted at rest using this key.
" } }, - "providerName": { - "target": "com.amazonaws.bedrock#BrandedName", + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "he model's provider name.
" + "smithy.api#documentation": "Tags to attach to the job.
" } }, - "inputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "customModelTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "The input modalities that the model supports.
" + "smithy.api#documentation": "Tags to attach to the resulting custom model.
" } }, - "outputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", "traits": { - "smithy.api#documentation": "The output modalities that the model supports.
" + "smithy.api#documentation": "Information about the training dataset.
", + "smithy.api#required": {} } }, - "responseStreamingSupported": { - "target": "smithy.api#Boolean", + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", "traits": { - "smithy.api#documentation": "Indicates whether the model supports streaming.
" + "smithy.api#documentation": "Information about the validation dataset.
" } }, - "customizationsSupported": { - "target": "com.amazonaws.bedrock#ModelCustomizationList", + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", "traits": { - "smithy.api#documentation": "The customization that the model supports.
" + "smithy.api#documentation": "S3 location for the output data.
", + "smithy.api#required": {} } }, - "inferenceTypesSupported": { - "target": "com.amazonaws.bedrock#InferenceTypeList", + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", "traits": { - "smithy.api#documentation": "The inference types that the model supports.
" + "smithy.api#documentation": "Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.
", + "smithy.api#required": {} } }, - "modelLifecycle": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "Contains details about whether a model version is available or deprecated
" + "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.
" } } }, "traits": { - "smithy.api#documentation": "Information about a foundation model.
" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#FoundationModelLifecycle": { + "com.amazonaws.bedrock#CreateModelCustomizationJobResponse": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycleStatus", + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", "traits": { - "smithy.api#documentation": "Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.
Amazon Resource Name (ARN) of the fine tuning job
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Details about whether a model version is available or deprecated.
" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#FoundationModelLifecycleStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } + "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "LEGACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEGACY" - } + { + "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 dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/provisioned-model-throughput" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#FoundationModelSummary": { + "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "The ARN of the foundation model.
", - "smithy.api#required": {} + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
", + "smithy.api#idempotencyToken": {} } }, - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", "traits": { - "smithy.api#documentation": "The model Id of the foundation model.
", + "smithy.api#documentation": "Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.
\nFor model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.
\nFor more information about what an MU specifies, contact your Amazon Web Services account manager.
", "smithy.api#required": {} } }, - "modelName": { - "target": "com.amazonaws.bedrock#BrandedName", + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", "traits": { - "smithy.api#documentation": "The name of the model.
" + "smithy.api#documentation": "The name for this Provisioned Throughput.
", + "smithy.api#required": {} } }, - "providerName": { - "target": "com.amazonaws.bedrock#BrandedName", + "modelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", "traits": { - "smithy.api#documentation": "The model's provider name.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} } }, - "inputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", "traits": { - "smithy.api#documentation": "The input modalities that the model supports.
" + "smithy.api#documentation": "The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.
\nCustom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide
" } }, - "outputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "tags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "The output modalities that the model supports.
" + "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 Amazon Resource Name (ARN) for this Provisioned Throughput.
", + "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CustomModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 }, - "responseStreamingSupported": { - "target": "smithy.api#Boolean", + "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-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#CustomModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + } + }, + "com.amazonaws.bedrock#CustomModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", "traits": { - "smithy.api#documentation": "Indicates whether the model supports streaming.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model.
", + "smithy.api#required": {} } }, - "customizationsSupported": { - "target": "com.amazonaws.bedrock#ModelCustomizationList", + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", "traits": { - "smithy.api#documentation": "Whether the model supports fine-tuning or continual pre-training.
" + "smithy.api#documentation": "The name of the custom model.
", + "smithy.api#required": {} } }, - "inferenceTypesSupported": { - "target": "com.amazonaws.bedrock#InferenceTypeList", + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "The inference types that the model supports.
" + "smithy.api#documentation": "Creation time of the model.
", + "smithy.api#required": {} } }, - "modelLifecycle": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "Contains details about whether a model version is available or deprecated.
" + "smithy.api#documentation": "The base model Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "baseModelName": { + "target": "com.amazonaws.bedrock#ModelName", + "traits": { + "smithy.api#documentation": "The base model name.
", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
" } } }, "traits": { - "smithy.api#documentation": "Summary information for a foundation model.
" + "smithy.api#documentation": "Summary information for a custom model.
" } }, - "com.amazonaws.bedrock#FoundationModelSummaryList": { + "com.amazonaws.bedrock#CustomModelSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#FoundationModelSummary" + "target": "com.amazonaws.bedrock#CustomModelSummary" } }, - "com.amazonaws.bedrock#GetCustomModel": { + "com.amazonaws.bedrock#CustomizationType": { + "type": "enum", + "members": { + "FINE_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINE_TUNING" + } + }, + "CONTINUED_PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + } + } + } + }, + "com.amazonaws.bedrock#DeleteCustomModel": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetCustomModelRequest" + "target": "com.amazonaws.bedrock#DeleteCustomModelRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetCustomModelResponse" + "target": "com.amazonaws.bedrock#DeleteCustomModelResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -1583,22 +1587,22 @@ } ], "traits": { - "smithy.api#documentation": "Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, - "method": "GET", + "method": "DELETE", "uri": "/custom-models/{modelIdentifier}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetCustomModelRequest": { + "com.amazonaws.bedrock#DeleteCustomModelRequest": { "type": "structure", "members": { "modelIdentifier": { "target": "com.amazonaws.bedrock#ModelIdentifier", "traits": { - "smithy.api#documentation": "Name or ARN of the custom model.
", + "smithy.api#documentation": "Name of the model to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1608,114 +1612,28 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetCustomModelResponse": { + "com.amazonaws.bedrock#DeleteCustomModelResponse": { "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "ARN associated with this model.
", - "smithy.api#required": {} - } - }, - "modelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "Model name associated with this model.
", - "smithy.api#required": {} - } - }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "Job name associated with this model.
" - } - }, - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", - "traits": { - "smithy.api#documentation": "Job ARN associated with this model.
", - "smithy.api#required": {} - } - }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "ARN of the base model.
", - "smithy.api#required": {} - } - }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "The type of model customization.
" - } - }, - "modelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The custom model is encrypted at rest using this key.
" - } - }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", - "traits": { - "smithy.api#documentation": "Hyperparameter values associated with this model.
" - } - }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", - "traits": { - "smithy.api#documentation": "Information about the training dataset.
", - "smithy.api#required": {} - } - }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig" - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", - "traits": { - "smithy.api#documentation": "Output data configuration associated with this custom model.
", - "smithy.api#required": {} - } - }, - "trainingMetrics": { - "target": "com.amazonaws.bedrock#TrainingMetrics", - "traits": { - "smithy.api#documentation": "The training metrics from the job creation.
" - } - }, - "validationMetrics": { - "target": "com.amazonaws.bedrock#ValidationMetrics", - "traits": { - "smithy.api#documentation": "The validation metrics from the job creation.
" - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "Creation time of the model.
", - "smithy.api#required": {} - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetFoundationModel": { + "com.amazonaws.bedrock#DeleteGuardrail": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetFoundationModelRequest" + "target": "com.amazonaws.bedrock#DeleteGuardrailRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetFoundationModelResponse" + "target": "com.amazonaws.bedrock#DeleteGuardrailResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -1730,52 +1648,52 @@ } ], "traits": { - "smithy.api#documentation": "Get details about a Amazon Bedrock foundation model.
", + "smithy.api#documentation": "Deletes a guardrail.
\nTo delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted.
To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.
The model identifier.
", + "smithy.api#documentation": "The unique identifier of the guardrail.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#httpQuery": "guardrailVersion" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetFoundationModelResponse": { + "com.amazonaws.bedrock#DeleteGuardrailResponse": { "type": "structure", - "members": { - "modelDetails": { - "target": "com.amazonaws.bedrock#FoundationModelDetails", - "traits": { - "smithy.api#documentation": "Information about the foundation model.
" - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetModelCustomizationJob": { + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetModelCustomizationJobRequest" + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetModelCustomizationJobResponse" + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse" }, "errors": [ { @@ -1785,375 +1703,3062 @@ "target": "com.amazonaws.bedrock#InternalServerException" }, { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, + "target": "com.amazonaws.bedrock#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Delete the invocation logging.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/logging/modelinvocations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "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" + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon 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 Amazon Resource Name (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": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrock#ErrorMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ErrorMessage" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.bedrock#EvaluationBedrockModel": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationModelIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Bedrock model specified.
", + "smithy.api#required": {} + } + }, + "inferenceParams": { + "target": "com.amazonaws.bedrock#EvaluationModelInferenceParams", + "traits": { + "smithy.api#documentation": "Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the ARN of the Amazon Bedrock models specified in your model evaluation job. Each Amazon Bedrock model supports different inferenceParams. To learn more about supported inference parameters for Amazon Bedrock models, see Inference parameters for foundation models.
The inferenceParams are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, \"temperature\":\"0.25\" key value pair would need to be formatted as \\\"temperature\\\":\\\"0.25\\\" to successfully accepted in the request.
Used to specify an automated model evaluation job.\n See AutomatedEvaluationConfig to view the required parameters.
Used to specify a model evaluation job that uses human workers.See HumanEvaluationConfig to view the required parameters.
Used to specify either a AutomatedEvaluationConfig or HumanEvaluationConfig object.
Used to specify supported built-in prompt datasets. Valid values are Builtin.Bold, Builtin.BoolQ, Builtin.NaturalQuestions, Builtin.Gigaword, Builtin.RealToxicityPrompts, Builtin.TriviaQa, Builtin.T-Rex, Builtin.WomensEcommerceClothingReviews and Builtin.Wikitext2.
For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.
" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetLocation": { + "type": "union", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI of the S3 bucket specified in the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location in Amazon S3 where your prompt dataset is stored.
" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetMetricConfig": { + "type": "structure", + "members": { + "taskType": { + "target": "com.amazonaws.bedrock#EvaluationTaskType", + "traits": { + "smithy.api#documentation": "The task type you want the model to carry out.
", + "smithy.api#required": {} + } + }, + "dataset": { + "target": "com.amazonaws.bedrock#EvaluationDataset", + "traits": { + "smithy.api#documentation": "Specifies the prompt dataset.
", + "smithy.api#required": {} + } + }, + "metricNames": { + "target": "com.amazonaws.bedrock#EvaluationMetricNames", + "traits": { + "smithy.api#documentation": "The names of the metrics used. For automated model evaluation jobs valid values are \"Builtin.Accuracy\", \"Builtin.Robustness\", and \"Builtin.Toxicity\". In human-based model evaluation jobs the array of strings must match the name parameter specified in HumanEvaluationCustomMetric.
Defines the built-in prompt datasets, built-in metric names and custom metric names, and the task type.
" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluationDatasetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationInferenceConfig": { + "type": "union", + "members": { + "models": { + "target": "com.amazonaws.bedrock#EvaluationModelConfigs", + "traits": { + "smithy.api#documentation": "Used to specify the models.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Used to define the models you want used in your model evaluation job. Automated model evaluation jobs support only a single model. In a human-based model evaluation job, your annotator can compare the responses for up to two different models.
" + } + }, + "com.amazonaws.bedrock#EvaluationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#EvaluationJobDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9]){0,62}$" + } + }, + "com.amazonaws.bedrock#EvaluationJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#GetEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#ListEvaluationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopEvaluationJob" + } + ] + }, + "com.amazonaws.bedrock#EvaluationJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.bedrock#EvaluationJobType": { + "type": "enum", + "members": { + "HUMAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Human" + } + }, + "AUTOMATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automated" + } + } + } + }, + "com.amazonaws.bedrock#EvaluationMetricDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationMetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationMetricNames": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationMetricName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelConfig": { + "type": "union", + "members": { + "bedrockModel": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModel", + "traits": { + "smithy.api#documentation": "Defines the Amazon Bedrock model and inference parameters you want used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the models used in the model evaluation job.
" + } + }, + "com.amazonaws.bedrock#EvaluationModelConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationModelConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "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-]{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#EvaluationModelIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationModelIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelInferenceParams": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1023 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationOutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI where the results of model evaluation job are saved.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location where the results of your model evaluation job are saved.
" + } + }, + "com.amazonaws.bedrock#EvaluationRatingMethod": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_]+$" + } + }, + "com.amazonaws.bedrock#EvaluationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluationSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model evaluation job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "The name of the model evaluation job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "The current status of the model evaluation job.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "When the model evaluation job was created.
", + "smithy.api#required": {} + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "The type, either human or automatic, of model evaluation job.
", + "smithy.api#required": {} + } + }, + "evaluationTaskTypes": { + "target": "com.amazonaws.bedrock#EvaluationTaskTypes", + "traits": { + "smithy.api#documentation": "What task type was used in the model evaluation job.
", + "smithy.api#required": {} + } + }, + "modelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationModelIdentifiers", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the model evaluation job.
" + } + }, + "com.amazonaws.bedrock#EvaluationTaskType": { + "type": "enum", + "members": { + "SUMMARIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Summarization" + } + }, + "CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Classification" + } + }, + "QUESTION_AND_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QuestionAndAnswer" + } + }, + "GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Generation" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Custom" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.bedrock#EvaluationTaskTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationTaskType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#FineTuningJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.bedrock#FoundationModelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$" + } + }, + "com.amazonaws.bedrock#FoundationModelDetails": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "The model Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "The model identifier.
", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "The model name.
" + } + }, + "providerName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "The model's provider name.
" + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "The input modalities that the model supports.
" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "The output modalities that the model supports.
" + } + }, + "responseStreamingSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the model supports streaming.
" + } + }, + "customizationsSupported": { + "target": "com.amazonaws.bedrock#ModelCustomizationList", + "traits": { + "smithy.api#documentation": "The customization that the model supports.
" + } + }, + "inferenceTypesSupported": { + "target": "com.amazonaws.bedrock#InferenceTypeList", + "traits": { + "smithy.api#documentation": "The inference types that the model supports.
" + } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "Contains details about whether a model version is available or deprecated
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a foundation model.
" + } + }, + "com.amazonaws.bedrock#FoundationModelLifecycle": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycleStatus", + "traits": { + "smithy.api#documentation": "Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.
Details about whether a model version is available or deprecated.
" + } + }, + "com.amazonaws.bedrock#FoundationModelLifecycleStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "LEGACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGACY" + } + } + } + }, + "com.amazonaws.bedrock#FoundationModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the foundation model.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "The model ID of the foundation model.
", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "The name of the model.
" + } + }, + "providerName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "The model's provider name.
" + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "The input modalities that the model supports.
" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "The output modalities that the model supports.
" + } + }, + "responseStreamingSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the model supports streaming.
" + } + }, + "customizationsSupported": { + "target": "com.amazonaws.bedrock#ModelCustomizationList", + "traits": { + "smithy.api#documentation": "Whether the model supports fine-tuning or continual pre-training.
" + } + }, + "inferenceTypesSupported": { + "target": "com.amazonaws.bedrock#InferenceTypeList", + "traits": { + "smithy.api#documentation": "The inference types that the model supports.
" + } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "Contains details about whether a model version is available or deprecated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information for a foundation model.
" + } + }, + "com.amazonaws.bedrock#FoundationModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#FoundationModelSummary" + } + }, + "com.amazonaws.bedrock#GetCustomModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetCustomModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetCustomModelResponse" + }, + "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 the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/custom-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "Name or Amazon Resource Name (ARN) of the custom model.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelResponse": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) associated with this model.
", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "Model name associated with this model.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "Job name associated with this model.
" + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "Job Amazon Resource Name (ARN) associated with this model.
", + "smithy.api#required": {} + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the base model.
", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "The type of model customization.
" + } + }, + "modelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The custom model is encrypted at rest using this key.
" + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.
" + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "Contains information about the training dataset.
", + "smithy.api#required": {} + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "Contains information about the validation dataset.
" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "Output data configuration associated with this custom model.
", + "smithy.api#required": {} + } + }, + "trainingMetrics": { + "target": "com.amazonaws.bedrock#TrainingMetrics", + "traits": { + "smithy.api#documentation": "Contains training metrics from the job creation.
" + } + }, + "validationMetrics": { + "target": "com.amazonaws.bedrock#ValidationMetrics", + "traits": { + "smithy.api#documentation": "The validation metrics from the job creation.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Creation time of the model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetEvaluationJobResponse" + }, + "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": "Retrieves the properties associated with a model evaluation job, including the\n status of the job. For more information, see Model evaluations.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/evaluation-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model evaluation job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJobResponse": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "The name of the model evaluation job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the model evaluation job.
", + "smithy.api#required": {} + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model evaluation job.
", + "smithy.api#required": {} + } + }, + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", + "traits": { + "smithy.api#documentation": "The description of the model evaluation job.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role used in the model evaluation job.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed key specified when the model evaluation job was created.
" + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "The type of model evaluation job.
", + "smithy.api#required": {} + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", + "traits": { + "smithy.api#documentation": "Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you defined.
", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "traits": { + "smithy.api#documentation": "Details about the models you specified in your model evaluation job.
", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + "traits": { + "smithy.api#documentation": "Amazon S3 location for where output data is saved.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "When the model evaluation job was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "When the model evaluation job was last modified.
" + } + }, + "failureMessages": { + "target": "com.amazonaws.bedrock#ErrorMessages", + "traits": { + "smithy.api#documentation": "An array of strings the specify why the model evaluation job has failed.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetFoundationModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetFoundationModelResponse" + }, + "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 about a Amazon Bedrock foundation model.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/foundation-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The model identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelResponse": { + "type": "structure", + "members": { + "modelDetails": { + "target": "com.amazonaws.bedrock#FoundationModelDetails", + "traits": { + "smithy.api#documentation": "Information about the foundation model.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetGuardrailResponse" + }, + "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": "Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.
The unique identifier of the guardrail for which to get details.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.
The name of the guardrail.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "The description of the guardrail.
" + } + }, + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
", + "smithy.api#required": {} + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "The ARN of the guardrail that was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#GuardrailStatus", + "traits": { + "smithy.api#documentation": "The status of the guardrail.
", + "smithy.api#required": {} + } + }, + "topicPolicy": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicy", + "traits": { + "smithy.api#documentation": "The topic policy that was configured for the guardrail.
" + } + }, + "contentPolicy": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicy", + "traits": { + "smithy.api#documentation": "The content policy that was configured for the guardrail.
" + } + }, + "wordPolicy": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicy", + "traits": { + "smithy.api#documentation": "The word policy that was configured for the guardrail.
" + } + }, + "sensitiveInformationPolicy": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy", + "traits": { + "smithy.api#documentation": "The sensitive information policy that was configured for the guardrail.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the guardrail was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the guardrail was updated.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrock#GuardrailStatusReasons", + "traits": { + "smithy.api#documentation": "Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.
Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.
The message that the guardrail returns when it blocks a prompt.
", + "smithy.api#required": {} + } + }, + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "The message that the guardrail returns when it blocks a model response.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key that encrypts the guardrail.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelCustomizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelCustomizationJobResponse" + }, + "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": "Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-customization-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "traits": { + "smithy.api#documentation": "Identifier for the customization job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customization job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "The name of the customization job.
", + "smithy.api#required": {} + } + }, + "outputModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the output model.
", + "smithy.api#required": {} + } + }, + "outputModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the output model.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "The token that you specified in the CreateCustomizationJob request.
The Amazon Resource Name (ARN) of the IAM role.
", + "smithy.api#required": {} + } + }, + "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.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "Information about why the job failed.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time that the resource was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time that the resource was last modified.
" + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time that the resource transitioned to terminal state.
" + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the base model.
", + "smithy.api#required": {} + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.
", + "smithy.api#required": {} + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "Contains information about the training dataset.
", + "smithy.api#required": {} + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "Contains information about the validation dataset.
", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "Output data configuration
", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "The type of model customization.
" + } + }, + "outputModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The custom model is encrypted at rest using this key.
" + } + }, + "trainingMetrics": { + "target": "com.amazonaws.bedrock#TrainingMetrics", + "traits": { + "smithy.api#documentation": "Contains training metrics from the job creation.
" + } + }, + "validationMetrics": { + "target": "com.amazonaws.bedrock#ValidationMetrics", + "traits": { + "smithy.api#documentation": "The loss metric for each validator that you provided in the createjob request.
" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "VPC configuration for the custom model job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get the current configuration values for model invocation logging.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/logging/modelinvocations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": { + "loggingConfig": { + "target": "com.amazonaws.bedrock#LoggingConfig", + "traits": { + "smithy.api#documentation": "The current configuration values.
" + } + } + }, + "traits": { + "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": "Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon 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 Amazon Resource Name (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 number of model units allocated to this Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The number of model units that was requested 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 Amazon Resource Name (ARN) of the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.
The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "The 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 time that this Provisioned Throughput was modified.
", + "smithy.api#required": {} + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.
" + } + }, + "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": "The timestamp for when the commitment term for the Provisioned Throughput expires.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GuardrailArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$" + } + }, + "com.amazonaws.bedrock#GuardrailBlockedMessaging": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailContentFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterType", + "traits": { + "smithy.api#documentation": "The harmful category that the content filter is applied to.
", + "smithy.api#required": {} + } + }, + "inputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "The strength of the content filter to apply to prompts. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.
", + "smithy.api#required": {} + } + }, + "outputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "The strength of the content filter to apply to model responses. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
\n\n Hate – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
\n\n Insults – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
\n\n Sexual – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
\n\n Violence – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
\nContent filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.
\nFor more information, see Guardrails content filters.
\nThis data type is used in the following API operations:
\nThe harmful category that the content filter is applied to.
", + "smithy.api#required": {} + } + }, + "inputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "The strength of the content filter to apply to prompts. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.
", + "smithy.api#required": {} + } + }, + "outputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "The strength of the content filter to apply to model responses. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
\n\n Hate – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
\n\n Insults – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
\n\n Sexual – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
\n\n Violence – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
\nContent filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.
\nFor more information, see Guardrails content filters.
\nThis data type is used in the following API operations:
\nContains the type of the content filter and how strongly it should apply to prompts and model responses.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about how to handle harmful content.
\nThis data type is used in the following API operations:
\nContains the type of the content filter and how strongly it should apply to prompts and model responses.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about how to handle harmful content.
\nThis data type is used in the following API operations:
\nManagedWords$type\n The managed word type that was configured for the guardrail.\n (For now, we only offer profanity word list)
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The managed word list that was configured for the guardrail.\n (This is a list of words that are pre-defined and managed by Guardrails only.)
" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordsConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordsType", + "traits": { + "smithy.api#documentation": "The managed word type to configure for the guardrail.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The managed word list to configure for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordsType": { + "type": "enum", + "members": { + "PROFANITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFANITY" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailNumericalVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[1-9][0-9]{0,7}$" + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntity" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntitiesConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntityConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntity": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", + "traits": { + "smithy.api#documentation": "The type of PII entity. For example, Social Security Number.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "The configured guardrail action when PII entity is detected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The PII entity configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntityConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", + "traits": { + "smithy.api#documentation": "Configure guardrail type when the PII entity is detected.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "Configure guardrail action when the PII entity is detected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The PII entity to configure for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntityType": { + "type": "enum", + "members": { + "ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDRESS" + } + }, + "AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGE" + } + }, + "AWS_ACCESS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_ACCESS_KEY" + } + }, + "AWS_SECRET_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SECRET_KEY" + } + }, + "CA_HEALTH_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_HEALTH_NUMBER" + } + }, + "CA_SOCIAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" + } + }, + "CREDIT_DEBIT_CARD_CVV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_CVV" + } + }, + "CREDIT_DEBIT_CARD_EXPIRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_EXPIRY" + } + }, + "CREDIT_DEBIT_CARD_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_NUMBER" + } + }, + "DRIVER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIVER_ID" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "LICENSE_PLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_PLATE" + } + }, + "MAC_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAC_ADDRESS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD" + } + }, + "PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE" + } + }, + "PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIN" + } + }, + "SWIFT_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SWIFT_CODE" + } + }, + "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" + } + }, + "UK_NATIONAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" + } + }, + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USERNAME" + } + }, + "US_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ACCOUNT_NUMBER" + } + }, + "US_BANK_ROUTING_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ROUTING_NUMBER" + } + }, + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" + } + }, + "US_PASSPORT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_PASSPORT_NUMBER" + } + }, + "US_SOCIAL_SECURITY_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_SOCIAL_SECURITY_NUMBER" + } + }, + "VEHICLE_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailRegex": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the regular expression for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the regular expression for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "pattern": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pattern of the regular expression configured for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "The action taken when a match to the regular expression is detected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The regular expression configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailRegexConfig": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the regular expression to configure for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the regular expression to configure for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "pattern": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The regular expression pattern to configure for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "The guardrail action to configure when matching regular expression is detected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The regular expression to configure for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailRegexes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailRegex" + } + }, + "com.amazonaws.bedrock#GuardrailRegexesConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailRegexConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#GuardrailSensitiveInformationAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "ANONYMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANONYMIZE" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy": { + "type": "structure", + "members": { + "piiEntities": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntities", + "traits": { + "smithy.api#documentation": "The list of PII entities configured for the guardrail.
" + } + }, + "regexes": { + "target": "com.amazonaws.bedrock#GuardrailRegexes", + "traits": { + "smithy.api#documentation": "The list of regular expressions configured for the guardrail.
" + } } - ], + }, "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#http": { - "code": 200, - "method": "GET", - "uri": "/model-customization-jobs/{jobIdentifier}" - }, - "smithy.api#readonly": {} + "smithy.api#documentation": "Contains details about PII entities and regular expressions configured for the guardrail.
" } }, - "com.amazonaws.bedrock#GetModelCustomizationJobRequest": { + "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig": { "type": "structure", "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "piiEntitiesConfig": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntitiesConfig", "traits": { - "smithy.api#documentation": "Identifier for the customization job.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "A list of PII entities to configure to the guardrail.
" + } + }, + "regexesConfig": { + "target": "com.amazonaws.bedrock#GuardrailRegexesConfig", + "traits": { + "smithy.api#documentation": "A list of regular expressions to configure to the guardrail.
" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Contains details about PII entities and regular expressions to configure for the guardrail.
" } }, - "com.amazonaws.bedrock#GetModelCustomizationJobResponse": { - "type": "structure", + "com.amazonaws.bedrock#GuardrailStatus": { + "type": "enum", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "CREATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ARN of the customization job.
", - "smithy.api#required": {} + "smithy.api#enumValue": "CREATING" } }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", + "UPDATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the customization job.
", - "smithy.api#required": {} + "smithy.api#enumValue": "UPDATING" } }, - "outputModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "VERSIONING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the output model.
", - "smithy.api#required": {} + "smithy.api#enumValue": "VERSIONING" } }, - "outputModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", + "READY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ARN of the output model.
" + "smithy.api#enumValue": "READY" } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The token that you specified in the CreateCustomizationJob request.
" + "smithy.api#enumValue": "FAILED" } }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "DELETING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ARN of the IAM role.
", - "smithy.api#required": {} + "smithy.api#enumValue": "DELETING" } + } + } + }, + "com.amazonaws.bedrock#GuardrailStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 }, - "status": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailStatusReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailStatusReason" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrock#GuardrailSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailSummary" + }, + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#GuardrailSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrock#GuardrailId", "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 unique identifier of the guardrail.
", + "smithy.api#required": {} } }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", + "arn": { + "target": "com.amazonaws.bedrock#GuardrailArn", "traits": { - "smithy.api#documentation": "Information about why the job failed.
" + "smithy.api#documentation": "The ARN of the guardrail.
", + "smithy.api#required": {} } }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "status": { + "target": "com.amazonaws.bedrock#GuardrailStatus", "traits": { - "smithy.api#documentation": "Time that the resource was created.
", + "smithy.api#documentation": "The status of the guardrail.
", "smithy.api#required": {} } }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", "traits": { - "smithy.api#documentation": "Time that the resource was last modified.
" + "smithy.api#documentation": "The name of the guardrail.
", + "smithy.api#required": {} } }, - "endTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", "traits": { - "smithy.api#documentation": "Time that the resource transitioned to terminal state.
" + "smithy.api#documentation": "A description of the guardrail.
" } }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "version": { + "target": "com.amazonaws.bedrock#GuardrailVersion", "traits": { - "smithy.api#documentation": "ARN of the base model.
", + "smithy.api#documentation": "The version of the guardrail.
", "smithy.api#required": {} } }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "The hyperparameter values for the job. For information about hyperparameters for specific models, see Guidelines for model customization.
", + "smithy.api#documentation": "The date and time at which the guardrail was created.
", "smithy.api#required": {} } }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { + "smithy.api#documentation": "The date and time at which the guardrail was last updated.
", "smithy.api#required": {} } - }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a guardrail.
\nThis data type is used in the following API operations:
\nThe name of the topic to deny.
", "smithy.api#required": {} } }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", + "definition": { + "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", "traits": { - "smithy.api#documentation": "Output data configuration
", + "smithy.api#documentation": "A definition of the topic to deny.
", "smithy.api#required": {} } }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", + "examples": { + "target": "com.amazonaws.bedrock#GuardrailTopicExamples", "traits": { - "smithy.api#documentation": "The type of model customization.
" + "smithy.api#documentation": "A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
" } }, - "outputModelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", + "type": { + "target": "com.amazonaws.bedrock#GuardrailTopicType", "traits": { - "smithy.api#documentation": "The custom model is encrypted at rest using this key.
" + "smithy.api#documentation": "Specifies to deny the topic.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about topics for the guardrail to identify and deny.
\nThis data type is used in the following API operations:
\nThe name of the topic to deny.
", + "smithy.api#required": {} } }, - "trainingMetrics": { - "target": "com.amazonaws.bedrock#TrainingMetrics" + "definition": { + "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", + "traits": { + "smithy.api#documentation": "A definition of the topic to deny.
", + "smithy.api#required": {} + } }, - "validationMetrics": { - "target": "com.amazonaws.bedrock#ValidationMetrics", + "examples": { + "target": "com.amazonaws.bedrock#GuardrailTopicExamples", "traits": { - "smithy.api#documentation": "The loss metric for each validator that you provided in the createjob request.
" + "smithy.api#documentation": "A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
" } }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", + "type": { + "target": "com.amazonaws.bedrock#GuardrailTopicType", "traits": { - "smithy.api#documentation": "VPC configuration for the custom model job.
" + "smithy.api#documentation": "Specifies to deny the topic.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Details about topics for the guardrail to identify and deny.
\nThis data type is used in the following API operations:
\nGet the current configuration values for model invocation logging.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/logging/modelinvocations" + "smithy.api#length": { + "min": 1, + "max": 100 }, - "smithy.api#readonly": {} + "smithy.api#pattern": "^[0-9a-zA-Z-_ !?.]+$", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest": { + "com.amazonaws.bedrock#GuardrailTopicPolicy": { "type": "structure", - "members": {}, + "members": { + "topics": { + "target": "com.amazonaws.bedrock#GuardrailTopics", + "traits": { + "smithy.api#documentation": "A list of policies related to topics that the guardrail should deny.
", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Contains details about topics that the guardrail should identify and deny.
\nThis data type is used in the following API operations:
\nThe current configuration values.
" + "smithy.api#documentation": "A list of policies related to topics that the guardrail should deny.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Contains details about topics that the guardrail should identify and deny.
\nThis data type is used in the following API operations:
\nGet 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": {} + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" } }, - "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest": { + "com.amazonaws.bedrock#GuardrailWord": { "type": "structure", "members": { - "provisionedModelId": { - "target": "com.amazonaws.bedrock#ProvisionedModelId", + "text": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ARN or name of the provisioned throughput.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "Text of the word configured for the guardrail to block.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "A word configured for the guardrail.
" } }, - "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse": { + "com.amazonaws.bedrock#GuardrailWordConfig": { "type": "structure", "members": { - "modelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", + "text": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The current number of model units requested to be available for this provisioned throughput.
", + "smithy.api#documentation": "Text of the word configured for the guardrail to block.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, "smithy.api#required": {} } - }, - "desiredModelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", + } + }, + "traits": { + "smithy.api#documentation": "A word to configure for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailWordPolicy": { + "type": "structure", + "members": { + "words": { + "target": "com.amazonaws.bedrock#GuardrailWords", "traits": { - "smithy.api#documentation": "The desired number of model units that was requested to be available for this provisioned throughput.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of words configured for the guardrail.
" } }, - "provisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", + "managedWordLists": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordLists", "traits": { - "smithy.api#documentation": "The name of the provisioned throughput.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of managed words configured for the guardrail.
" } - }, - "provisionedModelArn": { - "target": "com.amazonaws.bedrock#ProvisionedModelArn", + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the word policy configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailWordPolicyConfig": { + "type": "structure", + "members": { + "wordsConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordsConfig", "traits": { - "smithy.api#documentation": "The ARN of the provisioned throughput.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of words to configure for the guardrail.
" } }, - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "managedWordListsConfig": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordListsConfig", "traits": { - "smithy.api#documentation": "The ARN or name of the model associated with this provisioned throughput.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of managed words to configure for the guardrail.
" } - }, - "desiredModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the word policy to configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailWords": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailWord" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.bedrock#GuardrailWordsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailWordConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.bedrock#GuardrailsResource": { + "type": "resource", + "identifiers": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrock#CreateGuardrail" + }, + "read": { + "target": "com.amazonaws.bedrock#GetGuardrail" + }, + "update": { + "target": "com.amazonaws.bedrock#UpdateGuardrail" + }, + "delete": { + "target": "com.amazonaws.bedrock#DeleteGuardrail" + }, + "list": { + "target": "com.amazonaws.bedrock#ListGuardrails" + }, + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateGuardrailVersion" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Guardrail" + } + } + }, + "com.amazonaws.bedrock#HumanEvaluationConfig": { + "type": "structure", + "members": { + "humanWorkflowConfig": { + "target": "com.amazonaws.bedrock#HumanWorkflowConfig", "traits": { - "smithy.api#documentation": "The ARN of the new model to asssociate with this provisioned throughput.
", - "smithy.api#required": {} + "smithy.api#documentation": "The parameters of the human workflow.
" } }, - "foundationModelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "customMetrics": { + "target": "com.amazonaws.bedrock#HumanEvaluationCustomMetrics", "traits": { - "smithy.api#documentation": "ARN of the foundation model.
", - "smithy.api#required": {} + "smithy.api#documentation": "A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.
Status of the provisioned throughput.
", + "smithy.api#documentation": "Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.
", "smithy.api#required": {} } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + } + }, + "traits": { + "smithy.api#documentation": "Specifies the custom metrics, how tasks will be rated, the flow definition ARN, and your custom prompt datasets. Model evaluation jobs use human workers only support the use of custom prompt datasets. To learn more about custom prompt datasets and the required format, see Custom prompt datasets.
\nWhen you create custom metrics in HumanEvaluationCustomMetric you must specify the metric's name. The list of names specified in the HumanEvaluationCustomMetric array, must match the metricNames array of strings specified in EvaluationDatasetMetricConfig. For example, if in the HumanEvaluationCustomMetric array your specified the names \"accuracy\", \"toxicity\", \"readability\" as custom metrics then the metricNames array would need to look like the following [\"accuracy\", \"toxicity\", \"readability\"] in EvaluationDatasetMetricConfig.
The timestamp of the creation time for this provisioned throughput.
", + "smithy.api#documentation": "The name of the metric. Your human evaluators will see this name in the evaluation UI.
", "smithy.api#required": {} } }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "description": { + "target": "com.amazonaws.bedrock#EvaluationMetricDescription", "traits": { - "smithy.api#documentation": "The timestamp of the last modified time of this provisioned throughput.
", - "smithy.api#required": {} + "smithy.api#documentation": "An optional description of the metric. Use this parameter to provide more details about the metric.
" } }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", + "ratingMethod": { + "target": "com.amazonaws.bedrock#EvaluationRatingMethod", "traits": { - "smithy.api#documentation": "Failure message for any issues that the create operation encounters.
" + "smithy.api#documentation": "Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank\n
In a model evaluation job that uses human workers you must\n define the name of the metric, and how you want that metric rated\n ratingMethod, and an optional description of the metric.
Commitment duration of the provisioned throughput.
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) for the flow definition
", + "smithy.api#required": {} } }, - "commitmentExpirationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "instructions": { + "target": "com.amazonaws.bedrock#HumanTaskInstructions", "traits": { - "smithy.api#documentation": "Commitment expiration time for the provisioned throughput.
" + "smithy.api#documentation": "Instructions for the flow definition
" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Contains SageMakerFlowDefinition object. The object is used to specify the prompt dataset, task type, rating method and metric names.
Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
For more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2302,24 +4907,146 @@ "smithy.api#httpQuery": "nameContains" } }, - "baseModelArnEquals": { - "target": "com.amazonaws.bedrock#ModelArn", + "baseModelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
", + "smithy.api#httpQuery": "baseModelArnEquals" + } + }, + "foundationModelArnEquals": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
", + "smithy.api#httpQuery": "foundationModelArnEquals" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "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 Amazon Bedrock to list the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortModelsBy", + "traits": { + "smithy.api#documentation": "The field to sort by in the returned list of models.
", + "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#ListCustomModelsResponse": { + "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.
" + } + }, + "modelSummaries": { + "target": "com.amazonaws.bedrock#CustomModelSummaryList", + "traits": { + "smithy.api#documentation": "Model summaries.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListEvaluationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListEvaluationJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListEvaluationJobsResponse" + }, + "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": "Lists model evaluation jobs.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/evaluation-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListEvaluationJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that includes model evaluation jobs created after the time specified.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that includes model evaluation jobs created prior to the time specified.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", "traits": { - "smithy.api#documentation": "Return custom models only if the base model ARN matches this parameter.
", - "smithy.api#httpQuery": "baseModelArnEquals" + "smithy.api#documentation": "Only return jobs where the status condition is met.
", + "smithy.api#httpQuery": "statusEquals" } }, - "foundationModelArnEquals": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "nameContains": { + "target": "com.amazonaws.bedrock#EvaluationJobName", "traits": { - "smithy.api#documentation": "Return custom models only if the foundation model ARN matches this parameter.
", - "smithy.api#httpQuery": "foundationModelArnEquals" + "smithy.api#documentation": "Query parameter string for model evaluation job names.
", + "smithy.api#httpQuery": "nameContains" } }, "maxResults": { "target": "com.amazonaws.bedrock#MaxResults", "traits": { - "smithy.api#documentation": "Maximum number of results to return in the response.
", + "smithy.api#documentation": "The maximum number of results to return.
", "smithy.api#httpQuery": "maxResults" } }, @@ -2331,16 +5058,16 @@ } }, "sortBy": { - "target": "com.amazonaws.bedrock#SortModelsBy", + "target": "com.amazonaws.bedrock#SortJobsBy", "traits": { - "smithy.api#documentation": "The field to sort by in the returned list of models.
", + "smithy.api#documentation": "Allows you to sort model evaluation jobs by when they were created.
", "smithy.api#httpQuery": "sortBy" } }, "sortOrder": { "target": "com.amazonaws.bedrock#SortOrder", "traits": { - "smithy.api#documentation": "The sort order of the results.
", + "smithy.api#documentation": "How you want the order of jobs sorted.
", "smithy.api#httpQuery": "sortOrder" } } @@ -2349,19 +5076,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#ListCustomModelsResponse": { + "com.amazonaws.bedrock#ListEvaluationJobsResponse": { "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.
" + "smithy.api#documentation": "Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
" } }, - "modelSummaries": { - "target": "com.amazonaws.bedrock#CustomModelSummaryList", + "jobSummaries": { + "target": "com.amazonaws.bedrock#EvaluationSummaries", "traits": { - "smithy.api#documentation": "Model summaries.
" + "smithy.api#documentation": "A summary of the model evaluation jobs.
" } } }, @@ -2392,7 +5119,7 @@ } ], "traits": { - "smithy.api#documentation": "List of Amazon Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.
", + "smithy.api#documentation": "Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2407,28 +5134,28 @@ "byProvider": { "target": "com.amazonaws.bedrock#Provider", "traits": { - "smithy.api#documentation": "A Amazon Bedrock model provider.
", + "smithy.api#documentation": "Return models belonging to the model provider that you specify.
", "smithy.api#httpQuery": "byProvider" } }, "byCustomizationType": { "target": "com.amazonaws.bedrock#ModelCustomization", "traits": { - "smithy.api#documentation": "List by customization type.
", + "smithy.api#documentation": "Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#httpQuery": "byCustomizationType" } }, "byOutputModality": { "target": "com.amazonaws.bedrock#ModelModality", "traits": { - "smithy.api#documentation": "List by output modality type.
", + "smithy.api#documentation": "Return models that support the output modality that you specify.
", "smithy.api#httpQuery": "byOutputModality" } }, "byInferenceType": { "target": "com.amazonaws.bedrock#InferenceType", "traits": { - "smithy.api#documentation": "List by inference type.
", + "smithy.api#documentation": "Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#httpQuery": "byInferenceType" } } @@ -2451,6 +5178,97 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#ListGuardrails": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListGuardrailsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListGuardrailsResponse" + }, + "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": "Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field.
You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
The unique identifier of the guardrail.
", + "smithy.api#httpQuery": "guardrailIdentifier" + } + }, + "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": "If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
A list of objects, each of which contains details about a guardrail.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
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 Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2596,7 +5414,7 @@ } ], "traits": { - "smithy.api#documentation": "List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#documentation": "Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2617,56 +5435,56 @@ "creationTimeAfter": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "Return provisioned capacities created after the specified time.
", + "smithy.api#documentation": "A filter that returns Provisioned Throughputs 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#documentation": "A filter that returns Provisioned Throughputs 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#documentation": "A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.
", "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#documentation": "A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.
", "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#documentation": "A filter that returns Provisioned Throughputs if their name contains the expression that you specify.
", "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#documentation": "THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a nextToken\n value. To see the next batch of results, send the nextToken value in another list request.
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
", + "smithy.api#documentation": "If there are more results than the number you specified in the maxResults field, the response returns a nextToken\n value. To see the next batch of results, specify the nextToken value in this field.
The field to sort by in the returned list of provisioned capacities.
", + "smithy.api#documentation": "The field by which to sort the returned list of Provisioned Throughputs.
", "smithy.api#httpQuery": "sortBy" } }, @@ -2688,13 +5506,13 @@ "nextToken": { "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "Continuation token for the next request to list the next set of results.
" + "smithy.api#documentation": "If there are more results than the number you specified in the maxResults field, this value is returned. To see the next batch of results, include this value in the nextToken field in another list request.
List of summaries, one for each provisioned throughput in the response.
" + "smithy.api#documentation": "A list of summaries, one for each Provisioned Throughput in the response.
" } } }, @@ -2728,7 +5546,7 @@ } ], "traits": { - "smithy.api#documentation": "List the tags associated with the specified resource.
\nFor more information, see Tagging resources in the Bedrock User Guide.
", + "smithy.api#documentation": "List the tags associated with the specified resource.
\nFor more information, see Tagging resources in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -2742,7 +5560,7 @@ "resourceARN": { "target": "com.amazonaws.bedrock#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } } @@ -2809,7 +5627,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration fields for invokation logging.
" + "smithy.api#documentation": "Configuration fields for invocation logging.
" } }, "com.amazonaws.bedrock#LoggingResource": { @@ -2939,14 +5757,14 @@ "jobArn": { "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", "traits": { - "smithy.api#documentation": "ARN of the customization job.
", + "smithy.api#documentation": "Amazon Resource Name (ARN) of the customization job.
", "smithy.api#required": {} } }, "baseModelArn": { "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "ARN of the base model.
", + "smithy.api#documentation": "Amazon Resource Name (ARN) of the base model.
", "smithy.api#required": {} } }, @@ -2986,7 +5804,7 @@ "customModelArn": { "target": "com.amazonaws.bedrock#CustomModelArn", "traits": { - "smithy.api#documentation": "ARN of the custom model.
" + "smithy.api#documentation": "Amazon Resource Name (ARN) of the custom model.
" } }, "customModelName": { @@ -3189,88 +6007,88 @@ "provisionedModelName": { "target": "com.amazonaws.bedrock#ProvisionedModelName", "traits": { - "smithy.api#documentation": "The name of the provisioned throughput.
", + "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#documentation": "The Amazon Resource Name (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#documentation": "The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.
", "smithy.api#required": {} } }, "desiredModelArn": { "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "Desired model ARN.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.
Foundation model ARN.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
", "smithy.api#required": {} } }, "modelUnits": { "target": "com.amazonaws.bedrock#PositiveInteger", "traits": { - "smithy.api#documentation": "The number of model units allocated.
", + "smithy.api#documentation": "The number of model units allocated to the Provisioned Throughput.
", "smithy.api#required": {} } }, "desiredModelUnits": { "target": "com.amazonaws.bedrock#PositiveInteger", "traits": { - "smithy.api#documentation": "Desired model units.
", + "smithy.api#documentation": "The number of model units that was requested to be allocated to the Provisioned Throughput.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrock#ProvisionedModelStatus", "traits": { - "smithy.api#documentation": "Status of the provisioned throughput.
", + "smithy.api#documentation": "The status of the Provisioned Throughput.
", "smithy.api#required": {} } }, "commitmentDuration": { "target": "com.amazonaws.bedrock#CommitmentDuration", "traits": { - "smithy.api#documentation": "Commitment duration for the provisioned throughput.
" + "smithy.api#documentation": "The duration for which the Provisioned Throughput was committed.
" } }, "commitmentExpirationTime": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "Commitment expiration time for the provisioned throughput.
" + "smithy.api#documentation": "The timestamp for when the commitment term of the Provisioned Throughput expires.
" } }, "creationTime": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "The time that this provisioned throughput was created.
", + "smithy.api#documentation": "The time that the 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#documentation": "The time that the Provisioned Throughput was last modified.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Set of fields associated with a provisioned throughput.
" + "smithy.api#documentation": "A summary of information about a Provisioned Throughput.
\nThis data type is used in the following API operations:
\nThe specified resource ARN was not found. Check the ARN and try your request again.
", + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3400,6 +6218,15 @@ "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" } }, + "com.amazonaws.bedrock#SageMakerFlowDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:flow-definition/.*$" + } + }, "com.amazonaws.bedrock#SecurityGroupId": { "type": "string", "traits": { @@ -3484,6 +6311,66 @@ } } }, + "com.amazonaws.bedrock#StopEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopEvaluationJobResponse" + }, + "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": "Stops an in progress model evaluation job.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/evaluation-job/{jobIdentifier}/stop" + } + } + }, + "com.amazonaws.bedrock#StopEvaluationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the model evaluation job you want to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#StopEvaluationJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#StopModelCustomizationJob": { "type": "operation", "input": { @@ -3513,7 +6400,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops an active model customization job. For more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -3654,7 +6541,7 @@ } ], "traits": { - "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Bedrock User Guide.
", + "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -3668,7 +6555,7 @@ "resourceARN": { "target": "com.amazonaws.bedrock#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "The ARN of the resource to tag.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", "smithy.api#required": {} } }, @@ -3708,7 +6595,7 @@ "min": 20, "max": 1011 }, - "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}$)))" + "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}$)|(:guardrail/[a-z0-9]+$)|(:evaluation-job/[a-z0-9]{12}$)))" } }, "com.amazonaws.bedrock#TaggingResource": { @@ -3758,7 +6645,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 } @@ -3835,7 +6722,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove one or more tags from a resource. For more information, see Tagging resources in the Bedrock User Guide.
", + "smithy.api#documentation": "Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -3849,7 +6736,7 @@ "resourceARN": { "target": "com.amazonaws.bedrock#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "The ARN of the resource to untag.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to untag.
", "smithy.api#required": {} } }, @@ -3872,6 +6759,156 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#UpdateGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateGuardrailResponse" + }, + "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#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a guardrail with the values you specify.
\nSpecify a name and optional description.
Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.
Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic.
Give a name and description so that the guardrail can properly identify the topic.
Specify DENY in the type field.
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list.
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.
Specify the category in the type field.
Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig.
(Optional) For security, include the ARN of a KMS key in the kmsKeyId field.
(Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources.
The unique identifier of the guardrail
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", + "traits": { + "smithy.api#documentation": "A name for the guardrail.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "A description of the guardrail.
" + } + }, + "topicPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", + "traits": { + "smithy.api#documentation": "The topic policy to configure for the guardrail.
" + } + }, + "contentPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", + "traits": { + "smithy.api#documentation": "The content policy to configure for the guardrail.
" + } + }, + "wordPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", + "traits": { + "smithy.api#documentation": "The word policy to configure for the guardrail.
" + } + }, + "sensitiveInformationPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", + "traits": { + "smithy.api#documentation": "The sensitive information policy to configure for the guardrail.
" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "The message to return when the guardrail blocks a prompt.
", + "smithy.api#required": {} + } + }, + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "The message to return when the guardrail blocks a model response.
", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key with which to encrypt the guardrail.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateGuardrailResponse": { + "type": "structure", + "members": { + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail
", + "smithy.api#required": {} + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "The ARN of the guardrail that was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailDraftVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the guardrail was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#UpdateProvisionedModelThroughput": { "type": "operation", "input": { @@ -3898,7 +6935,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#documentation": "Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -3913,7 +6950,7 @@ "provisionedModelId": { "target": "com.amazonaws.bedrock#ProvisionedModelId", "traits": { - "smithy.api#documentation": "The ARN or name of the provisioned throughput to update.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3921,13 +6958,13 @@ "desiredProvisionedModelName": { "target": "com.amazonaws.bedrock#ProvisionedModelName", "traits": { - "smithy.api#documentation": "The new name for this provisioned throughput.
" + "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.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model.
\nIf this Provisioned Throughput is associated with a custom model, you can specify one of the following options:
\nThe base model from which the custom model was customized.
\nAnother custom model that was customized from the same base model as the custom model.
\nUpdates one or more phone numbers.
", + "smithy.api#documentation": "Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each \n UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name.\n
You cannot have a duplicate phoneNumberId in a request.
Gets the Alexa Skill configuration for the SIP media application.
", + "smithy.api#deprecated": { + "message": "Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties)." + }, + "smithy.api#documentation": "Gets the Alexa Skill configuration for the SIP media application.
\nDue to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to \n the Alexa Smart Properties page.
\nUpdates the Alexa Skill configuration for the SIP media application.
", + "smithy.api#deprecated": { + "message": "Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties)." + }, + "smithy.api#documentation": "Updates the Alexa Skill configuration for the SIP media application.
\nDue to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to \n the Alexa Smart Properties page.
\nThe Alexa Skill configuration of a SIP media application.
" + "smithy.api#documentation": "The Alexa Skill configuration of a SIP media application.
\nDue to changes made by the Amazon Alexa service, this data type is no longer available for use. For more information, refer to \n the Alexa Smart Properties page.
\nUpdates phone number details, such as product type or calling name, for the \n specified phone number ID. You can update one phone number detail at a time. For \n example, you can update either the product type or the calling name in one action.
\nFor numbers outside the U.S., you must use the Amazon Chime SDK SIP Media \n Application Dial-In product type.
\nUpdates to outbound calling names can take 72 hours to complete. Pending \n updates to outbound calling names must be complete before you can request another \n update.
", + "smithy.api#documentation": "Updates phone number details, such as product type, calling name, or phone number name for the \n specified phone number ID. You can update one phone number detail at a time. For \n example, you can update either the product type, calling name, or phone number name in one action.
\nFor numbers outside the U.S., you must use the Amazon Chime SDK SIP Media \n Application Dial-In product type.
\nUpdates to outbound calling names can take 72 hours to complete. Pending \n updates to outbound calling names must be complete before you can request another \n update.
", "smithy.api#http": { "method": "POST", "uri": "/phone-numbers/{PhoneNumberId}", @@ -9786,7 +9792,7 @@ "Name": { "target": "com.amazonaws.chimesdkvoice#PhoneNumberName", "traits": { - "smithy.api#documentation": "Specifies the name assigned to one or more phone numbers.
" + "smithy.api#documentation": "Specifies the updated name assigned to one or more phone numbers.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/cloudwatch-events.2015-10-07.json b/codegen/sdk-codegen/aws-models/cloudwatch-events.2015-10-07.json index b61dcd6823a..cf5ec1f77b0 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch-events.2015-10-07.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch-events.2015-10-07.json @@ -192,7 +192,7 @@ "sdkId": "CloudWatch Events", "arnNamespace": "events", "cloudFormationName": "Events", - "cloudTrailEventSource": "cloudwatchevents.amazonaws.com", + "cloudTrailEventSource": "events.amazonaws.com", "docId": "events-2015-10-07", "endpointPrefix": "events" }, diff --git a/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json b/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json index 4eaf79a5845..117775a7436 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json @@ -5328,7 +5328,7 @@ "sdkId": "CloudWatch Logs", "arnNamespace": "logs", "cloudFormationName": "Logs", - "cloudTrailEventSource": "cloudwatchlogs.amazonaws.com", + "cloudTrailEventSource": "logs.amazonaws.com", "docId": "logs-2014-03-28", "endpointPrefix": "logs" }, diff --git a/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json b/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json index 55af8455504..221f8f47260 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json @@ -2594,7 +2594,7 @@ "sdkId": "CloudWatch", "arnNamespace": "monitoring", "cloudFormationName": "CloudWatch", - "cloudTrailEventSource": "cloudwatch.amazonaws.com", + "cloudTrailEventSource": "monitoring.amazonaws.com", "docId": "monitoring-2010-08-01", "endpointPrefix": "monitoring" }, diff --git a/codegen/sdk-codegen/aws-models/codeartifact.2018-09-22.json b/codegen/sdk-codegen/aws-models/codeartifact.2018-09-22.json index 3aef470d06a..5149e07c29e 100644 --- a/codegen/sdk-codegen/aws-models/codeartifact.2018-09-22.json +++ b/codegen/sdk-codegen/aws-models/codeartifact.2018-09-22.json @@ -262,7 +262,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "The namespace of the associated package. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the associated package. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nCodeArtifact is a fully managed artifact repository compatible with language-native\n package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to\n share packages with development teams and pull packages. Packages can be pulled from both\n public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact\n repository and another repository, which effectively merges their contents from the point of\n view of a package manager client.
\n\n CodeArtifact concepts\n
\n\n Repository: A CodeArtifact repository contains a set of package\n versions, each of which maps to a set of assets, or files. Repositories are\n polyglot, so a single repository can contain packages of any supported type. Each\n repository exposes endpoints for fetching and publishing packages using tools like the\n \n npm\n CLI, the Maven CLI (\n mvn\n ), Python CLIs (\n pip\n and twine), NuGet CLIs (nuget and dotnet), and \n the Swift package manager (\n swift\n ).
\n Domain: Repositories are aggregated into a higher-level entity known as a\n domain. All package assets and metadata are stored in the domain,\n but are consumed through repositories. A given package asset, such as a Maven JAR file, is\n stored once per domain, no matter how many repositories it's present in. All of the assets\n and metadata in a domain are encrypted with the same customer master key (CMK) stored in\n Key Management Service (KMS).
\nEach repository is a member of a single domain and can't be moved to a\n different domain.
\nThe domain allows organizational policy to be applied across multiple\n repositories, such as which accounts can access repositories in the domain, and\n which public repositories can be used as sources of packages.
\nAlthough an organization can have multiple domains, we recommend a single production\n domain that contains all published artifacts so that teams can find and share packages\n across their organization.
\n\n Package: A package is a bundle of software and the metadata required to\n resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, and generic package formats.
\nIn CodeArtifact, a package consists of:
\nA name (for example, webpack is the name of a\n popular npm package)
An optional namespace (for example, @types in @types/node)
A set of versions (for example, 1.0.0, 1.0.1,\n 1.0.2, etc.)
Package-level metadata (for example, npm tags)
\n\n Package group: A group of packages that match a specified definition. Package \n groups can be used to apply configuration to multiple packages that match a defined pattern using \n package format, package namespace, and package name. You can use package groups to more conveniently \n configure package origin controls for multiple packages. Package origin controls are used to block or allow ingestion or publishing \n of new package versions, which protects users from malicious actions known as dependency substitution attacks.
\n\n Package version: A version of a package, such as @types/node 12.6.9. The version number\n format and semantics vary for different package formats. For example, npm package versions\n must conform to the Semantic Versioning\n specification. In CodeArtifact, a package version consists of the version identifier,\n metadata at the package version level, and a set of assets.
\n Upstream repository: One repository is upstream of another when the package versions in\n it can be accessed from the repository endpoint of the downstream repository, effectively\n merging the contents of the two repositories from the point of view of a client. CodeArtifact\n allows creating an upstream relationship between two repositories.
\n\n Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm\n .tgz file or Maven POM and JAR files.
\n CodeArtifact supported API operations\n
\n\n AssociateExternalConnection: Adds an existing external \n connection to a repository.\n
\n CopyPackageVersions: Copies package versions from one \n repository to another repository in the same domain.
\n CreateDomain: Creates a domain.
\n CreatePackageGroup: Creates a package group.
\n CreateRepository: Creates a CodeArtifact repository in a domain.
\n DeleteDomain: Deletes a domain. You cannot delete a domain that contains\n repositories.
\n DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.
\n DeletePackage: Deletes a package and all associated package versions.
\n DeletePackageGroup: Deletes a package group. Does not delete packages or package versions that are associated with a package group.
\n DeletePackageVersions: Deletes versions of a package. After a package has\n been deleted, it can be republished, but its assets and metadata cannot be restored\n because they have been permanently removed from storage.
\n DeleteRepository: Deletes a repository. \n
\n DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.
\n DescribeDomain: Returns a DomainDescription object that\n contains information about the requested domain.
\n DescribePackage: Returns a PackageDescription\n object that contains details about a package.
\n DescribePackageGroup: Returns a PackageGroup\n object that contains details about a package group.
\n DescribePackageVersion: Returns a PackageVersionDescription\n object that contains details about a package version.
\n DescribeRepository: Returns a RepositoryDescription object\n that contains detailed information about the requested repository.
\n DisposePackageVersions: Disposes versions of a package. A package version\n with the status Disposed cannot be restored because they have been\n permanently removed from storage.
\n DisassociateExternalConnection: Removes an existing external connection from a repository. \n
\n GetAssociatedPackageGroup: Returns the most closely associated package group to the specified package.
\n GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. \n The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.
\n GetDomainPermissionsPolicy: Returns the policy of a resource\n that is attached to the specified domain.
\n GetPackageVersionAsset: Returns the contents of an asset that is in a package version.
\n GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.
\n GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n
\n generic\n
\n maven\n
\n npm\n
\n nuget\n
\n pypi\n
\n swift\n
\n GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository. \n
\n ListAllowedRepositoriesForGroup: Lists the allowed repositories for a package group that has origin configuration set to ALLOW_SPECIFIC_REPOSITORIES.
\n ListAssociatedPackages: Returns a list of packages associated with the requested package group.
\n ListDomains: Returns a list of DomainSummary objects. Each\n returned DomainSummary object contains information about a domain.
\n ListPackages: Lists the packages in a repository.
\n ListPackageGroups: Returns a list of package groups in the requested domain.
\n ListPackageVersionAssets: Lists the assets for a given package version.
\n ListPackageVersionDependencies: Returns a list of the direct dependencies for a\n package version.
\n ListPackageVersions: Returns a list of package versions for a specified\n package in a repository.
\n ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.
\n ListRepositoriesInDomain: Returns a list of the repositories in a domain.
\n ListSubPackageGroups: Returns a list of direct children of the specified package group.
\n PublishPackageVersion: Creates a new package version containing one or more assets.
\n PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
\n PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine \n how new versions of the package can be added to a specific repository.
\n PutRepositoryPermissionsPolicy: Sets the resource policy on a repository\n that specifies permissions to access it.
\n UpdatePackageGroup: Updates a package group. This API cannot be used to update a package group's origin configuration or pattern.
\n UpdatePackageGroupOriginConfiguration: Updates the package origin configuration for a package group.
\n UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
\n UpdateRepository: Updates the properties of a repository.
CodeArtifact is a fully managed artifact repository compatible with language-native\n package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to\n share packages with development teams and pull packages. Packages can be pulled from both\n public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact\n repository and another repository, which effectively merges their contents from the point of\n view of a package manager client.
\n\n CodeArtifact concepts\n
\n\n Repository: A CodeArtifact repository contains a set of package\n versions, each of which maps to a set of assets, or files. Repositories are\n polyglot, so a single repository can contain packages of any supported type. Each\n repository exposes endpoints for fetching and publishing packages using tools such as the \n npm\n CLI or the Maven CLI (\n mvn\n ). For a list of supported package managers, see the \n CodeArtifact User Guide.
\n Domain: Repositories are aggregated into a higher-level entity known as a\n domain. All package assets and metadata are stored in the domain,\n but are consumed through repositories. A given package asset, such as a Maven JAR file, is\n stored once per domain, no matter how many repositories it's present in. All of the assets\n and metadata in a domain are encrypted with the same customer master key (CMK) stored in\n Key Management Service (KMS).
\nEach repository is a member of a single domain and can't be moved to a\n different domain.
\nThe domain allows organizational policy to be applied across multiple\n repositories, such as which accounts can access repositories in the domain, and\n which public repositories can be used as sources of packages.
\nAlthough an organization can have multiple domains, we recommend a single production\n domain that contains all published artifacts so that teams can find and share packages\n across their organization.
\n\n Package: A package is a bundle of software and the metadata required to\n resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, Ruby, and generic package formats. \n For more information about the supported package formats and how to use CodeArtifact with them, see the \n CodeArtifact User Guide.
\nIn CodeArtifact, a package consists of:
\nA name (for example, webpack is the name of a\n popular npm package)
An optional namespace (for example, @types in @types/node)
A set of versions (for example, 1.0.0, 1.0.1,\n 1.0.2, etc.)
Package-level metadata (for example, npm tags)
\n\n Package group: A group of packages that match a specified definition. Package \n groups can be used to apply configuration to multiple packages that match a defined pattern using \n package format, package namespace, and package name. You can use package groups to more conveniently \n configure package origin controls for multiple packages. Package origin controls are used to block or allow ingestion or publishing \n of new package versions, which protects users from malicious actions known as dependency substitution attacks.
\n\n Package version: A version of a package, such as @types/node 12.6.9. The version number\n format and semantics vary for different package formats. For example, npm package versions\n must conform to the Semantic Versioning\n specification. In CodeArtifact, a package version consists of the version identifier,\n metadata at the package version level, and a set of assets.
\n Upstream repository: One repository is upstream of another when the package versions in\n it can be accessed from the repository endpoint of the downstream repository, effectively\n merging the contents of the two repositories from the point of view of a client. CodeArtifact\n allows creating an upstream relationship between two repositories.
\n\n Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm\n .tgz file or Maven POM and JAR files.
\n CodeArtifact supported API operations\n
\n\n AssociateExternalConnection: Adds an existing external \n connection to a repository.\n
\n CopyPackageVersions: Copies package versions from one \n repository to another repository in the same domain.
\n CreateDomain: Creates a domain.
\n CreatePackageGroup: Creates a package group.
\n CreateRepository: Creates a CodeArtifact repository in a domain.
\n DeleteDomain: Deletes a domain. You cannot delete a domain that contains\n repositories.
\n DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.
\n DeletePackage: Deletes a package and all associated package versions.
\n DeletePackageGroup: Deletes a package group. Does not delete packages or package versions that are associated with a package group.
\n DeletePackageVersions: Deletes versions of a package. After a package has\n been deleted, it can be republished, but its assets and metadata cannot be restored\n because they have been permanently removed from storage.
\n DeleteRepository: Deletes a repository. \n
\n DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.
\n DescribeDomain: Returns a DomainDescription object that\n contains information about the requested domain.
\n DescribePackage: Returns a PackageDescription\n object that contains details about a package.
\n DescribePackageGroup: Returns a PackageGroup\n object that contains details about a package group.
\n DescribePackageVersion: Returns a PackageVersionDescription\n object that contains details about a package version.
\n DescribeRepository: Returns a RepositoryDescription object\n that contains detailed information about the requested repository.
\n DisposePackageVersions: Disposes versions of a package. A package version\n with the status Disposed cannot be restored because they have been\n permanently removed from storage.
\n DisassociateExternalConnection: Removes an existing external connection from a repository. \n
\n GetAssociatedPackageGroup: Returns the most closely associated package group to the specified package.
\n GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. \n The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.
\n GetDomainPermissionsPolicy: Returns the policy of a resource\n that is attached to the specified domain.
\n GetPackageVersionAsset: Returns the contents of an asset that is in a package version.
\n GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.
\n GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n
\n generic\n
\n maven\n
\n npm\n
\n nuget\n
\n pypi\n
\n ruby\n
\n swift\n
\n GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository. \n
\n ListAllowedRepositoriesForGroup: Lists the allowed repositories for a package group that has origin configuration set to ALLOW_SPECIFIC_REPOSITORIES.
\n ListAssociatedPackages: Returns a list of packages associated with the requested package group.
\n ListDomains: Returns a list of DomainSummary objects. Each\n returned DomainSummary object contains information about a domain.
\n ListPackages: Lists the packages in a repository.
\n ListPackageGroups: Returns a list of package groups in the requested domain.
\n ListPackageVersionAssets: Lists the assets for a given package version.
\n ListPackageVersionDependencies: Returns a list of the direct dependencies for a\n package version.
\n ListPackageVersions: Returns a list of package versions for a specified\n package in a repository.
\n ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.
\n ListRepositoriesInDomain: Returns a list of the repositories in a domain.
\n ListSubPackageGroups: Returns a list of direct children of the specified package group.
\n PublishPackageVersion: Creates a new package version containing one or more assets.
\n PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
\n PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine \n how new versions of the package can be added to a specific repository.
\n PutRepositoryPermissionsPolicy: Sets the resource policy on a repository\n that specifies permissions to access it.
\n UpdatePackageGroup: Updates a package group. This API cannot be used to update a package group's origin configuration or pattern.
\n UpdatePackageGroupOriginConfiguration: Updates the package origin configuration for a package group.
\n UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
\n UpdateRepository: Updates the properties of a repository.
The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:
\nThe namespace is required when copying package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:
\nThe namespace is required when copying package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:
\nThe namespace is required when deleting packages of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:
\nThe namespace is required when deleting packages of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:
\nThe namespace is required when deleting package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:
\nThe namespace is required when deleting package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the requested package. The package component that specifies its namespace depends on its type. For example:
\nThe namespace is required when requesting packages of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the requested package. The package component that specifies its namespace depends on its type. For example:
\nThe namespace is required when requesting packages of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the requested package version. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when requesting package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the requested package version. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when requesting package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package versions to be disposed. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when disposing package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package versions to be disposed. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when disposing package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package from which to get the associated package group. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when getting associated package groups from packages of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package from which to get the associated package group. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when getting associated package groups from packages of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version with the requested asset file. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when requesting assets from package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version with the requested asset file. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when requesting assets from package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version with the requested readme file. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when requesting the readme from package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version with the requested readme file. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when requesting the readme from package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version with the requested readme file. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version with the requested readme file. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n
\n\n generic\n
\n maven\n
\n npm\n
\n nuget\n
\n pypi\n
\n swift\n
\n Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n
\n\n generic\n
\n maven\n
\n npm\n
\n nuget\n
\n pypi\n
\n ruby\n
\n swift\n
The namespace of the package version that contains the requested package version assets. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required requesting assets from package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version that contains the requested package version assets. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required requesting assets from package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version that contains the requested package version assets. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version that contains the requested package version assets. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version with the requested dependencies. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when listing dependencies from package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version with the requested dependencies. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when listing dependencies from package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version that contains the returned dependencies. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version that contains the returned dependencies. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when deleting package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:
\nThe namespace is required when deleting package versions of the following formats:
\nMaven
\nSwift
\ngeneric
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace prefix used to filter requested packages. \n Only packages with a namespace that starts with the provided string value are returned. \n Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.
Each package format uses namespace as follows:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace prefix used to filter requested packages. \n Only packages with a namespace that starts with the provided string value are returned. \n Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.
Each package format uses namespace as follows:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package that this package depends on. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package that this package depends on. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package to be updated. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package to be updated. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version to be updated. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe namespace of the package version to be updated. The package component that specifies its \n namespace depends on its type. For example:
\n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm or Swift package version is its scope.\n
The namespace of a generic package is its namespace.
\n Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nThe interaction or event that started a pipeline execution.
" } }, + "com.amazonaws.codepipeline#ExecutionType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK" + } + } + } + }, "com.amazonaws.codepipeline#ExecutorConfiguration": { "type": "structure", "members": { @@ -3627,6 +3647,20 @@ "com.amazonaws.codepipeline#ExternalExecutionSummary": { "type": "string" }, + "com.amazonaws.codepipeline#FailureConditions": { + "type": "structure", + "members": { + "result": { + "target": "com.amazonaws.codepipeline#Result", + "traits": { + "smithy.api#documentation": "The specified result for when the failure conditions are met, such as rolling back the stage.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that specifies the result, such as rollback, to occur upon stage failure.
" + } + }, "com.amazonaws.codepipeline#FailureDetails": { "type": "structure", "members": { @@ -5072,6 +5106,12 @@ "smithy.api#documentation": "The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. Pipeline history is\n limited to the most recent 12 months, based on pipeline execution start times. Default\n value is 100.
" } }, + "filter": { + "target": "com.amazonaws.codepipeline#PipelineExecutionFilter", + "traits": { + "smithy.api#documentation": "The pipeline execution to filter on.
" + } + }, "nextToken": { "target": "com.amazonaws.codepipeline#NextToken", "traits": { @@ -5715,12 +5755,38 @@ "traits": { "smithy.api#documentation": "The method that the pipeline will use to handle multiple executions. The default\n mode is SUPERSEDED.
" } + }, + "executionType": { + "target": "com.amazonaws.codepipeline#ExecutionType", + "traits": { + "smithy.api#documentation": "The type of the pipeline execution.
" + } + }, + "rollbackMetadata": { + "target": "com.amazonaws.codepipeline#PipelineRollbackMetadata", + "traits": { + "smithy.api#documentation": "The metadata about the execution pertaining to stage rollback.
" + } } }, "traits": { "smithy.api#documentation": "Represents information about an execution of a pipeline.
" } }, + "com.amazonaws.codepipeline#PipelineExecutionFilter": { + "type": "structure", + "members": { + "succeededInStage": { + "target": "com.amazonaws.codepipeline#SucceededInStageFilter", + "traits": { + "smithy.api#documentation": "Filter for pipeline executions where the stage was successful in the current pipeline\n version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The pipeline execution to filter on.
" + } + }, "com.amazonaws.codepipeline#PipelineExecutionId": { "type": "string", "traits": { @@ -5754,6 +5820,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.codepipeline#PipelineExecutionOutdatedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codepipeline#Message" + } + }, + "traits": { + "smithy.api#documentation": "The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.codepipeline#PipelineExecutionStatus": { "type": "enum", "members": { @@ -5819,6 +5897,12 @@ "smithy.api#documentation": "The status of the pipeline execution.
\nInProgress: The pipeline execution is currently running.
\nStopped: The pipeline execution was manually stopped. For more information,\n see Stopped Executions.
\nStopping: The pipeline execution received a request to be manually stopped.\n Depending on the selected stop mode, the execution is either completing or\n abandoning in-progress actions. For more information, see Stopped Executions.
\nSucceeded: The pipeline execution was completed successfully.
\nSuperseded: While this pipeline execution was waiting for the next stage to\n be completed, a newer pipeline execution advanced and continued through the\n pipeline instead. For more information, see Superseded Executions.
\nFailed: The pipeline execution was not completed successfully.
\nStatus summary for the pipeline.
" + } + }, "startTime": { "target": "com.amazonaws.codepipeline#Timestamp", "traits": { @@ -5854,6 +5938,18 @@ "traits": { "smithy.api#documentation": "The method that the pipeline will use to handle multiple executions. The default\n mode is SUPERSEDED.
" } + }, + "executionType": { + "target": "com.amazonaws.codepipeline#ExecutionType", + "traits": { + "smithy.api#documentation": "Type of the pipeline execution.
" + } + }, + "rollbackMetadata": { + "target": "com.amazonaws.codepipeline#PipelineRollbackMetadata", + "traits": { + "smithy.api#documentation": "The metadata for the stage execution to be rolled back.
" + } } }, "traits": { @@ -5944,6 +6040,20 @@ "smithy.api#error": "client" } }, + "com.amazonaws.codepipeline#PipelineRollbackMetadata": { + "type": "structure", + "members": { + "rollbackTargetPipelineExecutionId": { + "target": "com.amazonaws.codepipeline#PipelineExecutionId", + "traits": { + "smithy.api#documentation": "The pipeline execution ID to which the stage will be rolled back.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata for the stage execution to be rolled back.
" + } + }, "com.amazonaws.codepipeline#PipelineStageDeclarationList": { "type": "list", "member": { @@ -6952,6 +7062,17 @@ "smithy.api#error": "client" } }, + "com.amazonaws.codepipeline#Result": { + "type": "enum", + "members": { + "ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK" + } + } + } + }, "com.amazonaws.codepipeline#RetryStageExecution": { "type": "operation", "input": { @@ -7073,6 +7194,85 @@ "smithy.api#pattern": "^arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/" } }, + "com.amazonaws.codepipeline#RollbackStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.codepipeline#RollbackStageInput" + }, + "output": { + "target": "com.amazonaws.codepipeline#RollbackStageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codepipeline#ConflictException" + }, + { + "target": "com.amazonaws.codepipeline#PipelineExecutionNotFoundException" + }, + { + "target": "com.amazonaws.codepipeline#PipelineExecutionOutdatedException" + }, + { + "target": "com.amazonaws.codepipeline#PipelineNotFoundException" + }, + { + "target": "com.amazonaws.codepipeline#StageNotFoundException" + }, + { + "target": "com.amazonaws.codepipeline#UnableToRollbackStageException" + }, + { + "target": "com.amazonaws.codepipeline#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Rolls back a stage execution.
" + } + }, + "com.amazonaws.codepipeline#RollbackStageInput": { + "type": "structure", + "members": { + "pipelineName": { + "target": "com.amazonaws.codepipeline#PipelineName", + "traits": { + "smithy.api#documentation": "The name of the pipeline for which the stage will be rolled back.
", + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.codepipeline#StageName", + "traits": { + "smithy.api#documentation": "The name of the stage in the pipeline to be rolled back.
", + "smithy.api#required": {} + } + }, + "targetPipelineExecutionId": { + "target": "com.amazonaws.codepipeline#PipelineExecutionId", + "traits": { + "smithy.api#documentation": "The pipeline execution ID for the stage to be rolled back to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codepipeline#RollbackStageOutput": { + "type": "structure", + "members": { + "pipelineExecutionId": { + "target": "com.amazonaws.codepipeline#PipelineExecutionId", + "traits": { + "smithy.api#documentation": "The execution ID of the pipeline execution for the stage that has been rolled\n back.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.codepipeline#S3ArtifactLocation": { "type": "structure", "members": { @@ -7311,6 +7511,12 @@ "smithy.api#documentation": "The actions included in a stage.
", "smithy.api#required": {} } + }, + "onFailure": { + "target": "com.amazonaws.codepipeline#FailureConditions", + "traits": { + "smithy.api#documentation": "The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.
" + } } }, "traits": { @@ -7333,6 +7539,12 @@ "smithy.api#documentation": "The status of the stage, or for a completed stage, the last status of the\n stage.
\nA status of cancelled means that the pipeline’s definition was updated before the\n stage execution could be completed.
\nThe type of pipeline execution for the stage, such as a rollback pipeline execution.
" + } } }, "traits": { @@ -7704,6 +7916,20 @@ "com.amazonaws.codepipeline#String": { "type": "string" }, + "com.amazonaws.codepipeline#SucceededInStageFilter": { + "type": "structure", + "members": { + "stageName": { + "target": "com.amazonaws.codepipeline#StageName", + "traits": { + "smithy.api#documentation": "The name of the stage for filtering for pipeline executions where the stage was successful in the current pipeline\n version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filter for pipeline executions that have successfully completed the stage in the current pipeline version.
" + } + }, "com.amazonaws.codepipeline#Tag": { "type": "structure", "members": { @@ -8038,9 +8264,33 @@ "traits": { "smithy.api#enumValue": "WebhookV2" } + }, + "ManualRollback": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManualRollback" + } + }, + "AutomatedRollback": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutomatedRollback" + } } } }, + "com.amazonaws.codepipeline#UnableToRollbackStageException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codepipeline#String" + } + }, + "traits": { + "smithy.api#documentation": "Unable to roll back the stage. The cause might be if the pipeline version has changed\n since the target pipeline execution was deployed, the stage is currently running, or an\n incorrect target pipeline execution ID was provided.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.codepipeline#UntagResource": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json b/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json index 5770dc03be0..505d69f1fa7 100644 --- a/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json +++ b/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json @@ -358,7 +358,7 @@ "sdkId": "Cognito Identity Provider", "arnNamespace": "cognito-idp", "cloudFormationName": "Cognito", - "cloudTrailEventSource": "cognitoidentityprovider.amazonaws.com", + "cloudTrailEventSource": "cognito-idp.amazonaws.com", "docId": "cognito-idp-2016-04-18", "endpointPrefix": "cognito-idp" }, @@ -2385,7 +2385,7 @@ "UserLastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nAdds a configuration and trust relationship between a third-party identity provider\n (IdP) and a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nA unique resource server identifier for the resource server. This could be an HTTPS\n endpoint where the resource server is located, such as\n https://my-weather-api.example.com.
A unique resource server identifier for the resource server. The identifier can be an\n API friendly name like solar-system-data. You can also set an API URL like\n https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format\n $resource-server-identifier/$scope. Longer scope-identifier strings\n increase the size of your access tokens.
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
" + "smithy.api#documentation": "The default redirect URI. In app clients with one assigned IdP, replaces\n redirect_uri in authentication requests. Must be in the\n CallbackURLs list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nFor more information, see Default redirect URI.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
" } }, "AllowedOAuthFlows": { @@ -7294,7 +7294,7 @@ "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { - "smithy.api#documentation": "The identifier for the resource server
", + "smithy.api#documentation": "A unique resource server identifier for the resource server. The identifier can be an\n API friendly name like solar-system-data. You can also set an API URL like\n https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format\n $resource-server-identifier/$scope. Longer scope-identifier strings\n increase the size of your access tokens.
The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
A filter string of the form \"AttributeName\n Filter-Type \"AttributeValue\"\". Quotation marks\n within the filter string must be escaped using the backslash (\\) character. For example,\n \"family_name = \\\"Reddy\\\"\".
\n AttributeName: The name of the attribute to search for.\n You can only search for one attribute at a time.
\n\n Filter-Type: For an exact match, use =, for example,\n \"given_name = \\\"Jon\\\"\". For a prefix (\"starts with\") match, use\n ^=, for example, \"given_name ^= \\\"Jon\\\"\".
\n AttributeValue: The attribute value that must be matched\n for each user.
\nIf the filter string is empty, ListUsers returns all users in the user\n pool.
You can only search for the following standard attributes:
\n\n username (case-sensitive)
\n email\n
\n phone_number\n
\n name\n
\n given_name\n
\n family_name\n
\n preferred_username\n
\n cognito:user_status (called Status in the Console) (case-insensitive)
\n status (called Enabled in the Console)\n (case-sensitive)\n
\n sub\n
Custom attributes aren't searchable.
\nYou can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query parameter of the list-users action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.
\nFor more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.
" + "smithy.api#documentation": "A filter string of the form \"AttributeName\n Filter-Type \"AttributeValue\"\". Quotation marks\n within the filter string must be escaped using the backslash (\\) character.\n For example, \"family_name = \\\"Reddy\\\"\".
\n AttributeName: The name of the attribute to search for.\n You can only search for one attribute at a time.
\n\n Filter-Type: For an exact match, use =, for\n example, \"given_name = \\\"Jon\\\"\". For a prefix (\"starts with\")\n match, use ^=, for example, \"given_name ^= \\\"Jon\\\"\".\n
\n AttributeValue: The attribute value that must be matched\n for each user.
\nIf the filter string is empty, ListUsers returns all users in the user\n pool.
You can only search for the following standard attributes:
\n\n username (case-sensitive)
\n email\n
\n phone_number\n
\n name\n
\n given_name\n
\n family_name\n
\n preferred_username\n
\n cognito:user_status (called Status in the Console) (case-insensitive)
\n status (called Enabled in the Console)\n (case-sensitive)\n
\n sub\n
Custom attributes aren't searchable.
\nYou can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query parameter of the list-users action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.
\nFor more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.
" } } }, @@ -11238,7 +11238,7 @@ "MaxValue": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "The maximum length of a number attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.
The maximum length of a number attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.
The date and time, in ISO 8601 format, when the item was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The identifier for the resource server.
" + "smithy.api#documentation": "A unique resource server identifier for the resource server. The identifier can be an\n API friendly name like solar-system-data. You can also set an API URL like\n https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format\n $resource-server-identifier/$scope. Longer scope-identifier strings\n increase the size of your access tokens.
The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The maximum length of a string attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.
The maximum length of a string attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.
The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The identifier for the resource server.
", + "smithy.api#documentation": "A unique resource server identifier for the resource server. The identifier can be an\n API friendly name like solar-system-data. You can also set an API URL like\n https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format\n $resource-server-identifier/$scope. Longer scope-identifier strings\n increase the size of your access tokens.
The date and time, in ISO 8601 format, when the item was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time, in ISO 8601 format, when the item was modified.
" + "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
A valid resource type. To enable streaming\n for real-time analysis of contacts, use the following types:
\nFor chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.
For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
\n REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still\n supported and will apply only to VOICE channel contacts. Use\n REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward.
If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no\n action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
A valid resource type. To enable streaming\n for real-time analysis of contacts, use the following types:
\nFor chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.
For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
\n REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported\n and will apply only to VOICE channel contacts. Use\n REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving\n forward.
If you have previously associated a stream with\n REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is needed to update the stream to\n REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601\n format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2024-05-03T02:41:28.172Z.
The unique identifier of the attached file resource (ARN).
", + "smithy.api#required": {} + } + }, + "FileId": { + "target": "com.amazonaws.connect#FileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the attached file resource.
", + "smithy.api#required": {} + } + }, + "FileName": { + "target": "com.amazonaws.connect#FileName", + "traits": { + "smithy.api#documentation": "A case-sensitive name of the attached file being uploaded.
", + "smithy.api#required": {} + } + }, + "FileSizeInBytes": { + "target": "com.amazonaws.connect#FileSizeInBytes", + "traits": { + "smithy.api#documentation": "The size of the attached file in bytes.
", + "smithy.api#required": {} + } + }, + "FileStatus": { + "target": "com.amazonaws.connect#FileStatusType", + "traits": { + "smithy.api#documentation": "The current status of the attached file.
", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.connect#CreatedByInfo", + "traits": { + "smithy.api#documentation": "Represents the identity that created the file.
" + } + }, + "FileUseCaseType": { + "target": "com.amazonaws.connect#FileUseCaseType", + "traits": { + "smithy.api#documentation": "The use case for the file.
" + } + }, + "AssociatedResourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.
\nThis value must be a valid ARN.
\nThe tags used to organize, track, or control access for this resource. For example, {\n \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
Information about the attached file.
" + } + }, + "com.amazonaws.connect#AttachedFileError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.connect#ErrorCode", + "traits": { + "smithy.api#documentation": "Status code describing the failure.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.connect#ErrorMessage", + "traits": { + "smithy.api#documentation": "Why the attached file couldn't be retrieved.
" + } + }, + "FileId": { + "target": "com.amazonaws.connect#FileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the attached file resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
" + } + }, + "com.amazonaws.connect#AttachedFileErrorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AttachedFileError" + } + }, + "com.amazonaws.connect#AttachedFileInvalidRequestExceptionReason": { + "type": "enum", + "members": { + "INVALID_FILE_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_FILE_SIZE" + } + }, + "INVALID_FILE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_FILE_TYPE" + } + }, + "INVALID_FILE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_FILE_NAME" + } + } + } + }, + "com.amazonaws.connect#AttachedFilesList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AttachedFile" + } + }, "com.amazonaws.connect#AttachmentName": { "type": "string", "traits": { @@ -3791,6 +3941,91 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#BatchGetAttachedFileMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#BatchGetAttachedFileMetadataRequest" + }, + "output": { + "target": "com.amazonaws.connect#BatchGetAttachedFileMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Allows you to retrieve metadata about multiple attached files on an associated resource.\n Each attached file provided in the input list must be associated with the input\n AssociatedResourceArn.
", + "smithy.api#http": { + "method": "POST", + "uri": "/attached-files/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#BatchGetAttachedFileMetadataRequest": { + "type": "structure", + "members": { + "FileIds": { + "target": "com.amazonaws.connect#FileIdList", + "traits": { + "smithy.api#documentation": "The unique identifiers of the attached file resource.
", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssociatedResourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.
\nThis value must be a valid ARN.
\nList of attached files that were successfully retrieved.
" + } + }, + "Errors": { + "target": "com.amazonaws.connect#AttachedFileErrorsList", + "traits": { + "smithy.api#documentation": "List of errors of attached files that could not be retrieved.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#BatchGetFlowAssociation": { "type": "operation", "input": { @@ -4423,6 +4658,81 @@ } } }, + "com.amazonaws.connect#CompleteAttachedFileUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CompleteAttachedFileUploadRequest" + }, + "output": { + "target": "com.amazonaws.connect#CompleteAttachedFileUploadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Allows you to confirm that the attached file has been uploaded using the pre-signed URL\n provided in the StartAttachedFileUpload API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/attached-files/{InstanceId}/{FileId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CompleteAttachedFileUploadRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FileId": { + "target": "com.amazonaws.connect#FileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the attached file resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssociatedResourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.
\nThis value must be a valid ARN.
\nAn agent ARN representing a connect user.
" + } + }, + "AWSIdentityArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and\n this value is calculated automatically if ConnectUserArn is not provided.
Information on the identity that created the file.
" + } + }, "com.amazonaws.connect#Credentials": { "type": "structure", "members": { @@ -8545,6 +8875,81 @@ } } }, + "com.amazonaws.connect#DeleteAttachedFile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteAttachedFileRequest" + }, + "output": { + "target": "com.amazonaws.connect#DeleteAttachedFileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an attached file along with the underlying S3 Object.
\nThe attached file is permanently deleted if S3 bucket\n versioning is not enabled.
\nThe unique identifier of the Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FileId": { + "target": "com.amazonaws.connect#FileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the attached file resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssociatedResourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.
\nThis value must be a valid ARN.
\nA pre-signed URL that should be used to download the attached file.
" + } + }, + "UrlExpiry": { + "target": "com.amazonaws.connect#ISO8601Datetime", + "traits": { + "smithy.api#documentation": "The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:\n yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata used to download the attached file.
" + } + }, "com.amazonaws.connect#DuplicateResourceException": { "type": "structure", "members": { @@ -12893,6 +13318,12 @@ } } }, + "com.amazonaws.connect#ErrorCode": { + "type": "string" + }, + "com.amazonaws.connect#ErrorMessage": { + "type": "string" + }, "com.amazonaws.connect#ErrorResult": { "type": "structure", "members": { @@ -14493,6 +14924,84 @@ "target": "com.amazonaws.connect#FieldValue" } }, + "com.amazonaws.connect#FileId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#FileIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#FileId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.connect#FileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.connect#FileSizeInBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.connect#FileStatusType": { + "type": "enum", + "members": { + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVED" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.connect#FileUseCaseType": { + "type": "enum", + "members": { + "ATTACHMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT" + } + } + } + }, "com.amazonaws.connect#FilterV2": { "type": "structure", "members": { @@ -14627,6 +15136,156 @@ "target": "com.amazonaws.connect#FunctionArn" } }, + "com.amazonaws.connect#GetAttachedFile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetAttachedFileRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetAttachedFileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a pre-signed URL for download of an approved attached file. This API also returns\n metadata about the attached file. It will only return a downloadURL if the status of the attached\n file is APPROVED.
The unique identifier of the Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FileId": { + "target": "com.amazonaws.connect#FileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the attached file resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UrlExpiryInSeconds": { + "target": "com.amazonaws.connect#URLExpiryInSeconds", + "traits": { + "smithy.api#documentation": "Optional override for the expiry of the pre-signed S3 URL in seconds.
", + "smithy.api#httpQuery": "urlExpiryInSeconds" + } + }, + "AssociatedResourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.
\nThis value must be a valid ARN.
\nThe unique identifier of the attached file resource (ARN).
" + } + }, + "FileId": { + "target": "com.amazonaws.connect#FileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the attached file resource.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.connect#ISO8601Datetime", + "traits": { + "smithy.api#documentation": "The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601\n format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2024-05-03T02:41:28.172Z.
The current status of the attached file.
" + } + }, + "FileName": { + "target": "com.amazonaws.connect#FileName", + "traits": { + "smithy.api#documentation": "A case-sensitive name of the attached file being uploaded.
" + } + }, + "FileSizeInBytes": { + "target": "com.amazonaws.connect#FileSizeInBytes", + "traits": { + "smithy.api#documentation": "The size of the attached file in bytes.
", + "smithy.api#required": {} + } + }, + "AssociatedResourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.
\nThis value must be a valid ARN.
\nThe use case for the file.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.connect#CreatedByInfo", + "traits": { + "smithy.api#documentation": "Represents the identity that created the file.
" + } + }, + "DownloadUrlMetadata": { + "target": "com.amazonaws.connect#DownloadUrlMetadata", + "traits": { + "smithy.api#documentation": "URL and expiry to be used when downloading the attached file.
" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, {\n \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Abandonment rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average active time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent pause time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average conversation duration\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average greeting time agent \n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average interruptions agent \n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average interruption time agent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average talk time agent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average talk time customer\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Contact abandoned\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: API contacts handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts handled by Connected to agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts put on hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued by Enqueue\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nThreshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts resolved in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Maximum queued time\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Non-talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Talk\n time agent percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Talk time customer percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Service level X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API connecting time\n
\nThe Negate key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contact flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on contact time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts answered in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts abandoned in X seconds\n
\nValid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contact disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contact handle time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Customer hold time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-Productive Time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nUI name: Callback attempts\n
\nThe metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Abandonment rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average active time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent pause time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average conversation duration\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent greeting time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent interruptions\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent interruption time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average customer talk time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Contact abandoned\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: API contacts handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\n \nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts put on hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued (enqueue timestamp)\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nThreshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts resolved in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Maximum queued time\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Non-talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Agent\n talk time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Customer talk time percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Service level X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API connecting time\n
\nThe Negate key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contact flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on contact time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts answered in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts abandoned in X seconds\n
\nValid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contact disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contact handle time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Customer hold time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-Productive Time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nUI name: Callback attempts\n
\nThe message about the request.
" } + }, + "Reason": { + "target": "com.amazonaws.connect#InvalidRequestExceptionReason" } }, "traits": { @@ -17507,6 +18169,20 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.connect#InvalidRequestExceptionReason": { + "type": "union", + "members": { + "AttachedFileInvalidRequestExceptionReason": { + "target": "com.amazonaws.connect#AttachedFileInvalidRequestExceptionReason", + "traits": { + "smithy.api#documentation": "Reason why the StartAttachedFiledUpload request was invalid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reason why the request was invalid.
" + } + }, "com.amazonaws.connect#InvisibleFieldInfo": { "type": "structure", "members": { @@ -22270,6 +22946,15 @@ "com.amazonaws.connect#Message": { "type": "string" }, + "com.amazonaws.connect#MetadataUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, "com.amazonaws.connect#MetricDataCollectionsV2": { "type": "list", "member": { @@ -30332,6 +31017,158 @@ } } }, + "com.amazonaws.connect#StartAttachedFileUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartAttachedFileUploadRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartAttachedFileUploadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a pre-signed Amazon S3 URL in response for uploading your content.
\nYou may only use this API to upload attachments to a Connect\n Case.
\nA 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": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FileName": { + "target": "com.amazonaws.connect#FileName", + "traits": { + "smithy.api#documentation": "A case-sensitive name of the attached file being uploaded.
", + "smithy.api#required": {} + } + }, + "FileSizeInBytes": { + "target": "com.amazonaws.connect#FileSizeInBytes", + "traits": { + "smithy.api#documentation": "The size of the attached file in bytes.
", + "smithy.api#required": {} + } + }, + "UrlExpiryInSeconds": { + "target": "com.amazonaws.connect#URLExpiryInSeconds", + "traits": { + "smithy.api#documentation": "Optional override for the expiry of the pre-signed S3 URL in seconds.
" + } + }, + "FileUseCaseType": { + "target": "com.amazonaws.connect#FileUseCaseType", + "traits": { + "smithy.api#documentation": "The use case for the file.
", + "smithy.api#required": {} + } + }, + "AssociatedResourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.
\nThis value must be a valid ARN.
\nRepresents the identity that created the file.
" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, {\n \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
The unique identifier of the attached file resource (ARN).
" + } + }, + "FileId": { + "target": "com.amazonaws.connect#FileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the attached file resource.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.connect#ISO8601Datetime", + "traits": { + "smithy.api#documentation": "The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601\n format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2024-05-03T02:41:28.172Z.
The current status of the attached file.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.connect#CreatedByInfo", + "traits": { + "smithy.api#documentation": "Represents the identity that created the file.
" + } + }, + "UploadUrlMetadata": { + "target": "com.amazonaws.connect#UploadUrlMetadata", + "traits": { + "smithy.api#documentation": "Information to be used while uploading the attached file.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response from StartAttachedFileUpload API.", + "smithy.api#output": {} + } + }, "com.amazonaws.connect#StartChatContact": { "type": "operation", "input": { @@ -32954,6 +33791,15 @@ } } }, + "com.amazonaws.connect#URLExpiryInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 300 + } + } + }, "com.amazonaws.connect#Unit": { "type": "enum", "members": { @@ -33313,7 +34159,7 @@ "Attributes": { "target": "com.amazonaws.connect#Attributes", "traits": { - "smithy.api#documentation": "The Amazon Connect attributes. These attributes can be accessed in flows just like any\n other contact attributes.
\nYou can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.
", + "smithy.api#documentation": "The Amazon Connect attributes. These attributes can be accessed in flows just like any\n other contact attributes.
\nYou can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.
\nWhen the attributes for a contact exceed 32 KB, the contact is routed down the Error branch\n of the flow. As a mitigation, consider the following options:
\nRemove unnecessary attributes by setting their values to empty.
\nIf the attributes are only used in one flow and don't need to be referred to outside of\n that flow (for example, by a Lambda or another flow), then use flow attributes. This way you\n aren't needlessly persisting the 32 KB of information from one flow to another. For more\n information, see Flow block: Set contact\n attributes in the Amazon Connect Administrator Guide.
\nA pre-signed S3 URL that should be used for uploading the attached file.
" + } + }, + "UrlExpiry": { + "target": "com.amazonaws.connect#ISO8601Datetime", + "traits": { + "smithy.api#documentation": "The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:\n yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.
A map of headers that should be provided when uploading the attached file.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Fields required when uploading an attached file.
" + } + }, "com.amazonaws.connect#Url": { "type": "string" }, + "com.amazonaws.connect#UrlMetadataSignedHeaders": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#UrlMetadataSignedHeadersKey" + }, + "value": { + "target": "com.amazonaws.connect#UrlMetadataSignedHeadersValue" + } + }, + "com.amazonaws.connect#UrlMetadataSignedHeadersKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connect#UrlMetadataSignedHeadersValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.connect#UrlReference": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/connectcampaigns.2021-01-30.json b/codegen/sdk-codegen/aws-models/connectcampaigns.2021-01-30.json index 5315bb12fe6..a3d8e26f473 100644 --- a/codegen/sdk-codegen/aws-models/connectcampaigns.2021-01-30.json +++ b/codegen/sdk-codegen/aws-models/connectcampaigns.2021-01-30.json @@ -820,6 +820,13 @@ "smithy.api#documentation": "Enable or disable answering machine detection", "smithy.api#required": {} } + }, + "awaitAnswerMachinePrompt": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Enable or disable await answer machine prompt" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/connectcases.2022-10-03.json b/codegen/sdk-codegen/aws-models/connectcases.2022-10-03.json index cef8ca763b3..0f88560fe4a 100644 --- a/codegen/sdk-codegen/aws-models/connectcases.2022-10-03.json +++ b/codegen/sdk-codegen/aws-models/connectcases.2022-10-03.json @@ -892,7 +892,7 @@ } }, "traits": { - "smithy.api#documentation": "Object to store union of Field values.
\nThis data type is a UNION, so only one of the following members can be specified when\n used or returned.
\nObject to store union of Field values.
" } }, "com.amazonaws.connectcases#AuditEventId": { @@ -2076,6 +2076,219 @@ "type": "structure", "members": {} }, + "com.amazonaws.connectcases#DeleteField": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcases#DeleteFieldRequest" + }, + "output": { + "target": "com.amazonaws.connectcases#DeleteFieldResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcases#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcases#ConflictException" + }, + { + "target": "com.amazonaws.connectcases#InternalServerException" + }, + { + "target": "com.amazonaws.connectcases#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connectcases#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcases#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a field from a cases template. You can delete up to 100 fields per domain.
\nAfter a field is deleted:
\nYou can still retrieve the field by calling BatchGetField.
You cannot update a deleted field by calling UpdateField; it throws a\n ValidationException.
Deleted fields are not included in the ListFields response.
Calling CreateCase with a deleted field throws a ValidationException denoting\n which field IDs in the request have been deleted.
Calling GetCase with a deleted field ID returns the deleted field's value if one\n exists.
Calling UpdateCase with a deleted field ID throws a ValidationException if the\n case does not already contain a value for the deleted field. Otherwise it succeeds,\n allowing you to update or remove (using emptyValue: {}) the field's value from the\n case.
\n GetTemplate does not return field IDs for deleted fields.
\n GetLayout does not return field IDs for deleted fields.
Calling SearchCases with the deleted field ID as a filter returns any cases that\n have a value for the deleted field that matches the filter criteria.
Calling SearchCases with a searchTerm value that matches a deleted field's value on a\n case returns the case in the response.
Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException.
Calling GetCaseEventConfiguration does not return field IDs for deleted fields.
The unique identifier of the Cases domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fieldId": { + "target": "com.amazonaws.connectcases#FieldId", + "traits": { + "smithy.api#documentation": "Unique identifier of the field.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connectcases#DeleteFieldResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.connectcases#DeleteLayout": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcases#DeleteLayoutRequest" + }, + "output": { + "target": "com.amazonaws.connectcases#DeleteLayoutResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcases#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcases#ConflictException" + }, + { + "target": "com.amazonaws.connectcases#InternalServerException" + }, + { + "target": "com.amazonaws.connectcases#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcases#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcases#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a layout from a cases template. You can delete up to 100 layouts per domain.
\n \nAfter a layout is deleted:
\nYou can still retrieve the layout by calling GetLayout.
You cannot update a deleted layout by calling UpdateLayout; it throws a\n ValidationException.
Deleted layouts are not included in the ListLayouts response.
The unique identifier of the Cases domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "layoutId": { + "target": "com.amazonaws.connectcases#LayoutId", + "traits": { + "smithy.api#documentation": "The unique identifier of the layout.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connectcases#DeleteLayoutResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.connectcases#DeleteTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcases#DeleteTemplateRequest" + }, + "output": { + "target": "com.amazonaws.connectcases#DeleteTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcases#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcases#ConflictException" + }, + { + "target": "com.amazonaws.connectcases#InternalServerException" + }, + { + "target": "com.amazonaws.connectcases#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcases#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcases#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a cases template. You can delete up to 100 templates per domain.
\n \nAfter a cases template is deleted:
\nYou can still retrieve the template by calling GetTemplate.
You cannot update the template.
\nYou cannot create a case by using the deleted template.
\nDeleted templates are not included in the ListTemplates response.
The unique identifier of the Cases domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "templateId": { + "target": "com.amazonaws.connectcases#TemplateId", + "traits": { + "smithy.api#documentation": "A unique identifier of a template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connectcases#DeleteTemplateResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.connectcases#Deleted": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.connectcases#Domain": { "type": "resource", "identifiers": { @@ -2255,6 +2468,9 @@ "update": { "target": "com.amazonaws.connectcases#UpdateField" }, + "delete": { + "target": "com.amazonaws.connectcases#DeleteField" + }, "list": { "target": "com.amazonaws.connectcases#ListFields" }, @@ -2712,6 +2928,44 @@ "smithy.api#documentation": "Object to store union of Field values.
\nThe Summary system field accepts 1500 characters while all other fields\n accept 500 characters.
The Amazon Resource Name (ARN) of a File in Amazon Connect.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that represents a content of an Amazon Connect file object.
" + } + }, + "com.amazonaws.connectcases#FileFilter": { + "type": "structure", + "members": { + "fileArn": { + "target": "com.amazonaws.connectcases#FileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A filter for related items of type File.
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } + }, + "deleted": { + "target": "com.amazonaws.connectcases#Deleted", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Denotes whether or not the resource has been deleted.
" + } + }, + "createdTime": { + "target": "com.amazonaws.connectcases#CreatedTime", + "traits": { + "smithy.api#documentation": "Timestamp at which the resource was created.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.connectcases#LastModifiedTime", + "traits": { + "smithy.api#documentation": "Timestamp at which the resource was created or last modified.
" + } } }, "traits": { @@ -3224,6 +3497,25 @@ "traits": { "smithy.api#documentation": "A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } + }, + "deleted": { + "target": "com.amazonaws.connectcases#Deleted", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Denotes whether or not the resource has been deleted.
" + } + }, + "createdTime": { + "target": "com.amazonaws.connectcases#CreatedTime", + "traits": { + "smithy.api#documentation": "Timestamp at which the resource was created.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.connectcases#LastModifiedTime", + "traits": { + "smithy.api#documentation": "Timestamp at which the resource was created or last modified.
" + } } } }, @@ -3336,6 +3628,25 @@ "smithy.api#documentation": "The status of the template.
", "smithy.api#required": {} } + }, + "deleted": { + "target": "com.amazonaws.connectcases#Deleted", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Denotes whether or not the resource has been deleted.
" + } + }, + "createdTime": { + "target": "com.amazonaws.connectcases#CreatedTime", + "traits": { + "smithy.api#documentation": "Timestamp at which the resource was created.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.connectcases#LastModifiedTime", + "traits": { + "smithy.api#documentation": "Timestamp at which the resource was created or last modified.
" + } } } }, @@ -3372,6 +3683,12 @@ "smithy.api#retryable": {} } }, + "com.amazonaws.connectcases#LastModifiedTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, "com.amazonaws.connectcases#Layout": { "type": "resource", "identifiers": { @@ -3391,6 +3708,9 @@ "update": { "target": "com.amazonaws.connectcases#UpdateLayout" }, + "delete": { + "target": "com.amazonaws.connectcases#DeleteLayout" + }, "list": { "target": "com.amazonaws.connectcases#ListLayouts" }, @@ -4236,6 +4556,12 @@ "traits": { "smithy.api#documentation": "Represents the content of a comment to be returned to agents.
" } + }, + "file": { + "target": "com.amazonaws.connectcases#FileContent", + "traits": { + "smithy.api#documentation": "Represents the content of a File to be returned to agents.
" + } } }, "traits": { @@ -4286,6 +4612,12 @@ "traits": { "smithy.api#documentation": "Represents the content of a comment to be returned to agents.
" } + }, + "file": { + "target": "com.amazonaws.connectcases#FileContent", + "traits": { + "smithy.api#documentation": "A file of related items.
" + } } }, "traits": { @@ -4303,6 +4635,10 @@ { "value": "Comment", "name": "COMMENT" + }, + { + "value": "File", + "name": "FILE" } ] } @@ -4321,6 +4657,12 @@ "traits": { "smithy.api#documentation": "A filter for related items of type Comment.
A filter for related items of this type of File.
Retrieves cost and usage metrics with resources for your account. You can specify which\n cost and usage-related metric, such as BlendedCosts or\n UsageQuantity, that you want the request to return. You can also filter and group\n your data by various dimensions, such as SERVICE or AZ, in a\n specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the\n Amazon Elastic Compute Cloud – Compute service only.
This is an opt-in only feature. You can enable this feature from the Cost Explorer\n Settings page. For information about how to access the Settings page, see Controlling\n Access for Cost Explorer in the Billing and Cost Management User\n Guide.
\nRetrieves cost and usage metrics with resources for your account. You can specify which\n cost and usage-related metric, such as BlendedCosts or\n UsageQuantity, that you want the request to return. You can also filter and group\n your data by various dimensions, such as SERVICE or AZ, in a\n specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.
Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud)\n resource-level data. All other resource-level data is available at daily\n granularity.
\nThis is an opt-in only feature. You can enable this feature from the Cost Explorer\n Settings page. For information about how to access the Settings page, see Controlling\n Access for Cost Explorer in the Billing and Cost Management User\n Guide.
\nThe ID for this specific recommendation.
" + "smithy.api#documentation": "The ID for the recommendation.
" } }, "GenerationTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "The timestamp for when Amazon Web Services made this recommendation.
" + "smithy.api#documentation": "The timestamp for when Amazon Web Services made the recommendation.
" + } + }, + "AdditionalMetadata": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "Additional metadata that might be applicable to the recommendation.
" } } }, "traits": { - "smithy.api#documentation": "Information about this specific recommendation, such as the timestamp for when Amazon Web Services made a specific recommendation.
" + "smithy.api#documentation": "Information about a recommendation, such as the timestamp for when Amazon Web Services\n made a specific recommendation.
" } }, "com.amazonaws.costexplorer#ReservationPurchaseRecommendationSummary": { @@ -7690,19 +7696,19 @@ "RecommendationId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "The ID for this specific recommendation.
" + "smithy.api#documentation": "The ID for the recommendation.
" } }, "GenerationTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "The timestamp for when Amazon Web Services made this recommendation.
" + "smithy.api#documentation": "The timestamp for when Amazon Web Services made the recommendation.
" } }, "LookbackPeriodInDays": { "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "The number of days of previous usage that Amazon Web Services considers when making\n this recommendation.
" + "smithy.api#documentation": "The number of days of previous usage that Amazon Web Services considers when making the\n recommendation.
" } }, "AdditionalMetadata": { @@ -7713,7 +7719,7 @@ } }, "traits": { - "smithy.api#documentation": "Metadata for this recommendation set.
" + "smithy.api#documentation": "Metadata for a recommendation set.
" } }, "com.amazonaws.costexplorer#RightsizingRecommendationSummary": { diff --git a/codegen/sdk-codegen/aws-models/customer-profiles.2020-08-15.json b/codegen/sdk-codegen/aws-models/customer-profiles.2020-08-15.json index cb48f8b807f..ee552e3401c 100644 --- a/codegen/sdk-codegen/aws-models/customer-profiles.2020-08-15.json +++ b/codegen/sdk-codegen/aws-models/customer-profiles.2020-08-15.json @@ -1617,7 +1617,7 @@ "sdkId": "Customer Profiles", "arnNamespace": "profile", "cloudFormationName": "CustomerProfiles", - "cloudTrailEventSource": "customerprofiles.amazonaws.com", + "cloudTrailEventSource": "profile.amazonaws.com", "endpointPrefix": "profile" }, "aws.auth#sigv4": { diff --git a/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json b/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json index 36efe541dc0..1a8b7784daa 100644 --- a/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json +++ b/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json @@ -473,7 +473,7 @@ "sdkId": "Database Migration Service", "arnNamespace": "dms", "cloudFormationName": "DMS", - "cloudTrailEventSource": "databasemigrationservice.amazonaws.com", + "cloudTrailEventSource": "dms.amazonaws.com", "docId": "dms-2016-01-01", "endpointPrefix": "dms" }, diff --git a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json index 5ff804f9ed6..63dc4e3127d 100644 --- a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json +++ b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json @@ -1276,7 +1276,7 @@ "ServerCertificate": { "target": "com.amazonaws.datasync#ObjectStorageCertificate", "traits": { - "smithy.api#documentation": "Specifies a file with the certificates that are used to sign the object storage server's\n certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem).\n The file you specify must include the following:
The certificate of the signing certificate authority (CA)
\nAny intermediate certificates
\nbase64 encoding
\nA .pem extension
The file can be up to 32768 bytes (before base64 encoding).
\nTo use this parameter, configure ServerProtocol to HTTPS.
Specifies a certificate chain for DataSync to authenticate with your object\n storage system if the system uses a private or self-signed certificate authority (CA). You\n must specify a single .pem file with a full certificate chain (for example,\n file:///home/user/.ssh/object_storage_certificates.pem).
The certificate chain might include:
\nThe object storage system's certificate
\nAll intermediate certificates (if there are any)
\nThe root certificate of the signing CA
\nYou can concatenate your certificates into a .pem file (which can be up to\n 32768 bytes before base64 encoding). The following example cat command creates an\n object_storage_certificates.pem file that includes three certificates:
\n cat object_server_certificate.pem intermediate_certificate.pem\n ca_root_certificate.pem > object_storage_certificates.pem\n
To use this parameter, configure ServerProtocol to HTTPS.
Configures a transfer task, which defines where and how DataSync moves your\n data.
\nA task includes a source location, destination location, and the options for how and\n when you want to transfer your data (such as bandwidth limits, scheduling, among other\n options).
\nIf you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.
\nConfigures a task, which defines where and how DataSync transfers your\n data.
\nA task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).
\nIf you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.
\nThe Amazon Resource Name (ARN) of the source location for the task.
", + "smithy.api#documentation": "Specifies the ARN of your transfer's source location.
", "smithy.api#required": {} } }, "DestinationLocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.\n
", + "smithy.api#documentation": "Specifies the ARN of your transfer's destination location.
", "smithy.api#required": {} } }, "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor and log events in the task.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
" } }, "Name": { "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "The name of a task. This value is a text reference that is used to identify the task in\n the console.
" + "smithy.api#documentation": "Specifies the name of your task.
" } }, "Options": { "target": "com.amazonaws.datasync#Options", "traits": { - "smithy.api#documentation": "Specifies the configuration options for a task. Some options include preserving file or\n object metadata and verifying data integrity.
\nYou can also override these options before starting an individual run of a task (also\n known as a task execution). For more information, see StartTaskExecution.
" + "smithy.api#documentation": "Specifies your task's settings, such as preserving file metadata, verifying data\n integrity, among other options.
" } }, "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a list of filter rules that exclude specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more\n information and examples, see Specifying what DataSync transfers by using filters.
" } }, "Schedule": { "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "Specifies a schedule used to periodically transfer files from a source to a destination\n location. The schedule should be specified in UTC time. For more information, see Scheduling your\n task.
" + "smithy.api#documentation": "Specifies a schedule for when you want your task to run. For more information, see Scheduling your\n task.
" } }, "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "Specifies the tags that you want to apply to the Amazon Resource Name (ARN)\n representing the task.
\n\n Tags are key-value pairs that help you manage, filter, and search\n for your DataSync resources.
" + "smithy.api#documentation": "Specifies the tags that you want to apply to your task.
\n\n Tags are key-value pairs that help you manage, filter, and search\n for your DataSync resources.
" } }, "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "Specifies include filters define the files, objects, and folders in your source location\n that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
" } }, "ManifestConfig": { @@ -2657,7 +2657,7 @@ "ServerCertificate": { "target": "com.amazonaws.datasync#ObjectStorageCertificate", "traits": { - "smithy.api#documentation": "The self-signed certificate that DataSync uses to securely authenticate with\n your object storage system.
" + "smithy.api#documentation": "The certificate chain for DataSync to authenticate with your object storage\n system if the system uses a private or self-signed certificate authority (CA).
" } } }, @@ -3150,7 +3150,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about an DataSync transfer task.
" + "smithy.api#documentation": "Provides information about a task, which defines where and how DataSync transfers your data.
" } }, "com.amazonaws.datasync#DescribeTaskExecution": { @@ -3331,7 +3331,7 @@ "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the transfer task.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the transfer task that you want information\n about.
", "smithy.api#required": {} } } @@ -3347,85 +3347,85 @@ "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task that was described.
" + "smithy.api#documentation": "The ARN of your task.
" } }, "Status": { "target": "com.amazonaws.datasync#TaskStatus", "traits": { - "smithy.api#documentation": "The status of the task that was described.
\nFor detailed information about task execution statuses, see Understanding\n Task Statuses in the DataSync User Guide.
" + "smithy.api#documentation": "The status of your task. For information about what each status means, see Task statuses.
" } }, "Name": { "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "The name of the task that was described.
" + "smithy.api#documentation": "The name of your task.
" } }, "CurrentTaskExecutionArn": { "target": "com.amazonaws.datasync#TaskExecutionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution that is transferring\n files.
" + "smithy.api#documentation": "The ARN of the most recent task execution.
" } }, "SourceLocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source file system's location.
" + "smithy.api#documentation": "The ARN of your transfer's source location.
" } }, "DestinationLocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's\n location.
" + "smithy.api#documentation": "The ARN of your transfer's destination location.
" } }, "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.
\nFor more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your\n task.
\nFor more information, see Monitoring DataSync with\n Amazon CloudWatch.
" } }, "SourceNetworkInterfaceArns": { "target": "com.amazonaws.datasync#SourceNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the network interfaces created for your source\n location. For more information, see Network\n interface requirements.
" + "smithy.api#documentation": "The ARNs of the network\n interfaces that DataSync created for your source location.
" } }, "DestinationNetworkInterfaceArns": { "target": "com.amazonaws.datasync#DestinationNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the network interfaces created for your destination\n location. For more information, see Network\n interface requirements.
" + "smithy.api#documentation": "The ARNs of the network\n interfaces that DataSync created for your destination location.
" } }, "Options": { "target": "com.amazonaws.datasync#Options", "traits": { - "smithy.api#documentation": "The configuration options that control the behavior of the\n StartTaskExecution operation. Some options include preserving file or object\n metadata and verifying data integrity.
You can override these options for each task execution. For more information, see\n StartTaskExecution.
" + "smithy.api#documentation": "The task's settings. For example, what file metadata gets preserved, how data integrity\n gets verified at the end of your transfer, bandwidth limits, among other options.
" } }, "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "A list of filter rules that exclude specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more\n information and examples, see Specifying what DataSync transfers by using filters.
" } }, "Schedule": { "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "The schedule used to periodically transfer files from a source to a destination\n location.
" + "smithy.api#documentation": "The schedule for when you want your task to run. For more information, see Scheduling your\n task.
" } }, "ErrorCode": { "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "Errors that DataSync encountered during execution of the task. You can\n use this error code to help troubleshoot issues.
" + "smithy.api#documentation": "If there's an issue with your task, you can use the error code to help you troubleshoot\n the problem. For more information, see Troubleshooting issues with DataSync transfers.
" } }, "ErrorDetail": { "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.
" + "smithy.api#documentation": "If there's an issue with your task, you can use the error details to help you\n troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
" } }, "CreationTime": { @@ -3437,19 +3437,25 @@ "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "A list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "The include filters that define the files, objects, and folders in your source location\n that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
" } }, "ManifestConfig": { "target": "com.amazonaws.datasync#ManifestConfig", "traits": { - "smithy.api#documentation": "The configuration of the manifest that lists the files or objects to transfer. For more\n information, see Specifying what DataSync transfers by using a manifest.
" + "smithy.api#documentation": "The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
" } }, "TaskReportConfig": { "target": "com.amazonaws.datasync#TaskReportConfig", "traits": { - "smithy.api#documentation": "The configuration of your task report, which provides detailed information about for your\n DataSync transfer. For more information, see Creating a task report.
" + "smithy.api#documentation": "The configuration of your task report, which provides detailed information about your\n DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.
" + } + }, + "ScheduleDetails": { + "target": "com.amazonaws.datasync#TaskScheduleDetails", + "traits": { + "smithy.api#documentation": "The details about your task schedule.
" } } }, @@ -6976,7 +6982,7 @@ "VerifyMode": { "target": "com.amazonaws.datasync#VerifyMode", "traits": { - "smithy.api#documentation": "Specifies how and when DataSync checks the integrity of your data during a\n transfer.
\n\n ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates\n the checksum of transferred files and metadata at the source location. At the end of the\n transfer, DataSync then compares this checksum to the checksum calculated on\n those files at the destination.
We recommend this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer,\n DataSync scans the entire source and destination to verify that both locations\n are fully synchronized.
You can't use this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n NONE - DataSync doesn't run additional verification at the\n end of the transfer. All data transmissions are still integrity-checked with checksum\n verification during the transfer.
Specifies how and when DataSync checks the integrity of your data during a\n transfer.
\n\n ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates\n the checksum of transferred files and metadata at the source location. At the end of the\n transfer, DataSync then compares this checksum to the checksum calculated on\n those files at the destination.
We recommend this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer,\n DataSync scans the entire source and destination to verify that both locations\n are fully synchronized.
If you use a manifest, DataSync only scans and\n verifies what's listed in the manifest.
\nYou can't use this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n NONE - DataSync doesn't run additional verification at the\n end of the transfer. All data transmissions are still integrity-checked with checksum\n verification during the transfer.
Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You\n also can specify how to verify data integrity, set bandwidth limits for your task, among other\n options.
\nEach option has a default value. Unless you need to, you don't have to configure any of\n these options before starting your task.
" + "smithy.api#documentation": "Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You\n also can specify how to verify data integrity, set bandwidth limits for your task, among other\n options.
\nEach option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.
\nYou also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.
The version of the DataSync agent.
\nOn December 7, 2023, we discontinued version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, replace those agents or delete them if they aren't in use. If you need more help, contact Amazon Web Services Support.
\nThe version of the DataSync agent.
" } } }, @@ -7818,6 +7824,33 @@ "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$" } }, + "com.amazonaws.datasync#ScheduleDisabledBy": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" + } + } + } + }, + "com.amazonaws.datasync#ScheduleDisabledReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#pattern": "^[\\w\\s.,'?!:;\\/=|<>()-]*$" + } + }, "com.amazonaws.datasync#ScheduleExpressionCron": { "type": "string", "traits": { @@ -7828,6 +7861,23 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\ \\_\\*\\?\\,\\|\\^\\-\\/\\#\\s\\(\\)\\+]*$" } }, + "com.amazonaws.datasync#ScheduleStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.datasync#SecretsManagerArn": { "type": "string", "traits": { @@ -8350,7 +8400,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$" @@ -8666,13 +8716,45 @@ "ScheduleExpression": { "target": "com.amazonaws.datasync#ScheduleExpressionCron", "traits": { - "smithy.api#documentation": "A cron expression that specifies when DataSync initiates a scheduled\n transfer from a source to a destination location.
", + "smithy.api#documentation": "Specifies your task schedule by using a cron expression in UTC time. For information about\n cron expression syntax, see the \n Amazon EventBridge User\n Guide\n .
", "smithy.api#required": {} } + }, + "Status": { + "target": "com.amazonaws.datasync#ScheduleStatus", + "traits": { + "smithy.api#documentation": "Specifies whether to enable or disable your task schedule. Your schedule is enabled by\n default, but there can be situations where you need to disable it. For example, you might need\n to pause a recurring transfer to fix an issue with your task or perform maintenance on your\n storage system.
\nDataSync might disable your schedule automatically if your task fails repeatedly\n with the same error. For more information, see TaskScheduleDetails.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures your DataSync task to run on a schedule\n (at a minimum interval of 1 hour).
" + } + }, + "com.amazonaws.datasync#TaskScheduleDetails": { + "type": "structure", + "members": { + "StatusUpdateTime": { + "target": "com.amazonaws.datasync#Time", + "traits": { + "smithy.api#documentation": "Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see\n when the schedule was disabled.
" + } + }, + "DisabledReason": { + "target": "com.amazonaws.datasync#ScheduleDisabledReason", + "traits": { + "smithy.api#documentation": "Provides a reason if the task schedule is disabled.
\nIf your schedule is disabled by USER, you see a Manually disabled by user. message.
If your schedule is disabled by SERVICE, you see an error message to help you\n understand why the task keeps failing. For information on resolving DataSync errors,\n see Troubleshooting issues with DataSync transfers.
Indicates how your task schedule was disabled.
\n\n USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console.
\n SERVICE - Your schedule was automatically disabled by DataSync\n because the task failed repeatedly with the same error.
Specifies the schedule you want your task to use for repeated executions. For more\n information, see Schedule Expressions for\n Rules.
" + "smithy.api#documentation": "Provides information about your DataSync\n task schedule.
" } }, "com.amazonaws.datasync#TaskStatus": { @@ -9208,7 +9290,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates some parameters of an existing object storage location that DataSync\n accesses for a transfer. For information about creating a self-managed object storage\n location, see Creating a location for object\n storage.
" + "smithy.api#documentation": "Updates some parameters of an existing DataSync location for an object\n storage system.
" } }, "com.amazonaws.datasync#UpdateLocationObjectStorageRequest": { @@ -9260,7 +9342,7 @@ "ServerCertificate": { "target": "com.amazonaws.datasync#ObjectStorageCertificate", "traits": { - "smithy.api#documentation": "Specifies a certificate to authenticate with an object storage system that uses a private\n or self-signed certificate authority (CA). You must specify a Base64-encoded .pem\n file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The\n certificate can be up to 32768 bytes (before Base64 encoding).
To use this parameter, configure ServerProtocol to HTTPS.
Updating the certificate doesn't interfere with tasks that you have in progress.
" + "smithy.api#documentation": "Specifies a certificate chain for DataSync to authenticate with your object\n storage system if the system uses a private or self-signed certificate authority (CA). You\n must specify a single .pem file with a full certificate chain (for example,\n file:///home/user/.ssh/object_storage_certificates.pem).
The certificate chain might include:
\nThe object storage system's certificate
\nAll intermediate certificates (if there are any)
\nThe root certificate of the signing CA
\nYou can concatenate your certificates into a .pem file (which can be up to\n 32768 bytes before base64 encoding). The following example cat command creates an\n object_storage_certificates.pem file that includes three certificates:
\n cat object_server_certificate.pem intermediate_certificate.pem\n ca_root_certificate.pem > object_storage_certificates.pem\n
To use this parameter, configure ServerProtocol to HTTPS.
Updating this parameter doesn't interfere with tasks that you have in progress.
" } } }, @@ -9442,7 +9524,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of an DataSync transfer task.
" + "smithy.api#documentation": "Updates the configuration of a task, which defines where and how DataSync transfers your data.
" } }, "com.amazonaws.datasync#UpdateTaskExecution": { @@ -9499,7 +9581,7 @@ "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource name of the task to update.
", + "smithy.api#documentation": "Specifies the ARN of the task that you want to update.
", "smithy.api#required": {} } }, @@ -9509,31 +9591,31 @@ "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a list of filter rules that exclude specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more\n information and examples, see Specifying what DataSync transfers by using filters.
" } }, "Schedule": { "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "Specifies a schedule used to periodically transfer files from a source to a destination\n location. You can configure your task to execute hourly, daily, weekly or on specific days of\n the week. You control when in the day or hour you want the task to execute. The time you\n specify is UTC time. For more information, see Scheduling your task.
" + "smithy.api#documentation": "Specifies a schedule for when you want your task to run. For more information, see Scheduling your\n task.
" } }, "Name": { "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "The name of the task to update.
" + "smithy.api#documentation": "Specifies the name of your task.
" } }, "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log\n group.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
" } }, "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" + "smithy.api#documentation": "Specifies include filters define the files, objects, and folders in your source location\n that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
" } }, "ManifestConfig": { diff --git a/codegen/sdk-codegen/aws-models/directory-service.2015-04-16.json b/codegen/sdk-codegen/aws-models/directory-service.2015-04-16.json index b7934404ac8..51c993f577b 100644 --- a/codegen/sdk-codegen/aws-models/directory-service.2015-04-16.json +++ b/codegen/sdk-codegen/aws-models/directory-service.2015-04-16.json @@ -3965,7 +3965,7 @@ "sdkId": "Directory Service", "arnNamespace": "ds", "cloudFormationName": "DirectoryService", - "cloudTrailEventSource": "directoryservice.amazonaws.com", + "cloudTrailEventSource": "ds.amazonaws.com", "docId": "ds-2015-04-16", "endpointPrefix": "ds" }, 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 f4dbfb295be..014ffe20b6e 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json @@ -1959,6 +1959,12 @@ "traits": { "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "The maximum on-demand throughput settings for the specified replica table being created. You can only modify MaxReadRequestUnits, because you can't modify MaxWriteRequestUnits for individual replica tables.\n
An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
\nWhen you attach a resource-based policy while creating a table, the policy creation is strongly consistent.
\nThe maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. You can’t request an increase for this limit. For a full list of all considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.
" + "smithy.api#documentation": "An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
\nWhen you attach a resource-based policy while creating a table, the policy application is strongly consistent.
\nThe maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.
" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
\nThis value will be empty if you make a request against a resource without a policy.
" + "smithy.api#documentation": "A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
\nThis value will be empty if you make a request against a resource without a policy.
" } } }, @@ -5912,7 +5930,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
\n\n GetResourcePolicy follows an \n eventually consistent\n model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, you can assume the policy will start getting applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
\n\n GetResourcePolicy follows an \n eventually consistent\n model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
" + "smithy.api#documentation": "A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
" } } }, @@ -5979,6 +5997,12 @@ "traits": { "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
The Amazon Resource Name (ARN) that uniquely identifies the index.
" } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the provisioned throughput settings for the specified global secondary\n index.
" } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" } }, "traits": { @@ -7987,6 +8020,40 @@ "target": "com.amazonaws.dynamodb#NumberAttributeValue" } }, + "com.amazonaws.dynamodb#OnDemandThroughput": { + "type": "structure", + "members": { + "MaxReadRequestUnits": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "Maximum number of read request units for the specified table.
\nTo specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
Maximum number of write request units for the specified table.
\nTo specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Maximum number of read request units for the specified replica table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Overrides the on-demand throughput settings for this replica table. If you don't specify a value for this parameter, it uses the source table's on-demand throughput settings.
" + } + }, "com.amazonaws.dynamodb#ParameterizedStatement": { "type": "structure", "members": { @@ -8595,7 +8662,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is \n eventually consistent\n .
\n\n PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId which doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
\n PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is \n eventually consistent\n .
\n\n PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
\n PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
An Amazon Web Services resource-based policy document in JSON format.
\nThe maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.
", + "smithy.api#documentation": "An Amazon Web Services resource-based policy document in JSON format.
\nThe maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.
\nWithin a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.
\nFor a full list of all considerations that apply while attaching a resource-based policy, see Resource-based policy considerations.
", "smithy.api#required": {} } }, "ExpectedRevisionId": { "target": "com.amazonaws.dynamodb#PolicyRevisionId", "traits": { - "smithy.api#documentation": "A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.
To conditionally put a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.
A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.
\nWhen you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.
To conditionally attach a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.
A unique string that represents the revision ID of the policy. If you are comparing revision IDs, make sure to always use string comparison logic.
" + "smithy.api#documentation": "A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
" } } }, @@ -9008,6 +9075,12 @@ "smithy.api#documentation": "Replica-specific provisioned throughput. If not described, uses the source table's\n provisioned throughput settings.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "Overrides the maximum on-demand throughput settings for the specified replica table.
" + } + }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescriptionList", "traits": { @@ -9049,6 +9122,12 @@ "traits": { "smithy.api#documentation": "Replica table GSI-specific provisioned throughput. If not specified, uses the source\n table GSI's read capacity settings.
" } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
" + } } }, "traits": { @@ -9124,6 +9203,12 @@ "traits": { "smithy.api#documentation": "If not described, uses the source table GSI's read capacity settings.
" } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
" + } } }, "traits": { @@ -9658,6 +9743,9 @@ "smithy.api#documentation": "Provisioned throughput settings for the restored table.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, "SSESpecificationOverride": { "target": "com.amazonaws.dynamodb#SSESpecification", "traits": { @@ -9782,6 +9870,9 @@ "smithy.api#documentation": "Provisioned throughput settings for the restored table.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, "SSESpecificationOverride": { "target": "com.amazonaws.dynamodb#SSESpecification", "traits": { @@ -10450,6 +10541,9 @@ "smithy.api#required": {} } }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, "ItemCount": { "target": "com.amazonaws.dynamodb#ItemCount", "traits": { @@ -10699,6 +10793,9 @@ "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput" }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, "SSESpecification": { "target": "com.amazonaws.dynamodb#SSESpecification" }, @@ -10853,6 +10950,12 @@ "traits": { "smithy.api#documentation": "Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
" } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "The maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
", - "smithy.api#required": {} + "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "Updates the maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "Overrides the maximum on-demand throughput for the replica table.
" + } + }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", "traits": { @@ -12314,6 +12428,12 @@ "traits": { "smithy.api#documentation": "Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
" } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The \n\t\t\tobject key is formatted as follows: role_arn/certificate_arn.
The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The \n\t\t\tobject key is formatted as follows: role_arn/certificate_arn.
The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle \n\t\t\tis stored. The object key is formated as follows: role_arn/certificate_arn.\n\t\t
The key of the Amazon S3 object where the certificate, certificate chain, and encrypted private key bundle \n\t\t\tare stored. The object key is formatted as follows: role_arn/certificate_arn.\n\t\t
The ID of the KMS customer master key (CMK) used to encrypt the private key.
", + "smithy.api#documentation": "The ID of the KMS key used to encrypt the private key.
", "smithy.api#xmlName": "encryptionKmsKeyId" } } @@ -14838,7 +14847,7 @@ "target": "com.amazonaws.ec2#CreateDhcpOptionsResult" }, "traits": { - "smithy.api#documentation": "Creates a custom set of DHCP options. After you create a DHCP option set, you associate\n\t it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly \n\t launched instances in the VPC use this set of DHCP options.
\nThe following are the individual DHCP options you can specify. For more information, see \n DHCP options sets \n in the Amazon VPC User Guide.
\n\n domain-name - If you're using AmazonProvidedDNS in us-east-1, \n specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, \n specify region.compute.internal. Otherwise, specify a custom domain name.\n This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces.\n However, Windows and other Linux operating systems treat the value as a single\n domain, which results in unexpected behavior. If your DHCP option set is\n associated with a VPC that has instances running operating systems that treat\n the value as a single domain, specify only one domain name.
\n\n domain-name-servers - The IP addresses of up to four DNS servers,\n or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, \n separate the IP addresses using commas. To have your instances receive custom DNS \n hostnames as specified in domain-name, you must specify a custom DNS\n server.
\n ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP)\n servers (four IPv4 addresses and four IPv6 addresses).
\n netbios-name-servers - The IP addresses of up to four NetBIOS name\n servers.
\n netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2. Broadcast and multicast are not supported. For more information about \n NetBIOS node types, see RFC 2132.
\n ipv6-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. \n Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent \n lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Creates a custom set of DHCP options. After you create a DHCP option set, you associate\n\t it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly \n\t launched instances in the VPC use this set of DHCP options.
\nThe following are the individual DHCP options you can specify. For more information, see \n DHCP options sets \n in the Amazon VPC User Guide.
\n\n domain-name - If you're using AmazonProvidedDNS in us-east-1, \n specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, \n specify region.compute.internal. Otherwise, specify a custom domain name.\n This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces.\n However, Windows and other Linux operating systems treat the value as a single\n domain, which results in unexpected behavior. If your DHCP option set is\n associated with a VPC that has instances running operating systems that treat\n the value as a single domain, specify only one domain name.
\n\n domain-name-servers - The IP addresses of up to four DNS servers,\n or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, \n separate the IP addresses using commas. To have your instances receive custom DNS \n hostnames as specified in domain-name, you must specify a custom DNS\n server.
\n ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP)\n servers (four IPv4 addresses and four IPv6 addresses).
\n netbios-name-servers - The IP addresses of up to four NetBIOS name\n servers.
\n netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2. Broadcast and multicast are not supported. For more information about \n NetBIOS node types, see RFC 2132.
\n ipv6-address-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. \n Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent \n lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.
\nTo clone an existing launch template as the basis for a new launch template, use the \n Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more \n information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.
", "smithy.api#examples": [ { "title": "To create a launch template", @@ -16385,7 +16394,7 @@ "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.
To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch\n template data structure.
The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.
To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch template data structure.
Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.
\nLaunch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.
\nFor more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Creates a new version of a launch template. You must specify an existing launch\n template, either by name or ID. You can determine whether the new version inherits \n parameters from a source version, and add or overwrite parameters as needed.
\nLaunch template versions are numbered in the order in which they are created. You\n can't specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes the\n changes that you require.
\nFor more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.
", "smithy.api#examples": [ { "title": "To create a launch template version", @@ -16489,19 +16498,19 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } }, "SourceVersion": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The version number of the launch template version on which to base the new version.\n The new version inherits the same launch parameters as the source version, except for\n parameters that you specify in LaunchTemplateData. Snapshots applied to the\n block device mapping are ignored when creating a new version unless they are explicitly\n included.
The version of the launch template on which to base the new version. \n Snapshots applied to the block device mapping are ignored when creating a new version \n unless they are explicitly included.
\nIf you specify this parameter, the new version inherits the launch parameters from the\n source version. If you specify additional launch parameters for the new version, they \n overwrite any corresponding launch parameters inherited from the source version.
\nIf you omit this parameter, the new version contains only the launch parameters\n that you specify for the new version.
" } }, "VersionDescription": { @@ -23356,13 +23365,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } } }, @@ -23432,13 +23441,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } }, "Versions": { @@ -25566,7 +25575,7 @@ "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableResult" }, "traits": { - "smithy.api#documentation": "Deletes the specified transit gateway route table. You must disassociate the route table from any\n transit gateway route tables before you can delete it.
" + "smithy.api#documentation": "Deletes the specified transit gateway route table. If there are any route tables associated with\n the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.
" } }, "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement": { @@ -30862,7 +30871,7 @@ "target": "com.amazonaws.ec2#DescribeImagesResult" }, "traits": { - "smithy.api#documentation": "Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
\nThe images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.
\nRecently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
\nThe images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.
\nRecently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.
\nWe strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
\nWe strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nThe ID of the launch template.
\nTo describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateId or the LaunchTemplateName, but not\n both.
To describe all the latest or default launch template versions in your account, you\n must omit this parameter.
" + "smithy.api#documentation": "The ID of the launch template.
\nTo describe one or more versions of a specified launch template, you must specify\n either the launch template ID or the launch template name, but not both.
\nTo describe all the latest or default launch template versions in your account, you\n must omit this parameter.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nTo describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateName or the LaunchTemplateId, but not\n both.
To describe all the latest or default launch template versions in your account, you\n must omit this parameter.
" + "smithy.api#documentation": "The name of the launch template.
\nTo describe one or more versions of a specified launch template, you must specify\n either the launch template name or the launch template ID, but not both.
\nTo describe all the latest or default launch template versions in your account, you\n must omit this parameter.
" } }, "Versions": { @@ -35219,6 +35228,14 @@ "smithy.api#documentation": "Indicates whether source/destination checking is enabled.
", "smithy.api#xmlName": "sourceDestCheck" } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", + "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
", + "smithy.api#xmlName": "associatePublicIpAddress" + } } }, "traits": { @@ -35322,7 +35339,7 @@ "target": "com.amazonaws.ec2#DescribeNetworkInterfacesResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your network interfaces.
\nIf you have a large number of network interfaces, the operation fails unless \n you use pagination or one of the following filters: group-id, \n mac-address, private-dns-name, private-ip-address, \n private-dns-name, subnet-id, or vpc-id.
Describes one or more of your network interfaces.
\nIf you have a large number of network interfaces, the operation fails unless \n you use pagination or one of the following filters: group-id, \n mac-address, private-dns-name, private-ip-address, \n private-dns-name, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nInformation about one or more network interfaces.
", + "smithy.api#documentation": "Information about the network interfaces.
", "smithy.api#xmlName": "networkInterfaceSet" } }, @@ -37214,7 +37231,7 @@ "target": "com.amazonaws.ec2#DescribeSnapshotsResult" }, "traits": { - "smithy.api#documentation": "Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.
\nThe snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.
\nThe create volume permissions fall into the following categories:
\n\n public: The owner of the snapshot granted create volume\n permissions for the snapshot to the all group. All Amazon Web Services accounts have create\n volume permissions for these snapshots.
\n explicit: The owner of the snapshot granted create volume\n permissions to a specific Amazon Web Services account.
\n\n implicit: An Amazon Web Services account has implicit create volume permissions\n for all snapshots it owns.
\nThe list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.
\nIf you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.
\nIf you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.
\nTo get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
\nFor more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
", + "smithy.api#documentation": "Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.
\nThe snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.
\nThe create volume permissions fall into the following categories:
\n\n public: The owner of the snapshot granted create volume\n permissions for the snapshot to the all group. All Amazon Web Services accounts have create\n volume permissions for these snapshots.
\n explicit: The owner of the snapshot granted create volume\n permissions to a specific Amazon Web Services account.
\n\n implicit: An Amazon Web Services account has implicit create volume permissions\n for all snapshots it owns.
\nThe list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.
\nIf you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.
\nIf you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.
\nTo get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
\nFor more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
\nWe strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nDescribes the specified tags for your EC2 resources.
\nFor more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the specified tags for your EC2 resources.
\nFor more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide.
\nWe strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nThe filters.
\n\n key - The tag key.
\n resource-id - The ID of the resource.
\n resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
\n tag:
\n value - The tag value.
The filters.
\n\n key - The tag key.
\n resource-id - The ID of the resource.
\n resource-type - The resource type. For a list of possible values, see \n TagSpecification.
\n tag:
\n value - The tag value.
One or more filters. The possible values are:
\n\n options.propagation-default-route-table-id - The ID of the default propagation route table.
\n options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
\n options.association-default-route-table-id - The ID of the default association route table.
\n options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
\n options.default-route-table-association - Indicates whether resource attachments are automatically \n associated with the default association route table (enable | disable).
\n options.default-route-table-propagation - Indicates whether resource attachments automatically propagate \n routes to the default propagation route table (enable | disable).
\n options.dns-support - Indicates whether DNS support is enabled (enable | disable).
\n options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
\n owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
\n state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
\n transit-gateway-id - The ID of the transit gateway.
One or more filters. The possible values are:
\n\n options.propagation-default-route-table-id - The ID of the default propagation route table.
\n options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
\n options.association-default-route-table-id - The ID of the default association route table.
\n options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
\n options.default-route-table-association - Indicates whether resource attachments are automatically \n associated with the default association route table (enable | disable).
\n options.default-route-table-propagation - Indicates whether resource attachments automatically propagate \n routes to the default propagation route table (enable | disable).
\n options.dns-support - Indicates whether DNS support is enabled (enable | disable).
\n options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
\n owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
\n state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
\n transit-gateway-id - The ID of the transit gateway.
\n tag-key - The key/value combination of a tag assigned to the resource. Use the\n tag key in the filter name and the tag value as the filter value. For example, to\n find all resources that have a tag with the key Owner and the value TeamA, specify\n tag:Owner for the filter name and TeamA for the filter value.
Describes the specified EBS volumes or all of your EBS volumes.
\nIf you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. For more information, see Pagination.
\nFor more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the specified EBS volumes or all of your EBS volumes.
\nIf you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. For more information, see Pagination.
\nFor more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
\nWe strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDisables deregistration protection for an AMI. When deregistration protection is disabled,\n the AMI can be deregistered.
\nIf you chose to include a 24-hour cooldown period when you enabled deregistration\n protection for the AMI, then, when you disable deregistration protection, you won’t\n immediately be able to deregister the AMI.
\nFor more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.
" + } + }, + "com.amazonaws.ec2#DisableImageDeregistrationProtectionRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the AMI.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Enables deregistration protection for an AMI. When deregistration protection is enabled,\n the AMI can't be deregistered.
\nTo allow the AMI to be deregistered, you must first disable deregistration protection\n using DisableImageDeregistrationProtection.
\nFor more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.
" + } + }, + "com.amazonaws.ec2#EnableImageDeregistrationProtectionRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the AMI.
", + "smithy.api#required": {} + } + }, + "WithCooldown": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "If true, enforces deregistration protection for 24 hours after deregistration\n protection is disabled.
Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Gets the public endorsement key associated with the Nitro Trusted \n Platform Module (NitroTPM) for the specified instance.
" + } + }, + "com.amazonaws.ec2#GetInstanceTpmEkPubRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the instance for which to get the public endorsement key.
", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "KeyType": { + "target": "com.amazonaws.ec2#EkPubKeyType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The required public endorsement key type.
", + "smithy.api#required": {} + } + }, + "KeyFormat": { + "target": "com.amazonaws.ec2#EkPubKeyFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The required public endorsement key format. Specify der for a DER-encoded public \n key that is compatible with OpenSSL. Specify tpmt for a TPM 2.0 format that is \n compatible with tpm2-tools. The returned key is base64 encoded.
Specify this parameter to verify whether the request will succeed, without actually making the \n request. If the request will succeed, the response is DryRunOperation. Otherwise, \n the response is UnauthorizedOperation.
The ID of the instance.
", + "smithy.api#xmlName": "instanceId" + } + }, + "KeyType": { + "target": "com.amazonaws.ec2#EkPubKeyType", + "traits": { + "aws.protocols#ec2QueryName": "KeyType", + "smithy.api#documentation": "The public endorsement key type.
", + "smithy.api#xmlName": "keyType" + } + }, + "KeyFormat": { + "target": "com.amazonaws.ec2#EkPubKeyFormat", + "traits": { + "aws.protocols#ec2QueryName": "KeyFormat", + "smithy.api#documentation": "The public endorsement key format.
", + "smithy.api#xmlName": "keyFormat" + } + }, + "KeyValue": { + "target": "com.amazonaws.ec2#EkPubKeyValue", + "traits": { + "aws.protocols#ec2QueryName": "KeyValue", + "smithy.api#documentation": "The public endorsement key material.
", + "smithy.api#xmlName": "keyValue" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements": { "type": "operation", "input": { @@ -55850,6 +56104,22 @@ "smithy.api#documentation": "The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using\n CreateImage.
", "smithy.api#xmlName": "sourceInstanceId" } + }, + "DeregistrationProtection": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeregistrationProtection", + "smithy.api#documentation": "Indicates whether deregistration protection is enabled for the AMI.
", + "smithy.api#xmlName": "deregistrationProtection" + } + }, + "LastLaunchedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastLaunchedTime", + "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the AMI was last used to launch an EC2 instance. When the AMI is used\n to launch an instance, there is a 24-hour delay before that usage is reported.
\n\n lastLaunchedTime data is available starting April 2017.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.
Indicates whether deregistration protection is enabled for the AMI.
", + "smithy.api#xmlName": "deregistrationProtection" + } } }, "traits": { @@ -56042,6 +56320,12 @@ "traits": { "smithy.api#enumValue": "imdsSupport" } + }, + "deregistrationProtection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deregistrationProtection" + } } } }, @@ -70973,7 +71257,7 @@ "DeviceIndex": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The device index for the network interface attachment.
" + "smithy.api#documentation": "The device index for the network interface attachment. Each network interface requires\n a device index. If you create a launch template that includes secondary network interfaces \n but not a primary network interface, then you must add a primary network interface as a \n launch parameter when you launch an instance from the template.
" } }, "Groups": { @@ -71450,24 +71734,24 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } }, "Version": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The launch template version number, $Latest, or\n $Default.
If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.
If the value is $Default, Amazon EC2 uses the default version of the\n launch template.
Default: The default version of the launch template.
" + "smithy.api#documentation": "The launch template version number, $Latest, or\n $Default.
A value of $Latest uses the latest version of the launch template.
A value of $Default uses the default version of the launch template.
Default: The default version of the launch template.
" } } }, "traits": { - "smithy.api#documentation": "The launch template to use. You must specify either the launch template ID or launch\n template name in the request, but not both.
" + "smithy.api#documentation": "Describes the launch template to use.
" } }, "com.amazonaws.ec2#LaunchTemplateSpotMarketOptions": { @@ -75917,13 +76201,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.
The ID of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.
The name of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" } }, "DefaultVersion": { @@ -76235,6 +76519,12 @@ "traits": { "smithy.api#documentation": "A connection tracking specification.
" } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
" + } } }, "traits": { @@ -81162,6 +81452,12 @@ "traits": { "smithy.api#enumValue": "attachment" } + }, + "associatePublicIpAddress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associatePublicIpAddress" + } } } }, @@ -91960,7 +92256,7 @@ "LaunchTemplate": { "target": "com.amazonaws.ec2#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "The launch template to use to launch the instances. Any parameters that you specify in\n RunInstances override the same parameters in the launch template.\n You can specify either the name or ID of a launch template, but not both.
" + "smithy.api#documentation": "The launch template. Any additional parameters that you specify for the new instance \n overwrite the corresponding parameters included in the launch template.
" } }, "InstanceMarketOptions": { @@ -104726,7 +105022,7 @@ "target": "com.amazonaws.ec2#VolumeAttachmentList", "traits": { "aws.protocols#ec2QueryName": "AttachmentSet", - "smithy.api#documentation": "Information about the volume attachments.
", + "smithy.api#documentation": "This parameter is not returned by CreateVolume.
\nInformation about the volume attachments.
", "smithy.api#xmlName": "attachmentSet" } }, @@ -104830,7 +105126,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "FastRestored", - "smithy.api#documentation": "Indicates whether the volume was created using fast snapshot restore.
", + "smithy.api#documentation": "This parameter is not returned by CreateVolume.
\nIndicates whether the volume was created using fast snapshot restore.
", "smithy.api#xmlName": "fastRestored" } }, @@ -104854,7 +105150,7 @@ "target": "com.amazonaws.ec2#SSEType", "traits": { "aws.protocols#ec2QueryName": "SseType", - "smithy.api#documentation": "Reserved for future use.
", + "smithy.api#documentation": "This parameter is not returned by CreateVolume.
\nReserved for future use.
", "smithy.api#xmlName": "sseType" } } diff --git a/codegen/sdk-codegen/aws-models/efs.2015-02-01.json b/codegen/sdk-codegen/aws-models/efs.2015-02-01.json index e40d01229c1..2e1c12e7bac 100644 --- a/codegen/sdk-codegen/aws-models/efs.2015-02-01.json +++ b/codegen/sdk-codegen/aws-models/efs.2015-02-01.json @@ -2776,7 +2776,7 @@ "sdkId": "EFS", "arnNamespace": "elasticfilesystem", "cloudFormationName": "EFS", - "cloudTrailEventSource": "efs.amazonaws.com", + "cloudTrailEventSource": "elasticfilesystem.amazonaws.com", "docId": "elasticfilesystem-2015-02-01", "endpointPrefix": "elasticfilesystem" }, diff --git a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json index 8568f0edc79..6a6adc3e468 100644 --- a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json +++ b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json @@ -3825,7 +3825,7 @@ "sdkId": "Elastic Load Balancing v2", "arnNamespace": "elasticloadbalancing", "cloudFormationName": "ElasticLoadBalancingV2", - "cloudTrailEventSource": "elasticloadbalancingv2.amazonaws.com", + "cloudTrailEventSource": "elasticloadbalancing.amazonaws.com", "docId": "elasticloadbalancingv2-2015-12-01", "endpointPrefix": "elasticloadbalancing" }, diff --git a/codegen/sdk-codegen/aws-models/emr-containers.2020-10-01.json b/codegen/sdk-codegen/aws-models/emr-containers.2020-10-01.json index dd5671fca8b..a482c697079 100644 --- a/codegen/sdk-codegen/aws-models/emr-containers.2020-10-01.json +++ b/codegen/sdk-codegen/aws-models/emr-containers.2020-10-01.json @@ -39,6 +39,26 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\\d{12}):certificate/.+$" } }, + "com.amazonaws.emrcontainers#AuthorizationConfiguration": { + "type": "structure", + "members": { + "lakeFormationConfiguration": { + "target": "com.amazonaws.emrcontainers#LakeFormationConfiguration", + "traits": { + "smithy.api#documentation": "Lake Formation related configuration inputs for the security\n configuration.
" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.emrcontainers#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Encryption-related configuration input for the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Authorization-related configuration inputs for the security configuration.
" + } + }, "com.amazonaws.emrcontainers#AwsChicagoWebService": { "type": "service", "version": "2020-10-01", @@ -52,6 +72,9 @@ { "target": "com.amazonaws.emrcontainers#CreateManagedEndpoint" }, + { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfiguration" + }, { "target": "com.amazonaws.emrcontainers#CreateVirtualCluster" }, @@ -73,6 +96,9 @@ { "target": "com.amazonaws.emrcontainers#DescribeManagedEndpoint" }, + { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfiguration" + }, { "target": "com.amazonaws.emrcontainers#DescribeVirtualCluster" }, @@ -88,6 +114,9 @@ { "target": "com.amazonaws.emrcontainers#ListManagedEndpoints" }, + { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurations" + }, { "target": "com.amazonaws.emrcontainers#ListTagsForResource" }, @@ -1110,6 +1139,17 @@ "smithy.api#documentation": "The entity representing certificate data generated for managed endpoint.
" } }, + "com.amazonaws.emrcontainers#CertificateProviderType": { + "type": "enum", + "members": { + "PEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PEM" + } + } + } + }, "com.amazonaws.emrcontainers#ClientToken": { "type": "string", "traits": { @@ -1520,6 +1560,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.emrcontainers#CreateSecurityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a security configuration. Security configurations in Amazon EMR on EKS are\n templates for different security setups. You can use security configurations to configure\n the Lake Formation integration setup. You can also create a security configuration\n to re-use a security setup each time you create a virtual cluster.
", + "smithy.api#http": { + "method": "POST", + "uri": "/securityconfigurations", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "The client idempotency token to use when creating the security configuration.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "The name of the security configuration.
", + "smithy.api#required": {} + } + }, + "securityConfigurationData": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", + "traits": { + "smithy.api#documentation": "Security configuration input for the request.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "The tags to add to the security configuration.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "The name of the security configuration.
" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the security configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emrcontainers#CreateVirtualCluster": { "type": "operation", "input": { @@ -1581,6 +1708,12 @@ "traits": { "smithy.api#documentation": "The tags assigned to the virtual cluster.
" } + }, + "securityConfigurationId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
" + } } }, "traits": { @@ -2012,6 +2145,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.emrcontainers#DescribeSecurityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Displays detailed information about a specified security configuration. Security\n configurations in Amazon EMR on EKS are templates for different security setups. You\n can use security configurations to configure the Lake Formation integration setup.\n You can also create a security configuration to re-use a security setup each time you\n create a virtual cluster.
", + "smithy.api#http": { + "method": "GET", + "uri": "/securityconfigurations/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse": { + "type": "structure", + "members": { + "securityConfiguration": { + "target": "com.amazonaws.emrcontainers#SecurityConfiguration", + "traits": { + "smithy.api#documentation": "Details of the security configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emrcontainers#DescribeVirtualCluster": { "type": "operation", "input": { @@ -2097,6 +2288,20 @@ "smithy.api#documentation": "The information about the Amazon EKS cluster.
" } }, + "com.amazonaws.emrcontainers#EncryptionConfiguration": { + "type": "structure", + "members": { + "inTransitEncryptionConfiguration": { + "target": "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "In-transit encryption-related input for the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations related to encryption for the security configuration.
" + } + }, "com.amazonaws.emrcontainers#Endpoint": { "type": "structure", "members": { @@ -2482,6 +2687,20 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" } }, + "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration": { + "type": "structure", + "members": { + "tlsCertificateConfiguration": { + "target": "com.amazonaws.emrcontainers#TLSCertificateConfiguration", + "traits": { + "smithy.api#documentation": "TLS certificate-related configuration input for the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations related to in-transit encryption for the security configuration.
" + } + }, "com.amazonaws.emrcontainers#InternalServerException": { "type": "structure", "members": { @@ -2854,6 +3073,32 @@ "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } }, + "com.amazonaws.emrcontainers#LakeFormationConfiguration": { + "type": "structure", + "members": { + "authorizedSessionTagValue": { + "target": "com.amazonaws.emrcontainers#SessionTagValue", + "traits": { + "smithy.api#documentation": "The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.
" + } + }, + "secureNamespaceInfo": { + "target": "com.amazonaws.emrcontainers#SecureNamespaceInfo", + "traits": { + "smithy.api#documentation": "The namespace input of the system job.
" + } + }, + "queryEngineRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The query engine IAM role ARN that is tied to the secure Spark job. The\n QueryEngine role assumes the JobExecutionRole to execute all\n the Lake Formation calls.
Lake Formation related configuration inputs for the security\n configuration.
" + } + }, "com.amazonaws.emrcontainers#ListJobRuns": { "type": "operation", "input": { @@ -3159,6 +3404,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.emrcontainers#ListSecurityConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists security configurations based on a set of parameters. Security configurations in\n Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.
", + "smithy.api#http": { + "method": "GET", + "uri": "/securityconfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "securityConfigurations", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest": { + "type": "structure", + "members": { + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "The date and time after which the security configuration was created.
", + "smithy.api#httpQuery": "createdAfter" + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "The date and time before which the security configuration was created.
", + "smithy.api#httpQuery": "createdBefore" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "The maximum number of security configurations the operation can list.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of security configurations to return.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse": { + "type": "structure", + "members": { + "securityConfigurations": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurations", + "traits": { + "smithy.api#documentation": "The list of returned security configurations.
" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of security configurations to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emrcontainers#ListTagsForResource": { "type": "operation", "input": { @@ -3651,6 +3983,116 @@ "smithy.api#documentation": "Amazon S3 configuration for monitoring log publishing. You can configure your jobs to\n send log information to Amazon S3.
" } }, + "com.amazonaws.emrcontainers#SecretsManagerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):secretsmanager:.+:(\\d{12}):secret:[0-9a-zA-Z/_+=.@-]+$" + } + }, + "com.amazonaws.emrcontainers#SecureNamespaceInfo": { + "type": "structure", + "members": { + "clusterId": { + "target": "com.amazonaws.emrcontainers#ClusterId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.
" + } + }, + "namespace": { + "target": "com.amazonaws.emrcontainers#KubernetesNamespace", + "traits": { + "smithy.api#documentation": "The namespace of the Amazon EKS cluster where the system jobs run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Namespace inputs for the system job.
" + } + }, + "com.amazonaws.emrcontainers#SecurityConfiguration": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "The name of the security configuration.
" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the security configuration.
" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "The date and time that the job run was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "The user who created the job run.
" + } + }, + "securityConfigurationData": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", + "traits": { + "smithy.api#documentation": "Security configuration inputs for the request.
" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "The tags to assign to the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Inputs related to the security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.
" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/securityconfigurations\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurationData": { + "type": "structure", + "members": { + "authorizationConfiguration": { + "target": "com.amazonaws.emrcontainers#AuthorizationConfiguration", + "traits": { + "smithy.api#documentation": "Authorization-related configuration input for the security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations related to the security configuration for the request.
" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#SecurityConfiguration" + } + }, "com.amazonaws.emrcontainers#SensitivePropertiesMap": { "type": "map", "key": { @@ -3667,6 +4109,16 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.emrcontainers#SessionTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9 ]+$" + } + }, "com.amazonaws.emrcontainers#SparkSqlJobDriver": { "type": "structure", "members": { @@ -3930,6 +4382,32 @@ "target": "com.amazonaws.emrcontainers#String256" } }, + "com.amazonaws.emrcontainers#TLSCertificateConfiguration": { + "type": "structure", + "members": { + "certificateProviderType": { + "target": "com.amazonaws.emrcontainers#CertificateProviderType", + "traits": { + "smithy.api#documentation": "The TLS certificate type. Acceptable values: PEM or\n Custom.
Secrets Manager ARN that contains the public TLS certificate contents, used for\n communication between the user job and the system job.
" + } + }, + "privateCertificateSecretArn": { + "target": "com.amazonaws.emrcontainers#SecretsManagerArn", + "traits": { + "smithy.api#documentation": "Secrets Manager ARN that contains the private TLS certificate contents, used for\n communication between the user job and the system job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations related to the TLS certificate for the security configuration.
" + } + }, "com.amazonaws.emrcontainers#TagKeyList": { "type": "list", "member": { @@ -4238,6 +4716,12 @@ "traits": { "smithy.api#documentation": "The assigned tags of the virtual cluster.
" } + }, + "securityConfigurationId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "The ID of the security configuration.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/emr.2009-03-31.json b/codegen/sdk-codegen/aws-models/emr.2009-03-31.json index fdcf84502a3..52a90fa4e39 100644 --- a/codegen/sdk-codegen/aws-models/emr.2009-03-31.json +++ b/codegen/sdk-codegen/aws-models/emr.2009-03-31.json @@ -2833,7 +2833,7 @@ "sdkId": "EMR", "arnNamespace": "elasticmapreduce", "cloudFormationName": "EMR", - "cloudTrailEventSource": "emr.amazonaws.com", + "cloudTrailEventSource": "elasticmapreduce.amazonaws.com", "docId": "elasticmapreduce-2009-03-31", "endpointPrefix": "elasticmapreduce" }, diff --git a/codegen/sdk-codegen/aws-models/entityresolution.2018-05-10.json b/codegen/sdk-codegen/aws-models/entityresolution.2018-05-10.json index c7317cb8031..e72464b596e 100644 --- a/codegen/sdk-codegen/aws-models/entityresolution.2018-05-10.json +++ b/codegen/sdk-codegen/aws-models/entityresolution.2018-05-10.json @@ -8,6 +8,9 @@ { "target": "com.amazonaws.entityresolution#AddPolicyStatement" }, + { + "target": "com.amazonaws.entityresolution#BatchDeleteUniqueId" + }, { "target": "com.amazonaws.entityresolution#CreateIdMappingWorkflow" }, @@ -976,6 +979,102 @@ "target": "com.amazonaws.entityresolution#AwsAccountId" } }, + "com.amazonaws.entityresolution#BatchDeleteUniqueId": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#BatchDeleteUniqueIdInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#BatchDeleteUniqueIdOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes multiple unique IDs in a matching workflow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/matchingworkflows/{workflowName}/uniqueids" + } + } + }, + "com.amazonaws.entityresolution#BatchDeleteUniqueIdInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "inputSource": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The input source for the batch delete unique ID operation.
", + "smithy.api#httpHeader": "inputSource", + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$" + } + }, + "uniqueIds": { + "target": "com.amazonaws.entityresolution#UniqueIdList", + "traits": { + "smithy.api#documentation": "The unique IDs to delete.
", + "smithy.api#httpHeader": "uniqueIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#BatchDeleteUniqueIdOutput": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.entityresolution#DeleteUniqueIdStatus", + "traits": { + "smithy.api#documentation": "The status of the batch delete unique ID operation.
", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.entityresolution#DeleteUniqueIdErrorsList", + "traits": { + "smithy.api#documentation": "The errors from deleting multiple unique IDs.
", + "smithy.api#required": {} + } + }, + "deleted": { + "target": "com.amazonaws.entityresolution#DeletedUniqueIdList", + "traits": { + "smithy.api#documentation": "The unique IDs that were deleted.
", + "smithy.api#required": {} + } + }, + "disconnectedUniqueIds": { + "target": "com.amazonaws.entityresolution#DisconnectedUniqueIdsList", + "traits": { + "smithy.api#documentation": "The unique IDs that were disconnected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.entityresolution#ConflictException": { "type": "structure", "members": { @@ -1915,6 +2014,89 @@ "smithy.api#output": {} } }, + "com.amazonaws.entityresolution#DeleteUniqueIdError": { + "type": "structure", + "members": { + "uniqueId": { + "target": "com.amazonaws.entityresolution#UniqueId", + "traits": { + "smithy.api#documentation": "The unique ID that could not be deleted.
", + "smithy.api#required": {} + } + }, + "errorType": { + "target": "com.amazonaws.entityresolution#DeleteUniqueIdErrorType", + "traits": { + "smithy.api#documentation": "The error type for the batch delete unique ID operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Delete Unique Id error.
" + } + }, + "com.amazonaws.entityresolution#DeleteUniqueIdErrorType": { + "type": "enum", + "members": { + "SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_ERROR" + } + }, + "VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_ERROR" + } + } + } + }, + "com.amazonaws.entityresolution#DeleteUniqueIdErrorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#DeleteUniqueIdError" + } + }, + "com.amazonaws.entityresolution#DeleteUniqueIdStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "ACCEPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPTED" + } + } + } + }, + "com.amazonaws.entityresolution#DeletedUniqueId": { + "type": "structure", + "members": { + "uniqueId": { + "target": "com.amazonaws.entityresolution#UniqueId", + "traits": { + "smithy.api#documentation": "The unique ID of the deleted item.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The deleted unique ID.
" + } + }, + "com.amazonaws.entityresolution#DeletedUniqueIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#DeletedUniqueId" + } + }, "com.amazonaws.entityresolution#Description": { "type": "string", "traits": { @@ -1923,6 +2105,12 @@ } } }, + "com.amazonaws.entityresolution#DisconnectedUniqueIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#UniqueId" + } + }, "com.amazonaws.entityresolution#EntityName": { "type": "string", "traits": { @@ -4861,7 +5049,7 @@ "smithy.api#length": { "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z_0-9-.@ ()+\\t]*$" + "smithy.api#pattern": "^[a-zA-Z_0-9-./@ ()+\\t]*$" } }, "traits": { @@ -4986,7 +5174,7 @@ "smithy.api#documentation": "A list of Rule objects, each of which have fields RuleName and\n MatchingKeys.
The current status of the request to onboard a member account as an Firewall Manager administator.
\n\n ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
\n ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.
\n OFFBOARDING - The account is being removed as an Firewall Manager administrator.
\n OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
The current status of the request to onboard a member account as an Firewall Manager administrator.
\n\n ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
\n ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.
\n OFFBOARDING - The account is being removed as an Firewall Manager administrator.
\n OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
Brief description of this remediation action.
" + } + }, + "Vpc": { + "target": "com.amazonaws.fms#ActionTarget", + "traits": { + "smithy.api#documentation": "The VPC that's associated with the remediation action.
" + } + }, + "FMSCanRemediate": { + "target": "com.amazonaws.fms#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the CreateNetworkAcl action in Amazon EC2. This is a remediation option in RemediationAction.
Brief description of this remediation action.
" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.fms#ActionTarget", + "traits": { + "smithy.api#documentation": "The network ACL that's associated with the remediation action.
" + } + }, + "NetworkAclEntriesToBeCreated": { + "target": "com.amazonaws.fms#EntriesDescription", + "traits": { + "smithy.api#documentation": "Lists the entries that the remediation action would create.
" + } + }, + "FMSCanRemediate": { + "target": "com.amazonaws.fms#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the CreateNetworkAclEntries action in Amazon EC2. This is a remediation option in RemediationAction.
Brief description of this remediation action.
" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.fms#ActionTarget", + "traits": { + "smithy.api#documentation": "The network ACL that's associated with the remediation action.
" + } + }, + "NetworkAclEntriesToBeDeleted": { + "target": "com.amazonaws.fms#EntriesDescription", + "traits": { + "smithy.api#documentation": "Lists the entries that the remediation action would delete.
" + } + }, + "FMSCanRemediate": { + "target": "com.amazonaws.fms#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the DeleteNetworkAclEntries action in Amazon EC2. This is a remediation option in RemediationAction.
Information about the ReplaceRouteTableAssociation action in Amazon EC2.
" } }, + "com.amazonaws.fms#EntriesDescription": { + "type": "list", + "member": { + "target": "com.amazonaws.fms#EntryDescription" + } + }, + "com.amazonaws.fms#EntriesWithConflicts": { + "type": "list", + "member": { + "target": "com.amazonaws.fms#EntryDescription" + } + }, + "com.amazonaws.fms#EntryDescription": { + "type": "structure", + "members": { + "EntryDetail": { + "target": "com.amazonaws.fms#NetworkAclEntry", + "traits": { + "smithy.api#documentation": "Describes a rule in a network ACL.
\nEach network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining\nwhether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the\n entries in the network ACL according to the rule numbers, in ascending order.
\nWhen you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, \n you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order \n that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.
" + } + }, + "EntryRuleNumber": { + "target": "com.amazonaws.fms#IntegerObjectMinimum0", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The rule number for the entry. ACL entries are processed in ascending order by rule number. In a Firewall Manager network ACL policy, Firewall Manager \n assigns rule numbers.
" + } + }, + "EntryType": { + "target": "com.amazonaws.fms#EntryType", + "traits": { + "smithy.api#documentation": "Specifies whether the entry is managed by Firewall Manager or by a user, and, for Firewall Manager-managed entries, specifies whether the entry \n is among those that run first in the network ACL or those that run last.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a single rule in a network ACL.
" + } + }, + "com.amazonaws.fms#EntryType": { + "type": "enum", + "members": { + "FMSManagedFirstEntry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FMS_MANAGED_FIRST_ENTRY" + } + }, + "FMSManagedLastEntry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FMS_MANAGED_LAST_ENTRY" + } + }, + "CustomEntry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_ENTRY" + } + } + } + }, + "com.amazonaws.fms#EntryViolation": { + "type": "structure", + "members": { + "ExpectedEntry": { + "target": "com.amazonaws.fms#EntryDescription", + "traits": { + "smithy.api#documentation": "The Firewall Manager-managed network ACL entry that is involved in the entry violation.
" + } + }, + "ExpectedEvaluationOrder": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "The evaluation location within the ordered list of entries where the ExpectedEntry should be, according to the network ACL policy specifications.
The evaluation location within the ordered list of entries where the ExpectedEntry is currently located.
The entry that's currently in the ExpectedEvaluationOrder location, in place of the expected entry.
The list of entries that are in conflict with ExpectedEntry.
Descriptions of the violations that Firewall Manager found for these entries.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about an entry violation in a network ACL. The violation is against the network ACL specification inside the\n Firewall Manager network ACL policy. This data object is part of InvalidNetworkAclEntriesViolation.
Returns information about the specified account's administrative scope. The admistrative scope defines the resources that an Firewall Manager administrator can manage.
" + "smithy.api#documentation": "Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.
" } }, "com.amazonaws.fms#GetAdminScopeRequest": { @@ -3222,7 +3459,7 @@ "AdminAccount": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { - "smithy.api#documentation": "The administator account that you want to get the details for.
", + "smithy.api#documentation": "The administrator account that you want to get the details for.
", "smithy.api#required": {} } } @@ -3243,7 +3480,7 @@ "Status": { "target": "com.amazonaws.fms#OrganizationStatus", "traits": { - "smithy.api#documentation": "The current status of the request to onboard a member account as an Firewall Manager administator.
\n\n ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
\n ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.
\n OFFBOARDING - The account is being removed as an Firewall Manager administrator.
\n OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
The current status of the request to onboard a member account as an Firewall Manager administrator.
\n\n ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
\n ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.
\n OFFBOARDING - The account is being removed as an Firewall Manager administrator.
\n OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
Returns detailed compliance information about the specified member account. Details\n include resources that are in and out of compliance with the specified policy.
\nResources are\n considered noncompliant for WAF and Shield Advanced policies if the specified policy has\n not been applied to them.
\nResources are considered noncompliant for security group policies if\n they are in scope of the policy, they violate one or more of the policy rules, and remediation\n is disabled or not possible.
\nResources are considered noncompliant for Network Firewall policies\n if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet,\n if a subnet created by the Firewall Manager doesn't have the expected route table,\n and for modifications to a firewall policy that violate the Firewall Manager policy's rules.
\nResources are considered noncompliant for DNS Firewall policies\n if a DNS Firewall rule group is missing from the rule group associations for the VPC.
\nReturns detailed compliance information about the specified member account. Details\n include resources that are in and out of compliance with the specified policy.
\nThe reasons for resources being considered compliant depend on the Firewall Manager policy type.
" } }, "com.amazonaws.fms#GetComplianceDetailRequest": { @@ -3807,7 +4044,7 @@ "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "The ID of the Firewall Manager policy that you want the details for. You can get violation details for the following policy types:
\nDNS Firewall
\nImported Network Firewall
\nNetwork Firewall
\nSecurity group content audit
\nThird-party firewall
\nThe ID of the Firewall Manager policy that you want the details for. You can get violation details for the following policy types:
\nDNS Firewall
\nImported Network Firewall
\nNetwork Firewall
\nSecurity group content audit
\nNetwork ACL
\nThird-party firewall
\nThe VPC where the violation was found.
" + } + }, + "Subnet": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "The subnet that's associated with the network ACL.
" + } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "The Availability Zone where the network ACL is in use.
" + } + }, + "CurrentAssociatedNetworkAcl": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "The network ACL containing the entry violations.
" + } + }, + "EntryViolations": { + "target": "com.amazonaws.fms#EntryViolations", + "traits": { + "smithy.api#documentation": "Detailed information about the entry violations in the network ACL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Violation detail for the entries in a network ACL resource.
" + } + }, "com.amazonaws.fms#InvalidOperationException": { "type": "structure", "members": { @@ -3933,6 +4236,15 @@ "target": "com.amazonaws.fms#DetailedInfo" } }, + "com.amazonaws.fms#LengthBoundedNonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.fms#LengthBoundedString": { "type": "string", "traits": { @@ -3998,13 +4310,13 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
The definition of the first and last rules for the network ACL policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a Firewall Manager network ACL policy. This is used in the PolicyOption of a SecurityServicePolicyData for a Policy, when \n the SecurityServicePolicyData type is set to NETWORK_ACL_COMMON.
For information about network ACLs, see \n Control traffic to subnets using network ACLs \n in the Amazon Virtual Private Cloud User Guide.
" + } + }, + "com.amazonaws.fms#NetworkAclEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.fms#NetworkAclEntry" + } + }, + "com.amazonaws.fms#NetworkAclEntry": { + "type": "structure", + "members": { + "IcmpTypeCode": { + "target": "com.amazonaws.fms#NetworkAclIcmpTypeCode", + "traits": { + "smithy.api#documentation": "ICMP protocol: The ICMP type and code.
" + } + }, + "Protocol": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "The protocol number. A value of \"-1\" means all protocols.
", + "smithy.api#required": {} + } + }, + "PortRange": { + "target": "com.amazonaws.fms#NetworkAclPortRange", + "traits": { + "smithy.api#documentation": "TCP or UDP protocols: The range of ports the rule applies to.
" + } + }, + "CidrBlock": { + "target": "com.amazonaws.fms#LengthBoundedNonEmptyString", + "traits": { + "smithy.api#documentation": "The IPv4 network range to allow or deny, in CIDR notation.
" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.fms#LengthBoundedNonEmptyString", + "traits": { + "smithy.api#documentation": "The IPv6 network range to allow or deny, in CIDR notation.
" + } + }, + "RuleAction": { + "target": "com.amazonaws.fms#NetworkAclRuleAction", + "traits": { + "smithy.api#documentation": "Indicates whether to allow or deny the traffic that matches the rule.
", + "smithy.api#required": {} + } + }, + "Egress": { + "target": "com.amazonaws.fms#BooleanObject", + "traits": { + "smithy.api#documentation": "Indicates whether the rule is an egress, or outbound, rule (applied to traffic leaving the subnet). If it's not\n an egress rule, then it's an ingress, or inbound, rule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a rule in a network ACL.
\nEach network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining\nwhether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the\n entries in the network ACL according to the rule numbers, in ascending order.
\nWhen you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, \n you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order \n that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.
" + } + }, + "com.amazonaws.fms#NetworkAclEntrySet": { + "type": "structure", + "members": { + "FirstEntries": { + "target": "com.amazonaws.fms#NetworkAclEntries", + "traits": { + "smithy.api#documentation": "The rules that you want to run first in the Firewall Manager managed network ACLs.
\nProvide these in the order in which you want them to run. Firewall Manager will assign\n the specific rule numbers for you, in the network ACLs that it creates.
\nYou must specify at least one first entry or one last entry in any network ACL policy.
" + } + }, + "ForceRemediateForFirstEntries": { + "target": "com.amazonaws.fms#BooleanObject", + "traits": { + "smithy.api#documentation": "Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.
\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \nNetwork access control list (ACL) policies \n in the Firewall Manager Developer Guide.
", + "smithy.api#required": {} + } + }, + "LastEntries": { + "target": "com.amazonaws.fms#NetworkAclEntries", + "traits": { + "smithy.api#documentation": "The rules that you want to run last in the Firewall Manager managed network ACLs.
\nProvide these in the order in which you want them to run. Firewall Manager will assign\n the specific rule numbers for you, in the network ACLs that it creates.
\nYou must specify at least one first entry or one last entry in any network ACL policy.
" + } + }, + "ForceRemediateForLastEntries": { + "target": "com.amazonaws.fms#BooleanObject", + "traits": { + "smithy.api#documentation": "Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.
\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \nNetwork access control list (ACL) policies \n in the Firewall Manager Developer Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the first and last rules for the network ACL policy, and the remediation settings for each.
" + } + }, + "com.amazonaws.fms#NetworkAclIcmpTypeCode": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.fms#IntegerObject", + "traits": { + "smithy.api#documentation": "ICMP code.
" + } + }, + "Type": { + "target": "com.amazonaws.fms#IntegerObject", + "traits": { + "smithy.api#documentation": "ICMP type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "ICMP protocol: The ICMP type and code.
" + } + }, + "com.amazonaws.fms#NetworkAclPortRange": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.fms#IPPortNumberInteger", + "traits": { + "smithy.api#documentation": "The beginning port number of the range.
" + } + }, + "To": { + "target": "com.amazonaws.fms#IPPortNumberInteger", + "traits": { + "smithy.api#documentation": "The ending port number of the range.
" + } + } + }, + "traits": { + "smithy.api#documentation": "TCP or UDP protocols: The range of ports the rule applies to.
" + } + }, + "com.amazonaws.fms#NetworkAclRuleAction": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow" + } + }, + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deny" + } + } + } + }, "com.amazonaws.fms#NetworkFirewallAction": { "type": "string", "traits": { @@ -5608,7 +6085,7 @@ "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { - "smithy.api#documentation": "The type of resource protected by or in scope of the policy. This is in the format shown\n in the Amazon Web Services Resource Types Reference.\n To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.
The following are valid resource types for each Firewall Manager policy type:
\nAmazon Web Services WAF Classic - AWS::ApiGateway::Stage, AWS::CloudFront::Distribution, and AWS::ElasticLoadBalancingV2::LoadBalancer.
WAF - AWS::ApiGateway::Stage, AWS::ElasticLoadBalancingV2::LoadBalancer, and AWS::CloudFront::Distribution.
DNS Firewall, Network Firewall, and third-party firewall - AWS::EC2::VPC.
Shield Advanced - AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and AWS::CloudFront::Distribution.
Security group content audit - AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance.
Security group usage audit - AWS::EC2::SecurityGroup.
The type of resource protected by or in scope of the policy. This is in the format shown\n in the Amazon Web Services Resource Types Reference.\n To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.
The following are valid resource types for each Firewall Manager policy type:
\nAmazon Web Services WAF Classic - AWS::ApiGateway::Stage, AWS::CloudFront::Distribution, and AWS::ElasticLoadBalancingV2::LoadBalancer.
WAF - AWS::ApiGateway::Stage, AWS::ElasticLoadBalancingV2::LoadBalancer, and AWS::CloudFront::Distribution.
Shield Advanced - AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and AWS::CloudFront::Distribution.
Network ACL - AWS::EC2::Subnet.
Security group usage audit - AWS::EC2::SecurityGroup.
Security group content audit - AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance.
DNS Firewall, Network Firewall, and third-party firewall - AWS::EC2::VPC.
Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.
\nBy default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
\nThis option is not available for Shield Advanced or WAF Classic policies.
" + "smithy.api#documentation": "Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.
\nBy default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
\nThis option is not available for Shield Advanced or WAF Classic policies.
" } }, "IncludeMap": { @@ -5830,10 +6307,16 @@ "traits": { "smithy.api#documentation": "Defines the policy options for a third-party firewall policy.
" } + }, + "NetworkAclCommonPolicy": { + "target": "com.amazonaws.fms#NetworkAclCommonPolicy", + "traits": { + "smithy.api#documentation": "Defines a Firewall Manager network ACL policy.
" + } } }, "traits": { - "smithy.api#documentation": "Contains the Network Firewall firewall policy options to configure the policy's deployment model and third-party firewall policy settings.
" + "smithy.api#documentation": "Contains the settings to configure a network ACL policy, a Network Firewall firewall policy deployment model, or a third-party firewall policy.
" } }, "com.amazonaws.fms#PolicySummary": { @@ -5860,7 +6343,7 @@ "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { - "smithy.api#documentation": "The type of resource protected by or in scope of the policy. This is in the format shown\n in the Amazon Web Services Resource Types Reference.\n For WAF and Shield Advanced, examples include\n AWS::ElasticLoadBalancingV2::LoadBalancer and\n AWS::CloudFront::Distribution. For a security group common policy, valid values\n are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a\n security group content audit policy, valid values are AWS::EC2::SecurityGroup,\n AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security\n group usage audit policy, the value is AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy,\n the value is AWS::EC2::VPC.
The type of resource protected by or in scope of the policy. This is in the format shown\n in the Amazon Web Services Resource Types Reference.
" } }, "SecurityServiceType": { @@ -5880,7 +6363,7 @@ "target": "com.amazonaws.fms#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.
\nBy default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
\nThis option is not available for Shield Advanced or WAF Classic policies.
" + "smithy.api#documentation": "Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.
\nBy default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
\nThis option is not available for Shield Advanced or WAF Classic policies.
" } }, "PolicyStatus": { @@ -6316,7 +6799,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Firewall Manager policy.
\nA Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple\n\t\tpolicy types across accounts, you can create multiple policies. You can create more than one\n\t\tpolicy for each type.
\nIf you add a new account to an organization that you created with Organizations, Firewall Manager\n\t\tautomatically applies the policy to the resources in that account that are within scope of\n\t\tthe policy.
\nFirewall Manager provides the following types of policies:
\n\n Shield Advanced policy - This policy applies Shield Advanced\n\t\t\t\tprotection to specified accounts and resources.
\n\n Security Groups policy - This type of policy gives you\n\t\t\t\tcontrol over security groups that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of rules across your organization.
\n\n Network Firewall policy - This policy applies\n\t\t\t\tNetwork Firewall protection to your organization's VPCs.
\n\n DNS Firewall policy - This policy applies\n\t\t\t\tAmazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
\n\n Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace.
\n\n Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
\n\n Fortigate CNF policy - This policy applies\n\t\t\t\t\t\tFortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
\nCreates an Firewall Manager policy.
\nA Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple\n\t\tpolicy types across accounts, you can create multiple policies. You can create more than one\n\t\tpolicy for each type.
\nIf you add a new account to an organization that you created with Organizations, Firewall Manager\n\t\tautomatically applies the policy to the resources in that account that are within scope of\n\t\tthe policy.
\nFirewall Manager provides the following types of policies:
\n\n WAF policy - This policy applies WAF web ACL\n\t\t\t\tprotections to specified accounts and resources.
\n\n Shield Advanced policy - This policy applies Shield Advanced\n\t\t\t\tprotection to specified accounts and resources.
\n\n Security Groups policy - This type of policy gives you\n\t\t\t\tcontrol over security groups that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of rules across your organization.
\n\n Network ACL policy - This type of policy gives you\n\t\t\t\tcontrol over the network ACLs that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
\n\n Network Firewall policy - This policy applies\n\t\t\t\tNetwork Firewall protection to your organization's VPCs.
\n\n DNS Firewall policy - This policy applies\n\t\t\t\tAmazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
\n\n Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace.
\n\n Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
\n\n Fortigate CNF policy - This policy applies\n\t\t\t\t\t\tFortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
\nThe remedial action to take when updating a firewall configuration.
" } + }, + "CreateNetworkAclAction": { + "target": "com.amazonaws.fms#CreateNetworkAclAction", + "traits": { + "smithy.api#documentation": "Information about the CreateNetworkAcl action in Amazon EC2.
Information about the ReplaceNetworkAclAssociation action in Amazon EC2.
Information about the CreateNetworkAclEntries action in Amazon EC2.
Information about the DeleteNetworkAclEntries action in Amazon EC2.
An ordered list of actions you can take to remediate a violation.
" } }, + "com.amazonaws.fms#ReplaceNetworkAclAssociationAction": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "Brief description of this remediation action.
" + } + }, + "AssociationId": { + "target": "com.amazonaws.fms#ActionTarget" + }, + "NetworkAclId": { + "target": "com.amazonaws.fms#ActionTarget", + "traits": { + "smithy.api#documentation": "The network ACL that's associated with the remediation action.
" + } + }, + "FMSCanRemediate": { + "target": "com.amazonaws.fms#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the ReplaceNetworkAclAssociation action in Amazon EC2. This is a remediation option in RemediationAction.
Violation detail for a DNS Firewall policy that indicates that the VPC reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed.
" } }, - "PossibleRemediationActions": { - "target": "com.amazonaws.fms#PossibleRemediationActions", - "traits": { - "smithy.api#documentation": "A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.
" - } - }, "FirewallSubnetIsOutOfScopeViolation": { "target": "com.amazonaws.fms#FirewallSubnetIsOutOfScopeViolation", "traits": { @@ -7052,6 +7583,18 @@ "traits": { "smithy.api#documentation": "The violation details for a third-party firewall's VPC endpoint subnet that was deleted.
" } + }, + "InvalidNetworkAclEntriesViolation": { + "target": "com.amazonaws.fms#InvalidNetworkAclEntriesViolation", + "traits": { + "smithy.api#documentation": "Violation detail for the entries in a network ACL resource.
" + } + }, + "PossibleRemediationActions": { + "target": "com.amazonaws.fms#PossibleRemediationActions", + "traits": { + "smithy.api#documentation": "A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.
" + } } }, "traits": { @@ -7295,13 +7838,13 @@ "ManagedServiceData": { "target": "com.amazonaws.fms#ManagedServiceData", "traits": { - "smithy.api#documentation": "Details about the service that are specific to the service type, in JSON format.
\nExample: DNS_FIREWALL\n
\n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n
Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.
Example: IMPORT_NETWORK_FIREWALL\n
\n \"{\\\"type\\\":\\\"IMPORT_NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-2:000000000000:stateless-rulegroup\\/rg1\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:drop\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:pass\\\"],\\\"networkFirewallStatelessCustomActions\\\":[],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-2:aws-managed:stateful-rulegroup\\/ThreatSignaturesEmergingEventsStrictOrder\\\",\\\"priority\\\":8}],\\\"networkFirewallStatefulEngineOptions\\\":{\\\"ruleOrder\\\":\\\"STRICT_ORDER\\\"},\\\"networkFirewallStatefulDefaultActions\\\":[\\\"aws:drop_strict\\\"]}}\"\n
\n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n
Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.
Example: NETWORK_FIREWALL - Centralized deployment\n model
\n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}},\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"\n
To use the centralized deployment model, you must set PolicyOption to\n CENTRALIZED.
Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration
\n \n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"OFF\\\"},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"\n \n
With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration and route management
\n \n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"]},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\": \\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"\n \n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration
\n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\", \\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{ \\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"]}]} },\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"OFF\\\",\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"\n \n
\n With custom Availability Zone configuration,\n you define which specific Availability Zones to create endpoints in by configuring\n firewallCreationConfig. To configure the Availability Zones in firewallCreationConfig, specify either the availabilityZoneName or availabilityZoneId parameter, not both parameters.\n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration and route management
\n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"],\\\"routeManagementConfig\\\":{\\\"allowCrossAZTrafficIfNoEndpoint\\\":true}},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"\n \n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: SECURITY_GROUPS_COMMON\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n
Example: SECURITY_GROUPS_COMMON - Security group tag distribution\n
\n \"\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"revertManualSecurityGroupChanges\\\":true,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":false,\\\"enableTagDistribution\\\":true}\"\"\n
\n Firewall Manager automatically distributes tags from the primary group to the security groups created by this policy. To use security group tag distribution, you must also set revertManualSecurityGroupChanges to true, otherwise Firewall Manager won't be able to create the policy. When you enable revertManualSecurityGroupChanges, Firewall Manager identifies and reports when the security groups created by this policy become non-compliant.\n
\n Firewall Manager won't distrubute system tags added by Amazon Web Services services into the replica security groups. System tags begin with the aws: prefix.\n
Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as\n well as to those in VPCs that the account owns
\n\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n
Example: SECURITY_GROUPS_CONTENT_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"\n
The security group action for content audit can be ALLOW or\n DENY. For ALLOW, all in-scope security group rules must\n be within the allowed range of the policy's security group rules. For\n DENY, all in-scope security group rules must not contain a value or a\n range that matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"\n
Example: SHIELD_ADVANCED with web ACL management
\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"optimizeUnassociatedWebACL\\\":true}\"\n
If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.
Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager doesn't disassociate the resource from the web ACL. If you want Firewall Manager to clean up the web ACL, you must first manually disassociate the resources from the web ACL, and then enable the manage unused web ACLs option in your policy.
\nIf you set optimizeUnassociatedWebACL to false, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions
\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\", \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"}, \\\"overrideCustomerWebaclClassic\\\":true|false, \\\"optimizeUnassociatedWebACL\\\":true|false}\"\n
For example:\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\",\n \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"\n
The default value for automaticResponseStatus is\n IGNORED. The value for automaticResponseAction is only\n required when automaticResponseStatus is set to ENABLED.\n The default value for overrideCustomerWebaclClassic is\n false.
For other resource types that you can protect with a Shield Advanced policy, this\n ManagedServiceData configuration is an empty string.
Example: THIRD_PARTY_FIREWALL\n
Replace THIRD_PARTY_FIREWALL_NAME with the name of the third-party firewall.
\n \"{\n \"type\":\"THIRD_PARTY_FIREWALL\",\n \"thirdPartyFirewall\":\"THIRD_PARTY_FIREWALL_NAME\",\n \"thirdPartyFirewallConfig\":{\n \"thirdPartyFirewallPolicyList\":[\"global-1\"]\n },\n\t \"firewallDeploymentModel\":{\n \"distributedFirewallDeploymentModel\":{\n \"distributedFirewallOrchestrationConfig\":{\n \"firewallCreationConfig\":{\n \"endpointLocation\":{\n \"availabilityZoneConfigList\":[\n {\n \"availabilityZoneName\":\"${AvailabilityZone}\"\n }\n ]\n }\n },\n \"allowedIPV4CidrList\":[\n ]\n }\n }\n }\n }\"\n
Example: WAFV2 - Account takeover prevention, Bot Control managed rule groups, optimize unassociated web ACL, and rule action override\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesATPRuleSet\\\",\\\"managedRuleGroupConfigs\\\":[{\\\"awsmanagedRulesATPRuleSet\\\":{\\\"loginPath\\\":\\\"/loginpath\\\",\\\"requestInspection\\\":{\\\"payloadType\\\":\\\"FORM_ENCODED|JSON\\\",\\\"usernameField\\\":{\\\"identifier\\\":\\\"/form/username\\\"},\\\"passwordField\\\":{\\\"identifier\\\":\\\"/form/password\\\"}}}}]},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true},{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesBotControlRuleSet\\\",\\\"managedRuleGroupConfigs\\\":[{\\\"awsmanagedRulesBotControlRuleSet\\\":{\\\"inspectionLevel\\\":\\\"TARGETED|COMMON\\\"}}]},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true,\\\"ruleActionOverrides\\\":[{\\\"name\\\":\\\"Rule1\\\",\\\"actionToUse\\\":{\\\"allow|block|count|captcha|challenge\\\":{}}},{\\\"name\\\":\\\"Rule2\\\",\\\"actionToUse\\\":{\\\"allow|block|count|captcha|challenge\\\":{}}}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\":null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":null,\\\"sampledRequestsEnabledForDefaultActions\\\":true,\\\"optimizeUnassociatedWebACL\\\":true}\"\n
Bot Control - For information about AWSManagedRulesBotControlRuleSet managed rule groups, see AWSManagedRulesBotControlRuleSet in the WAF API Reference.
Fraud Control account takeover prevention (ATP) - For information about the properties available for AWSManagedRulesATPRuleSet managed rule groups, see AWSManagedRulesATPRuleSet in the WAF API Reference.
Optimize unassociated web ACL - If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.
Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager disassociates the resource from the web ACL, but won't clean up the unused web ACL. Firewall Manager only cleans up unused web ACLs when you first enable management of unused web ACLs in a policy.
\nIf you set optimizeUnassociatedWebACL to false Firewall Manager doesn't manage unused web ACLs, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.
Rule action overrides - Firewall Manager supports rule action overrides only for managed rule groups. To configure a RuleActionOverrides add the Name of the rule to override, and ActionToUse, which is the new action to use for the rule. For information about using rule action override, see RuleActionOverride in the WAF API Reference.
Example: WAFV2 - CAPTCHA and Challenge configs\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\":null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":null,\\\"sampledRequestsEnabledForDefaultActions\\\":true,\\\"captchaConfig\\\":{\\\"immunityTimeProperty\\\":{\\\"immunityTime\\\":500}},\\\"challengeConfig\\\":{\\\"immunityTimeProperty\\\":{\\\"immunityTime\\\":800}},\\\"tokenDomains\\\":[\\\"google.com\\\",\\\"amazon.com\\\"],\\\"associationConfig\\\":{\\\"requestBody\\\":{\\\"CLOUDFRONT\\\":{\\\"defaultSizeInspectionLimit\\\":\\\"KB_16\\\"}}}}\"\n
\n CAPTCHA and Challenge configs - If you update the policy's values for associationConfig, captchaConfig, challengeConfig, or tokenDomains, Firewall Manager will overwrite your local web ACLs to contain the new value(s). However, if you don't update the policy's associationConfig, captchaConfig, challengeConfig, or tokenDomains values, the values in your local web ACLs will remain unchanged. For information about association configs, see AssociationConfig. For information about CAPTCHA and Challenge configs, see CaptchaConfig and ChallengeConfig in the WAF API Reference.
\n defaultSizeInspectionLimit - Specifies the maximum size of the web request body component that an associated Amazon CloudFront distribution should send to WAF for inspection. For more information, see DefaultSizeInspectionLimit in the WAF API Reference.
Example: WAFV2 - Firewall Manager support for WAF managed rule group versioning\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":true,\\\"version\\\":\\\"Version_2.0\\\",\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesCommonRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"\n
\n To use a specific version of a WAF managed rule group in your Firewall Manager policy, you must set versionEnabled to true, and set version to the version you'd like to use. If you don't set versionEnabled to true, or if you omit versionEnabled, then Firewall Manager uses the default version of the WAF managed rule group.\n
Example: WAFV2 - Logging configurations\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null, \\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\": {\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\", \\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\"} ,\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[], \\\"sampledRequestsEnabled\\\":true}],\\\"postProcessRuleGroups\\\":[], \\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\" :null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\" :false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\": [\\\"arn:aws:s3:::aws-waf-logs-example-bucket\\\"] ,\\\"redactedFields\\\":[],\\\"loggingFilterConfigs\\\":{\\\"defaultBehavior\\\":\\\"KEEP\\\", \\\"filters\\\":[{\\\"behavior\\\":\\\"KEEP\\\",\\\"requirement\\\":\\\"MEETS_ALL\\\", \\\"conditions\\\":[{\\\"actionCondition\\\":\\\"CAPTCHA\\\"},{\\\"actionCondition\\\": \\\"CHALLENGE\\\"}, {\\\"actionCondition\\\":\\\"EXCLUDED_AS_COUNT\\\"}]}]}},\\\"sampledRequestsEnabledForDefaultActions\\\":true}\"\n
Firewall Manager supports Amazon Kinesis Data Firehose and Amazon S3 as the logDestinationConfigs in your loggingConfiguration. For information about WAF logging configurations, see LoggingConfiguration in the WAF API Reference\n
In the loggingConfiguration, you can specify one\n logDestinationConfigs. Optionally provide as many as 20\n redactedFields. The RedactedFieldType must be one of\n URI, QUERY_STRING, HEADER, or\n METHOD.
Example: WAF Classic\n
\n \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\":\n [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\":\n \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"\n
Details about the service that are specific to the service type, in JSON format.
\nExample: DNS_FIREWALL\n
\n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n
Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.
Example: IMPORT_NETWORK_FIREWALL\n
\n \"{\\\"type\\\":\\\"IMPORT_NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-2:000000000000:stateless-rulegroup\\/rg1\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:drop\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:pass\\\"],\\\"networkFirewallStatelessCustomActions\\\":[],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-2:aws-managed:stateful-rulegroup\\/ThreatSignaturesEmergingEventsStrictOrder\\\",\\\"priority\\\":8}],\\\"networkFirewallStatefulEngineOptions\\\":{\\\"ruleOrder\\\":\\\"STRICT_ORDER\\\"},\\\"networkFirewallStatefulDefaultActions\\\":[\\\"aws:drop_strict\\\"]}}\"\n
\n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n
Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.
Example: NETWORK_FIREWALL - Centralized deployment\n model
\n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}},\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"\n
To use the centralized deployment model, you must set PolicyOption to\n CENTRALIZED.
Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration
\n \n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"OFF\\\"},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"\n \n
With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration and route management
\n \n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"]},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\": \\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"\n \n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration
\n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\", \\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{ \\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"]}]} },\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"OFF\\\",\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"\n \n
\n With custom Availability Zone configuration,\n you define which specific Availability Zones to create endpoints in by configuring\n firewallCreationConfig. To configure the Availability Zones in firewallCreationConfig, specify either the availabilityZoneName or availabilityZoneId parameter, not both parameters.\n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration and route management
\n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"],\\\"routeManagementConfig\\\":{\\\"allowCrossAZTrafficIfNoEndpoint\\\":true}},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"\n \n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: SECURITY_GROUPS_COMMON\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n
Example: SECURITY_GROUPS_COMMON - Security group tag distribution\n
\n \"\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"revertManualSecurityGroupChanges\\\":true,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":false,\\\"enableTagDistribution\\\":true}\"\"\n
\n Firewall Manager automatically distributes tags from the primary group to the security groups created by this policy. To use security group tag distribution, you must also set revertManualSecurityGroupChanges to true, otherwise Firewall Manager won't be able to create the policy. When you enable revertManualSecurityGroupChanges, Firewall Manager identifies and reports when the security groups created by this policy become non-compliant.\n
\n Firewall Manager won't distribute system tags added by Amazon Web Services services into the replica security groups. System tags begin with the aws: prefix.\n
Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as\n well as to those in VPCs that the account owns
\n\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n
Example: SECURITY_GROUPS_CONTENT_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"\n
The security group action for content audit can be ALLOW or\n DENY. For ALLOW, all in-scope security group rules must\n be within the allowed range of the policy's security group rules. For\n DENY, all in-scope security group rules must not contain a value or a\n range that matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"\n
Example: SHIELD_ADVANCED with web ACL management
\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"optimizeUnassociatedWebACL\\\":true}\"\n
If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.
Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager doesn't disassociate the resource from the web ACL. If you want Firewall Manager to clean up the web ACL, you must first manually disassociate the resources from the web ACL, and then enable the manage unused web ACLs option in your policy.
\nIf you set optimizeUnassociatedWebACL to false, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions
\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\", \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"}, \\\"overrideCustomerWebaclClassic\\\":true|false, \\\"optimizeUnassociatedWebACL\\\":true|false}\"\n
For example:\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\",\n \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"\n
The default value for automaticResponseStatus is\n IGNORED. The value for automaticResponseAction is only\n required when automaticResponseStatus is set to ENABLED.\n The default value for overrideCustomerWebaclClassic is\n false.
For other resource types that you can protect with a Shield Advanced policy, this\n ManagedServiceData configuration is an empty string.
Example: THIRD_PARTY_FIREWALL\n
Replace THIRD_PARTY_FIREWALL_NAME with the name of the third-party firewall.
\n \"{\n \"type\":\"THIRD_PARTY_FIREWALL\",\n \"thirdPartyFirewall\":\"THIRD_PARTY_FIREWALL_NAME\",\n \"thirdPartyFirewallConfig\":{\n \"thirdPartyFirewallPolicyList\":[\"global-1\"]\n },\n\t \"firewallDeploymentModel\":{\n \"distributedFirewallDeploymentModel\":{\n \"distributedFirewallOrchestrationConfig\":{\n \"firewallCreationConfig\":{\n \"endpointLocation\":{\n \"availabilityZoneConfigList\":[\n {\n \"availabilityZoneName\":\"${AvailabilityZone}\"\n }\n ]\n }\n },\n \"allowedIPV4CidrList\":[\n ]\n }\n }\n }\n }\"\n
Example: WAFV2 - Account takeover prevention, Bot Control managed rule groups, optimize unassociated web ACL, and rule action override\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesATPRuleSet\\\",\\\"managedRuleGroupConfigs\\\":[{\\\"awsmanagedRulesATPRuleSet\\\":{\\\"loginPath\\\":\\\"/loginpath\\\",\\\"requestInspection\\\":{\\\"payloadType\\\":\\\"FORM_ENCODED|JSON\\\",\\\"usernameField\\\":{\\\"identifier\\\":\\\"/form/username\\\"},\\\"passwordField\\\":{\\\"identifier\\\":\\\"/form/password\\\"}}}}]},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true},{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesBotControlRuleSet\\\",\\\"managedRuleGroupConfigs\\\":[{\\\"awsmanagedRulesBotControlRuleSet\\\":{\\\"inspectionLevel\\\":\\\"TARGETED|COMMON\\\"}}]},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true,\\\"ruleActionOverrides\\\":[{\\\"name\\\":\\\"Rule1\\\",\\\"actionToUse\\\":{\\\"allow|block|count|captcha|challenge\\\":{}}},{\\\"name\\\":\\\"Rule2\\\",\\\"actionToUse\\\":{\\\"allow|block|count|captcha|challenge\\\":{}}}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\":null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":null,\\\"sampledRequestsEnabledForDefaultActions\\\":true,\\\"optimizeUnassociatedWebACL\\\":true}\"\n
Bot Control - For information about AWSManagedRulesBotControlRuleSet managed rule groups, see AWSManagedRulesBotControlRuleSet in the WAF API Reference.
Fraud Control account takeover prevention (ATP) - For information about the properties available for AWSManagedRulesATPRuleSet managed rule groups, see AWSManagedRulesATPRuleSet in the WAF API Reference.
Optimize unassociated web ACL - If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.
Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager disassociates the resource from the web ACL, but won't clean up the unused web ACL. Firewall Manager only cleans up unused web ACLs when you first enable management of unused web ACLs in a policy.
\nIf you set optimizeUnassociatedWebACL to false Firewall Manager doesn't manage unused web ACLs, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.
Rule action overrides - Firewall Manager supports rule action overrides only for managed rule groups. To configure a RuleActionOverrides add the Name of the rule to override, and ActionToUse, which is the new action to use for the rule. For information about using rule action override, see RuleActionOverride in the WAF API Reference.
Example: WAFV2 - CAPTCHA and Challenge configs\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\":null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":null,\\\"sampledRequestsEnabledForDefaultActions\\\":true,\\\"captchaConfig\\\":{\\\"immunityTimeProperty\\\":{\\\"immunityTime\\\":500}},\\\"challengeConfig\\\":{\\\"immunityTimeProperty\\\":{\\\"immunityTime\\\":800}},\\\"tokenDomains\\\":[\\\"google.com\\\",\\\"amazon.com\\\"],\\\"associationConfig\\\":{\\\"requestBody\\\":{\\\"CLOUDFRONT\\\":{\\\"defaultSizeInspectionLimit\\\":\\\"KB_16\\\"}}}}\"\n
\n CAPTCHA and Challenge configs - If you update the policy's values for associationConfig, captchaConfig, challengeConfig, or tokenDomains, Firewall Manager will overwrite your local web ACLs to contain the new value(s). However, if you don't update the policy's associationConfig, captchaConfig, challengeConfig, or tokenDomains values, the values in your local web ACLs will remain unchanged. For information about association configs, see AssociationConfig. For information about CAPTCHA and Challenge configs, see CaptchaConfig and ChallengeConfig in the WAF API Reference.
\n defaultSizeInspectionLimit - Specifies the maximum size of the web request body component that an associated Amazon CloudFront distribution should send to WAF for inspection. For more information, see DefaultSizeInspectionLimit in the WAF API Reference.
Example: WAFV2 - Firewall Manager support for WAF managed rule group versioning\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":true,\\\"version\\\":\\\"Version_2.0\\\",\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesCommonRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"\n
\n To use a specific version of a WAF managed rule group in your Firewall Manager policy, you must set versionEnabled to true, and set version to the version you'd like to use. If you don't set versionEnabled to true, or if you omit versionEnabled, then Firewall Manager uses the default version of the WAF managed rule group.\n
Example: WAFV2 - Logging configurations\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null, \\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\": {\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\", \\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\"} ,\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[], \\\"sampledRequestsEnabled\\\":true}],\\\"postProcessRuleGroups\\\":[], \\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\" :null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\" :false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\": [\\\"arn:aws:s3:::aws-waf-logs-example-bucket\\\"] ,\\\"redactedFields\\\":[],\\\"loggingFilterConfigs\\\":{\\\"defaultBehavior\\\":\\\"KEEP\\\", \\\"filters\\\":[{\\\"behavior\\\":\\\"KEEP\\\",\\\"requirement\\\":\\\"MEETS_ALL\\\", \\\"conditions\\\":[{\\\"actionCondition\\\":\\\"CAPTCHA\\\"},{\\\"actionCondition\\\": \\\"CHALLENGE\\\"}, {\\\"actionCondition\\\":\\\"EXCLUDED_AS_COUNT\\\"}]}]}},\\\"sampledRequestsEnabledForDefaultActions\\\":true}\"\n
Firewall Manager supports Amazon Kinesis Data Firehose and Amazon S3 as the logDestinationConfigs in your loggingConfiguration. For information about WAF logging configurations, see LoggingConfiguration in the WAF API Reference\n
In the loggingConfiguration, you can specify one\n logDestinationConfigs. Optionally provide as many as 20\n redactedFields. The RedactedFieldType must be one of\n URI, QUERY_STRING, HEADER, or\n METHOD.
Example: WAF Classic\n
\n \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\":\n [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\":\n \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"\n
Contains the Network Firewall firewall policy options to configure a centralized deployment\n model.
" + "smithy.api#documentation": "Contains the settings to configure a network ACL policy, a Network Firewall firewall policy deployment model, or a third-party firewall policy.
" } } }, @@ -7371,6 +7914,12 @@ "traits": { "smithy.api#enumValue": "IMPORT_NETWORK_FIREWALL" } + }, + "NETWORK_ACL_COMMON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_ACL_COMMON" + } } } }, @@ -7392,7 +7941,13 @@ "RuleOrder": { "target": "com.amazonaws.fms#RuleOrder", "traits": { - "smithy.api#documentation": "Indicates how to manage the order of stateful rule evaluation for the policy.\nDEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine\nas Suricata compatible strings, and Suricata evaluates them based on certain settings. For more\ninformation, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
Indicates how to manage the order of stateful rule evaluation for the policy.\nStateful rules are provided to the rule engine\nas Suricata compatible strings, and Suricata evaluates them based on certain settings. For more\ninformation, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
\nDefault: DEFAULT_ACTION_ORDER\n
Indicates how Network Firewall should handle traffic when a network connection breaks midstream.
\n\n DROP - Fail closed and drop all subsequent traffic going to the firewall.
\n CONTINUE - Continue to apply rules to subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on context. For example, with a stateful rule that drops HTTP traffic, Network Firewall won't match subsequent traffic because the it won't have the context from session initialization, which defines the application layer protocol as HTTP. However, a TCP-layer rule using a flow:stateless rule would still match, and so would the aws:drop_strict default action.
\n REJECT - Fail closed and drop all subsequent traffic going to the firewall. With this option, Network Firewall also sends a TCP reject packet back to the client so the client can immediately establish a new session. With the new session, Network Firewall will have context and will apply rules appropriately.
For applications that are reliant on long-lived TCP connections that trigger Gateway Load Balancer idle timeouts, this is the recommended setting.
\n\n FMS_IGNORE - Firewall Manager doesn't monitor or modify the Network Firewall stream exception policy settings.
For more information, see \n Stream exception policy in your firewall policy \n in the Network Firewall Developer Guide.
\nDefault: FMS_IGNORE\n
Amazon GameLift Anywhere configuration options for your Anywhere fleets.
" + "smithy.api#documentation": "Amazon GameLift configuration options for your Anywhere fleets.
" } }, "com.amazonaws.gamelift#ArnStringModel": { @@ -454,7 +454,7 @@ } }, "traits": { - "smithy.api#documentation": "Determines whether a TLS/SSL certificate is generated for a fleet. This feature must\n be enabled when creating the fleet. All instances in a fleet share the same certificate.\n The certificate can be retrieved by calling the Amazon GameLift Server\n SDK operation GetInstanceCertificate.
\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDetermines whether a TLS/SSL certificate is generated for a fleet. This feature must\n be enabled when creating the fleet. All instances in a fleet share the same certificate.\n The certificate can be retrieved by calling the Amazon GameLift Server\n SDK operation GetInstanceCertificate.
A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is an instance\n ID.
" + "smithy.api#documentation": "A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is the same value as the InstanceId\n ID.
The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are\n unique across locations. Instances in managed EC2 fleets are not assigned a\n ComputeARN.
" + "smithy.api#documentation": "The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are\n unique across locations. Instances in managed EC2 fleets are not assigned a Compute\n ARN.
" } }, "IpAddress": { @@ -671,108 +671,986 @@ "traits": { "smithy.api#documentation": "The Amazon GameLift SDK endpoint connection for a registered compute resource in an Anywhere\n fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift\n service.
" } + }, + "GameLiftAgentEndpoint": { + "target": "com.amazonaws.gamelift#GameLiftAgentEndpointOutput", + "traits": { + "smithy.api#documentation": "The endpoint of the Amazon GameLift Agent.
" + } + }, + "InstanceId": { + "target": "com.amazonaws.gamelift#InstanceId", + "traits": { + "smithy.api#documentation": "\n The InstanceID of the Instance hosting the compute for Container and Managed EC2 fleets.\n
\n Some attributes of a container.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nAn Amazon GameLift compute resource for hosting your game servers. Computes in an Amazon GameLift\n fleet differs depending on the fleet's compute type property as follows:
\nFor EC2 fleets, a compute is an EC2 instance.
For ANYWHERE fleets, a compute is a computing resource that you\n provide and is registered to the fleet.
For CONTAINER fleets, a compute is a container that's registered\n to the fleet.
The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request.
\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.gamelift#ConnectionPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.gamelift#PortNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Starting value for the port range.
", + "smithy.api#required": {} + } + }, + "ToPort": { + "target": "com.amazonaws.gamelift#PortNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Ending value for the port. Port numbers are end-inclusive. This value must be equal to\n or greater than FromPort.
\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nThe set of port numbers to open on each instance in a container fleet. Connection\n ports are used by inbound traffic to connect with processes that are running in\n containers on the fleet.
\n\n Part of:\n ContainerGroupsConfiguration, ContainerGroupsAttributes\n
" + } + }, + "com.amazonaws.gamelift#ContainerAttributes": { + "type": "structure", + "members": { + "ContainerPortMappings": { + "target": "com.amazonaws.gamelift#ContainerPortMappingList", + "traits": { + "smithy.api#documentation": "\n Describes how container ports map to connection ports on the fleet instance.\n Incoming traffic connects to a game via a connection port.\n A ContainerPortMapping directs the traffic from a connection port to a port on the container that hosts the game session.\n
\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDescribes attributes of containers that are deployed to a fleet with compute type\n CONTAINER.
The container definition identifier. Container names are unique within a container group\n definition.
", + "smithy.api#required": {} + } + }, + "ImageUri": { + "target": "com.amazonaws.gamelift#ImageUriString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI to the image that $short; copied and deployed to a container fleet. For a more\n specific identifier, see ResolvedImageDigest.
A unique and immutable identifier for the container image that is deployed to a container\n fleet. The digest is a SHA 256 hash of the container image manifest.
" + } + }, + "MemoryLimits": { + "target": "com.amazonaws.gamelift#ContainerMemoryLimits", + "traits": { + "smithy.api#documentation": "The amount of memory that Amazon GameLift makes available to the container. If memory limits\n aren't set for an individual container, the container shares the container group's total\n memory allocation.
\n\n Related data type: \n ContainerGroupDefinition$TotalMemoryLimit\n
" + } + }, + "PortConfiguration": { + "target": "com.amazonaws.gamelift#ContainerPortConfiguration", + "traits": { + "smithy.api#documentation": "Defines the ports that are available to assign to processes in the container. For\n example, a game server process requires a container port to allow game clients to connect to\n it. Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container\n ports to externally accessible connection ports, which are assigned as needed from the\n container fleet's ConnectionPortRange.
The number of CPU units that are reserved for the container. Note: 1 vCPU unit equals\n 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the\n container group.
\n\n Related data type: \n ContainerGroupDefinition$TotalCpuLimit\n
" + } + }, + "HealthCheck": { + "target": "com.amazonaws.gamelift#ContainerHealthCheck", + "traits": { + "smithy.api#documentation": "A configuration for a non-terminal health check. A container, which automatically restarts\n if it stops functioning, also restarts if it fails this health check. If an essential\n container in the daemon group fails a health check, the entire container group is restarted.\n The essential container in the replica group doesn't use this health check mechanism, because\n the Amazon GameLift Agent automatically handles the task.
" + } + }, + "Command": { + "target": "com.amazonaws.gamelift#ContainerCommandStringList", + "traits": { + "smithy.api#documentation": "A command that's passed to the container on startup. Each argument for the command is an\n additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API\n reference.\n
" + } + }, + "Essential": { + "target": "com.amazonaws.gamelift#BooleanModel", + "traits": { + "smithy.api#documentation": "Indicates whether the container is vital to the container group. If an essential\n container fails, the entire container group is restarted.
" + } + }, + "EntryPoint": { + "target": "com.amazonaws.gamelift#ContainerEntryPointList", + "traits": { + "smithy.api#documentation": "The entry point that's passed to the container on startup. If there are multiple\n arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API\n Reference.
" + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.gamelift#NonZeroAnd255MaxString", + "traits": { + "smithy.api#documentation": "The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API\n Reference.
" + } + }, + "Environment": { + "target": "com.amazonaws.gamelift#ContainerEnvironmentList", + "traits": { + "smithy.api#documentation": "A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API\n Reference.
" + } + }, + "DependsOn": { + "target": "com.amazonaws.gamelift#ContainerDependencyList", + "traits": { + "smithy.api#documentation": "Indicates that the container relies on the status of other containers in the same\n container group during its startup and shutdown sequences. A container might have dependencies\n on multiple containers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDescribes a container in a container fleet, the resources available to the container,\n and the commands that are run when the container starts. Container properties can't be\n updated. To change a property, create a new container group definition. See also \n ContainerDefinitionInput.
\n\n Part of:\n ContainerGroupDefinition\n
\n\n Returned by:\n DescribeContainerGroupDefinition, ListContainerGroupDefinitions\n
" + } + }, + "com.amazonaws.gamelift#ContainerDefinitionInput": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A string that uniquely identifies the container definition within a container\n group.
", + "smithy.api#required": {} + } + }, + "ImageUri": { + "target": "com.amazonaws.gamelift#ImageUriString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location of a container image that $short; will copy and deploy to a container fleet.\n Images in Amazon Elastic Container Registry private repositories are supported. The repository must be in the same\n Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For\n limits on image size, see Amazon GameLift endpoints and quotas. You can use any of the following image URI formats:
\nImage ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository\n ID]\n
Image ID and digest: [AWS account].dkr.ecr.[AWS\n region].amazonaws.com/[repository ID]@[digest]\n
Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository\n ID]:[tag]\n
The amount of memory to make available to the container. If you don't specify memory\n limits for this container, then it shares the container group's total memory allocation.
\n\n Related data type: \n ContainerGroupDefinition$TotalMemoryLimit\n
" + } + }, + "PortConfiguration": { + "target": "com.amazonaws.gamelift#ContainerPortConfiguration", + "traits": { + "smithy.api#documentation": "A set of ports that Amazon GameLift can assign to processes in the container. All processes that\n accept inbound traffic connections, including game server processes, must be assigned a port\n from this set. The set of ports must be large enough to assign one to each process in the\n container that needs one. If the container includes your game server, include enough ports to\n assign one port to each concurrent server process (as defined in a container fleet's RuntimeConfiguration). For more details, see Networking for container\n fleets.
\nContainer ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container\n ports to externally accessible connection ports, which are assigned as needed from the\n container fleet's ConnectionPortRange.
The number of CPU units to reserve for this container. The container can use more resources\n when needed, if available. Note: 1 vCPU unit equals 1024 CPU\n units. If you don't reserve CPU units for this container, then it shares the total CPU limit\n for the container group. This property is similar to the Amazon ECS container definition parameter \n environment (Amazon Elastic Container Service Developer Guide).\n
\n\n Related data type: \n ContainerGroupDefinition$TotalCpuLimit\n
" + } + }, + "HealthCheck": { + "target": "com.amazonaws.gamelift#ContainerHealthCheck", + "traits": { + "smithy.api#documentation": "Configuration for a non-terminal health check. A container automatically restarts if it\n stops functioning. This parameter lets you define additional reasons to consider a container\n unhealthy and restart it. You can set a health check for any container except for the\n essential container in the replica container group. If an essential container in the daemon\n group fails a health check, the entire container group is restarted.
" + } + }, + "Command": { + "target": "com.amazonaws.gamelift#ContainerCommandStringList", + "traits": { + "smithy.api#documentation": "A command to pass to the container on startup. Add multiple arguments as additional\n strings in the array. See the ContainerDefinition command parameter in the Amazon Elastic Container Service API\n reference.\n
" + } + }, + "Essential": { + "target": "com.amazonaws.gamelift#BooleanModel", + "traits": { + "smithy.api#documentation": "Specifies whether the container is vital for the container group to function properly.\n If an essential container fails, it causes the entire container group to restart. Each\n container group must have an essential container.
\n\n Replica container groups - A replica group must have\n exactly one essential container. Use the following to configure an essential replica\n container:
\nChoose a container is running your game server and the Amazon GameLift Agent.
\nInclude a port configuration. This container runs your game server processes, and each\n process requires a container port to allow access to game clients.
\nDon't configure a health check. The Agent handles this task for the essential replica\n container.
\n\n Daemon container groups - A daemon group must have at\n least one essential container.
\n\n
" + } + }, + "EntryPoint": { + "target": "com.amazonaws.gamelift#ContainerEntryPointList", + "traits": { + "smithy.api#documentation": "An entry point to pass to the container on startup. Add multiple arguments as additional\n strings in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API\n Reference.
" + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.gamelift#NonZeroAnd255MaxString", + "traits": { + "smithy.api#documentation": "The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API\n Reference.
" + } + }, + "Environment": { + "target": "com.amazonaws.gamelift#ContainerEnvironmentList", + "traits": { + "smithy.api#documentation": "A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API\n Reference.
" + } + }, + "DependsOn": { + "target": "com.amazonaws.gamelift#ContainerDependencyList", + "traits": { + "smithy.api#documentation": "Sets up dependencies between this container and the status of other containers in the same\n container group. A container can have dependencies on multiple different containers.
\nYou can use dependencies\n to establish a startup/shutdown sequence across the container group. A container startup\n dependency is reversed on shutdown.
\nFor example, you might specify that SideCarContainerB has a START dependency\n on SideCarContainerA. This dependency means that SideCarContainerB can't start until after\n SideCarContainerA has started. This dependency is reversed on shutdown, which means that\n SideCarContainerB must shut down before SideCarContainerA can shut down.
\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDescribes a container's configuration, resources, and start instructions. Use this data\n type to create a container group definition. For the properties of a container that's been\n deployed to a fleet, see ContainerDefinition. You can't change these properties after you've created the container group definition. If you need a container group with different properties, then you must create a new one. \n
\n\n Used with: \n CreateContainerGroupDefinition\n
" + } + }, + "com.amazonaws.gamelift#ContainerDefinitionInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerDefinitionInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.gamelift#ContainerDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.gamelift#ContainerDependency": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A descriptive label for the container definition that this container depends on.
", + "smithy.api#required": {} + } + }, + "Condition": { + "target": "com.amazonaws.gamelift#ContainerDependencyCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The condition that the dependency container must reach before the dependent container can\n start. Valid conditions include:
\nSTART - The dependency container must have started.
\nCOMPLETE - The dependency container has run to completion (exits). Use this condition with\n nonessential containers, such as those that run a script and then exit. The dependency\n container can't be an essential container.
\nSUCCESS - The dependency container has run to completion and exited with a zero status. The\n dependency container can't be an essential container.
\nHEALTHY - The dependency container has passed its Docker health check. Use this condition with\n dependency containers that have health checks configured. This condition is confirmed at\n container group startup only.
\n\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nA container's dependency on another container in the same container group. The dependency\n impacts how the dependent container is able to start or shut down based the status of the\n other container.
\nFor example, ContainerA is configured with the following dependency: a START\n dependency on ContainerB. This means that ContainerA can't start until ContainerB has started.\n It also means that ContainerA must shut down before ContainerB.
\n Part of:\n ContainerDefinition\n
" + } + }, + "com.amazonaws.gamelift#ContainerDependencyCondition": { + "type": "enum", + "members": { + "START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + } + } + }, + "com.amazonaws.gamelift#ContainerDependencyList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerDependency" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.gamelift#ContainerEntryPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.gamelift#ContainerEnvironment": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.gamelift#NonZeroAnd255MaxString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The environment variable name.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.gamelift#NonZeroAnd255MaxString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The environment variable value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nAn environment variable to set inside a container, in the form of a key-value pair.\n
\n\n Related data type: \n ContainerDefinition$Environment\n
" + } + }, + "com.amazonaws.gamelift#ContainerEnvironmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerEnvironment" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinition": { + "type": "structure", + "members": { + "ContainerGroupDefinitionArn": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies \nthe resource across all Amazon Web Services Regions. Format is \narn:aws:gamelift:.
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
The platform required for all containers in the container group definition.
" + } + }, + "Name": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionName", + "traits": { + "smithy.api#documentation": "A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.
" + } + }, + "SchedulingStrategy": { + "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "traits": { + "smithy.api#documentation": "The method for deploying the container group across fleet instances. A replica container\n group might have multiple copies on each fleet instance. A daemon container group maintains\n only one copy per fleet instance.
" + } + }, + "TotalMemoryLimit": { + "target": "com.amazonaws.gamelift#ContainerTotalMemoryLimit", + "traits": { + "smithy.api#documentation": "The amount of memory (in MiB) on a fleet instance to allocate for the container group. All\n containers in the group share these resources.
\nYou can set additional limits for each ContainerDefinition in\n the group. If individual containers have limits, this value must meet the following\n requirements:
\nEqual to or greater than the sum of all container-specific soft memory limits in the group.
\nEqual to or greater than any container-specific hard limits in the group.
\nFor more details on memory allocation, see the Container fleet design\n guide.
" + } + }, + "TotalCpuLimit": { + "target": "com.amazonaws.gamelift#ContainerTotalCpuLimit", + "traits": { + "smithy.api#documentation": "The amount of CPU units on a fleet instance to allocate for the container group. All\n containers in the group share these resources. This property is an integer value in CPU units \n (1 vCPU is equal to 1024 CPU units).
\nYou can set additional limits for each ContainerDefinition in\n the group. If individual containers have limits, this value must be equal to or greater than the sum of all\n container-specific CPU limits in the group.
\nFor more details on memory allocation, see the Container fleet design\n guide.
" + } + }, + "ContainerDefinitions": { + "target": "com.amazonaws.gamelift#ContainerDefinitionList", + "traits": { + "smithy.api#documentation": "\n The set of container definitions that are included in the container group.\n
" + } + }, + "Status": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionStatus", + "traits": { + "smithy.api#documentation": "Current status of the container group definition resource. Values include:
\n\n COPYING -- Amazon GameLift is in the process of making copies of all container\n images that are defined in the group. While in this state, the resource can't be used to\n create a container fleet.
\n READY -- Amazon GameLift has copied the registry images for all containers that\n are defined in the group. You can use a container group definition in this status to\n create a container fleet.
\n FAILED -- Amazon GameLift failed to create a valid container group definition\n resource. For more details on the cause of the failure, see StatusReason. A\n container group definition resource in failed status will be deleted within a few\n minutes.
Additional information about a container group definition that's in FAILED\n status. Possible reasons include:
An internal issue prevented Amazon GameLift from creating\n the container group definition resource. Delete the failed resource and call \n CreateContainerGroupDefinitionagain.
\nAn access-denied message means that you don't have permissions to access the container image on ECR. See \n \n IAM permission examples\n for help setting up required IAM permissions for Amazon GameLift.
\nThe ImageUri value for at least one\n of the containers in the container group definition was invalid or not found in the current\n Amazon Web Services account.
At least one\n of the container images referenced in the container group definition exceeds the \n allowed size. For size limits, see \n Amazon GameLift endpoints and quotas.
\nAt least one of the container images referenced in the \n container group definition uses a different operating system than the one defined for the container group.
\n\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nThe properties that describe a container group resource. Container group definition\n properties can't be updated. To change a property, create a new container group\n definition.
\n\n Used with:\n CreateContainerGroupDefinition\n
\n\n Returned by:\n DescribeContainerGroupDefinition, ListContainerGroupDefinitions\n
" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^arn:.*:containergroupdefinition\\/containergroupdefinition-[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinition" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$|^arn:.*:containergroupdefinition\\/[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArnLimitedList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionProperty" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionProperty": { + "type": "structure", + "members": { + "SchedulingStrategy": { + "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "traits": { + "smithy.api#documentation": "The method for scheduling and maintaining copies of the container group across a container\n fleet.
" + } + }, + "ContainerGroupDefinitionName": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionName", + "traits": { + "smithy.api#documentation": "The unique identifier for the container group definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nThe properties of a container group that is deployed to a container fleet.
\n\n Part of:\n ContainerGroupsAttributes\n
\n\n Returned by:\n DescribeFleetAttributes\n
" + } + }, + "com.amazonaws.gamelift#ContainerGroupDefinitionStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "COPYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPYING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.gamelift#ContainerGroupsAttributes": { + "type": "structure", + "members": { + "ContainerGroupDefinitionProperties": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionPropertiesList", + "traits": { + "smithy.api#documentation": "A collection of properties that describe each container group in the fleet. A container fleet is deployed with\n one or more ContainerGroupDefinition resources, which is where these properties are set.
" + } + }, + "ConnectionPortRange": { + "target": "com.amazonaws.gamelift#ConnectionPortRange", + "traits": { + "smithy.api#documentation": "A set of ports that allow inbound traffic to connect to processes running in the fleet's\n container groups. Amazon GameLift maps each connection port to a container port, which is assigned to\n a specific container process. A fleet's connection port range can't be changed, but you can\n control access to connection ports by updating a fleet's EC2InboundPermissions\n with UpdateFleetPortSettings.
Details about the number of replica container groups that Amazon GameLift deploys to each instance in\n the container fleet.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nThe properties of container groups that are running on a container fleet. Container group\n properties for a fleet can't be changed.
\n\n Returned by:\n DescribeFleetAttributes, CreateFleet\n
" + } + }, + "com.amazonaws.gamelift#ContainerGroupsConfiguration": { + "type": "structure", + "members": { + "ContainerGroupDefinitionNames": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArnLimitedList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The list of container group definition names to deploy to a new container fleet.
", + "smithy.api#required": {} + } + }, + "ConnectionPortRange": { + "target": "com.amazonaws.gamelift#ConnectionPortRange", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A set of ports to allow inbound traffic, including game clients, to connect to processes\n running in the container fleet.
\nConnection ports are dynamically mapped to container ports, which are assigned to\n individual processes running in a container. The connection port range must have enough ports\n to map to all container ports across a fleet instance. To calculate the minimum connection\n ports needed, use the following formula:
\n\n [Total number of container ports as defined for containers in the replica\n container group] * [Desired or calculated number of replica container groups per instance] +\n [Total number of container ports as defined for containers in the daemon container\n group]\n
\nAs a best practice, double the minimum number of connection ports.
\nUse the fleet's EC2InboundPermissions property to control external access to\n connection ports. Set this property to the connection port numbers that you want to open\n access to. See IpPermission for more details.
The number of times to replicate the replica container group on each instance in a container\n fleet. By default, Amazon GameLift calculates the maximum number of replica container groups that can\n fit on a fleet instance (based on CPU and memory resources). Leave this parameter empty if you\n want to use the maximum number, or specify a desired number to override the maximum. The\n desired number is used if it's less than the maximum number.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nConfiguration details for a set of container groups, for use when creating a fleet with\n compute type CONTAINER.
\n Used with:\n CreateFleet\n
" + } + }, + "com.amazonaws.gamelift#ContainerGroupsPerInstance": { + "type": "structure", + "members": { + "DesiredReplicaContainerGroupsPerInstance": { + "target": "com.amazonaws.gamelift#ReplicaContainerGroupsPerInstance", + "traits": { + "smithy.api#documentation": "The desired number of replica container groups to place on each fleet instance.
" + } + }, + "MaxReplicaContainerGroupsPerInstance": { + "target": "com.amazonaws.gamelift#ReplicaContainerGroupsPerInstance", + "traits": { + "smithy.api#documentation": "The maximum possible number of replica container groups that each fleet instance can\n have.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDetermines how many replica container groups that Amazon GameLift deploys to each instance in a\n container fleet.
\nAmazon GameLift calculates the maximum possible replica groups per instance based on the instance\n 's CPU and memory resources. When deploying a fleet, Amazon GameLift places replica container groups\n on each fleet instance based on the following:
\nIf no desired value is set, Amazon GameLift places the calculated maximum.
\nIf a desired number is set to a value higher than the calculated maximum, Amazon GameLift\n places the calculated maximum.
\nIf a desired number is set to a value lower than the calculated maximum, Amazon GameLift\n places the desired number.
\n\n Part of:\n ContainerGroupsConfiguration, ContainerGroupsAttributes\n
\n\n Returned by:\n DescribeFleetAttributes, CreateFleet\n
" + } + }, + "com.amazonaws.gamelift#ContainerHealthCheck": { + "type": "structure", + "members": { + "Command": { + "target": "com.amazonaws.gamelift#ContainerCommandStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A string array that specifies the command that the container runs to determine if it's\n healthy.
", + "smithy.api#required": {} + } + }, + "Interval": { + "target": "com.amazonaws.gamelift#ContainerHealthCheckInterval", + "traits": { + "smithy.api#documentation": "The time period (in seconds) between each health check.
" + } + }, + "Timeout": { + "target": "com.amazonaws.gamelift#ContainerHealthCheckTimeout", + "traits": { + "smithy.api#documentation": "The time period (in seconds) to wait for a health check to succeed before a failed health\n check is counted.
" + } + }, + "Retries": { + "target": "com.amazonaws.gamelift#ContainerHealthCheckRetries", + "traits": { + "smithy.api#documentation": "The number of times to retry a failed health check before the container is considered\n unhealthy. The first run of the command does not count as a retry.
" + } + }, + "StartPeriod": { + "target": "com.amazonaws.gamelift#ContainerHealthCheckStartPeriod", + "traits": { + "smithy.api#documentation": "The optional grace period (in seconds) to give a container time to bootstrap before the\n first failed health check counts toward the number of retries.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Instructions on when and how to check the health of a container in a container fleet. When\n health check properties are set in a container definition, they override any Docker health\n checks in the container image. For more information on container health checks, see HealthCheck command in the Amazon Elastic Container Service API.
\nThe following example instructions tell the container to wait 100 seconds after launch\n before counting failed health checks, then initiate the health check command every 60 seconds.\n After issuing the health check command, wait 10 seconds for it to succeed. If it fails, retry\n the command 3 times before considering the container to be unhealthy.
\n\n {\"Command\": [ \"CMD-SHELL\", \"ps cax | grep \"processmanager\" || exit 1\" ], \"Interval\":\n 300, \"Timeout\": 30, \"Retries\": 5, \"StartPeriod\": 100 }\n
\n Part of:\n ContainerDefinition$HealthCheck\n
" + } + }, + "com.amazonaws.gamelift#ContainerHealthCheckInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 300 + } + } + }, + "com.amazonaws.gamelift#ContainerHealthCheckRetries": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 10 + } + } + }, + "com.amazonaws.gamelift#ContainerHealthCheckStartPeriod": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 300 + } + } + }, + "com.amazonaws.gamelift#ContainerHealthCheckTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30, + "max": 60 + } + } + }, + "com.amazonaws.gamelift#ContainerMemoryLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 4, + "max": 1024000 + } + } + }, + "com.amazonaws.gamelift#ContainerMemoryLimits": { + "type": "structure", + "members": { + "SoftLimit": { + "target": "com.amazonaws.gamelift#ContainerMemoryLimit", + "traits": { + "smithy.api#documentation": "The amount of memory that is reserved for a container. When the container group's shared\n memory is under contention, the system attempts to maintain the container memory usage at this\n soft limit. However, the container can use more memory when needed, if available. This\n property is similar to the Amazon ECS container definition parameter memoryreservation (Amazon Elastic Container Service Developer Guide).
" + } + }, + "HardLimit": { + "target": "com.amazonaws.gamelift#ContainerMemoryLimit", + "traits": { + "smithy.api#documentation": "The maximum amount of memory that the container can use. If a container attempts to exceed\n this limit, the container is stopped. This property is similar to the Amazon ECS container\n definition parameter memory in the Amazon Elastic Container Service Developer Guide.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies how much memory is available to a container. You can't change this value after\n you create this object.
\n\n Part of: \n ContainerDefinition$MemoryLimits\n
" + } + }, + "com.amazonaws.gamelift#ContainerOperatingSystem": { + "type": "enum", + "members": { + "AMAZON_LINUX_2023": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_LINUX_2023" + } } - }, - "traits": { - "smithy.api#documentation": "An Amazon GameLift compute resource for hosting your game servers. A compute can be an\n EC2instance in a managed EC2 fleet or a registered compute in an Anywhere fleet.
" } }, - "com.amazonaws.gamelift#ComputeArn": { - "type": "string", + "com.amazonaws.gamelift#ContainerPortConfiguration": { + "type": "structure", + "members": { + "ContainerPortRanges": { + "target": "com.amazonaws.gamelift#ContainerPortRangeList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies one or more ranges of ports on a container.\n These ranges must not overlap.\n
", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^arn:.*:compute\\/[a-zA-Z0-9\\-]+$" + "smithy.api#documentation": "Defines ranges of ports that server processes can connect to.\n
\n\n Part of:\n ContainerDefinition$PortConfiguration\n
" } }, - "com.amazonaws.gamelift#ComputeAuthToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 + "com.amazonaws.gamelift#ContainerPortMapping": { + "type": "structure", + "members": { + "ContainerPort": { + "target": "com.amazonaws.gamelift#PortNumber", + "traits": { + "smithy.api#documentation": "The port opened on the container.
" + } }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + "ConnectionPort": { + "target": "com.amazonaws.gamelift#PortNumber", + "traits": { + "smithy.api#documentation": "The port opened on the fleet instance. This is also called the \"host port\".
" + } + }, + "Protocol": { + "target": "com.amazonaws.gamelift#IpProtocol", + "traits": { + "smithy.api#documentation": "The network protocol that this mapping supports.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\n Defines how an internal-facing container port is mapped to an external-facing connection\n port on a fleet instance of compute type CONTAINER. Incoming traffic, such as a\n game client, uses a connection port to connect to a process in the container fleet. Amazon GameLift\n directs the inbound traffic to the container port that is assigned to the process, such as a\n game session, running on a container.
\n Part of:\n ContainerAttributes\n
" } }, - "com.amazonaws.gamelift#ComputeList": { + "com.amazonaws.gamelift#ContainerPortMappingList": { "type": "list", "member": { - "target": "com.amazonaws.gamelift#Compute" - } - }, - "com.amazonaws.gamelift#ComputeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" - } - }, - "com.amazonaws.gamelift#ComputeNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+|^arn:.*:compute\\/[a-zA-Z0-9\\-]+$" + "target": "com.amazonaws.gamelift#ContainerPortMapping" } }, - "com.amazonaws.gamelift#ComputeStatus": { - "type": "enum", + "com.amazonaws.gamelift#ContainerPortRange": { + "type": "structure", "members": { - "PENDING": { - "target": "smithy.api#Unit", + "FromPort": { + "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#enumValue": "PENDING" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A starting value for the range of allowed port numbers.
", + "smithy.api#required": {} } }, - "ACTIVE": { - "target": "smithy.api#Unit", + "ToPort": { + "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#enumValue": "ACTIVE" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An ending value for the range of allowed port numbers.\n Port numbers are end-inclusive.\n This value must be equal to or greater than FromPort.
The network protocol that these ports support.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nA set of one or more port numbers that can be opened on the container. \n
\n\n Part of:\n ContainerPortConfiguration\n
" } }, - "com.amazonaws.gamelift#ComputeType": { + "com.amazonaws.gamelift#ContainerPortRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#ContainerPortRange" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.gamelift#ContainerSchedulingStrategy": { "type": "enum", "members": { - "EC2": { + "REPLICA": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EC2" + "smithy.api#enumValue": "REPLICA" } }, - "ANYWHERE": { + "DAEMON": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ANYWHERE" + "smithy.api#enumValue": "DAEMON" } } } }, - "com.amazonaws.gamelift#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.gamelift#NonEmptyString" + "com.amazonaws.gamelift#ContainerTotalCpuLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 128, + "max": 10240 } - }, + } + }, + "com.amazonaws.gamelift#ContainerTotalMemoryLimit": { + "type": "integer", "traits": { - "smithy.api#documentation": "The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request.
\n ", - "smithy.api#error": "client" + "smithy.api#range": { + "min": 4, + "max": 1024000 + } } }, "com.amazonaws.gamelift#CreateAlias": { @@ -956,6 +1834,115 @@ "smithy.api#output": {} } }, + "com.amazonaws.gamelift#CreateContainerGroupDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#CreateContainerGroupDefinitionInput" + }, + "output": { + "target": "com.amazonaws.gamelift#CreateContainerGroupDefinitionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#ConflictException" + }, + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#LimitExceededException" + }, + { + "target": "com.amazonaws.gamelift#TaggingFailedException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n
\nCreates a ContainerGroupDefinition resource that describes a set of\n containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift container\n group is similar to a container \"task\" and \"pod\". Each container group can have one or more\n containers.
Use container group definitions when you create a container fleet. Container group\n definitions determine how Amazon GameLift deploys your containers to each instance in a container\n fleet.
\nYou can create two types of container groups, based on scheduling strategy:
\nA replica container group manages the containers that run\n your game server application and supporting software. Replica container groups might be\n replicated multiple times on each fleet instance, depending on instance resources.
\nA daemon container group manages containers that run other\n software, such as background services, logging, or test processes. You might use a daemon\n container group for processes that need to run only once per fleet instance, or processes\n that need to persist independently of the replica container group.
\nTo create a container group definition, specify a group name, a list of container\n definitions, and maximum total CPU and memory requirements for the container group. Specify an\n operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI\n tool, you can pass in your container definitions as a JSON file.
\nThis operation requires Identity and Access Management (IAM) permissions to access container images in\n Amazon ECR repositories. See IAM permissions\n for Amazon GameLift for help setting the appropriate permissions.
\nIf successful, this operation creates a new ContainerGroupDefinition resource\n with an ARN value assigned. You can't change the properties of a container group definition.\n Instead, create a new one.
\n Learn more\n
\nA descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "SchedulingStrategy": { + "target": "com.amazonaws.gamelift#ContainerSchedulingStrategy", + "traits": { + "smithy.api#documentation": "The method for deploying the container group across fleet instances. A replica container\n group might have multiple copies on each fleet instance. A daemon container group has one copy\n per fleet instance. Default value is REPLICA.
The maximum amount of memory (in MiB) to allocate to the container group. All containers in\n the group share this memory. If you specify memory limits for individual containers, set this\n parameter based on the following guidelines. The value must be (1) greater than the sum of the\n soft memory limits for all containers in the group, and (2) greater than any individual\n container's hard memory limit.
", + "smithy.api#required": {} + } + }, + "TotalCpuLimit": { + "target": "com.amazonaws.gamelift#ContainerTotalCpuLimit", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The maximum amount of CPU units to allocate to the container group. Set this parameter to an\n integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group\n share this memory. If you specify CPU limits for individual containers, set this parameter\n based on the following guidelines. The value must be equal to or greater than the sum of the\n CPU limits for all containers in the group.
", + "smithy.api#required": {} + } + }, + "ContainerDefinitions": { + "target": "com.amazonaws.gamelift#ContainerDefinitionInputList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Definitions for all containers in this group. Each container definition identifies the\n container image and specifies configuration settings for the container. See the \n Container fleet design guide for container guidelines.
", + "smithy.api#required": {} + } + }, + "OperatingSystem": { + "target": "com.amazonaws.gamelift#ContainerOperatingSystem", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The platform that is used by containers in the container group definition. All containers in\n a group must run on the same operating system.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.gamelift#TagList", + "traits": { + "smithy.api#documentation": "A list of labels to assign to the container group definition resource. Tags are\n developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management,\n access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the\n Amazon Web Services General Reference.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#CreateContainerGroupDefinitionOutput": { + "type": "structure", + "members": { + "ContainerGroupDefinition": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinition", + "traits": { + "smithy.api#documentation": "The properties of the newly created container group definition resource. You use this resource \n to create a container fleet.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#CreateFleet": { "type": "operation", "input": { @@ -980,6 +1967,9 @@ { "target": "com.amazonaws.gamelift#NotFoundException" }, + { + "target": "com.amazonaws.gamelift#NotReadyException" + }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, @@ -991,7 +1981,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your custom game server or\n Realtime Servers. Use this operation to configure the computing resources for your fleet and\n provide instructions for running game servers on each instance.
\nMost Amazon GameLift fleets can deploy instances to multiple locations, including the home\n Region (where the fleet is created) and an optional set of remote locations. Fleets that\n are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N.\n Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland),\n ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that\n are created in other Amazon GameLift Regions can deploy instances in the fleet's home Region\n only. All fleet instances use the same configuration regardless of location; however,\n you can adjust capacity settings and turn auto-scaling on/off for each location.
\nTo create a fleet, choose the hardware for your instances, specify a game server build\n or Realtime script to deploy, and provide a runtime configuration to direct Amazon GameLift how\n to start and run game servers on each instance in the fleet. Set permissions for inbound\n traffic to your game servers, and enable optional features as needed. When creating a\n multi-location fleet, provide a list of additional remote locations.
\nIf you need to debug your fleet, fetch logs, view performance metrics or other actions\n on the fleet, create the development fleet with port 22/3389 open. As a best practice,\n we recommend opening ports for remote access only when you need them and closing them\n when you're finished.
\nIf successful, this operation creates a new Fleet resource and places it in\n NEW status, which prompts Amazon GameLift to initiate the fleet creation\n workflow. You can track fleet creation by checking fleet status using DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by monitoring fleet creation events\n using DescribeFleetEvents.
When the fleet status changes to ACTIVE, you can enable automatic scaling\n with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. When the status of each remote location reaches\n ACTIVE, you can set capacity by location using UpdateFleetCapacity.
\n Learn more\n
\n\n Setting up\n fleets\n
\n\n Debug fleet creation issues\n
\n " + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nCreates a fleet of compute resources to host your game servers. Use this operation to\n set up the following types of fleets based on compute type:
\n\n Managed EC2 fleet\n
\nAn EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is\n deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the\n lifecycle of game server processes, which host game sessions for players. EC2 fleets can\n have instances in multiple locations. Each instance in the fleet is designated a\n Compute.
To create an EC2 fleet, provide these required parameters:
\nEither BuildId or ScriptId\n
\n ComputeType set to EC2 (the default value)
\n EC2InboundPermissions\n
\n EC2InstanceType\n
\n FleetType\n
\n Name\n
\n RuntimeConfiguration with at least one ServerProcesses\n configuration
If successful, this operation creates a new fleet resource and places it in\n NEW status while Amazon GameLift initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance\n metrics or other actions on the fleet, create a development fleet with port 22/3389\n open. As a best practice, we recommend opening ports for remote access only when you\n need them and closing them when you're finished.
When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling\n on/off for each location.
\n\n Managed container fleet\n
\nA container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture\n is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the\n containers on each fleet instance and controls the lifecycle of game server processes,\n which host game sessions for players. Container fleets can have instances in multiple\n locations. Each container on an instance that runs game server processes is registered\n as a Compute.
To create a container fleet, provide these required parameters:
\n\n ComputeType set to CONTAINER\n
\n ContainerGroupsConfiguration\n
\n EC2InboundPermissions\n
\n EC2InstanceType\n
\n FleetType set to ON_DEMAND\n
\n Name\n
\n RuntimeConfiguration with at least one ServerProcesses\n configuration
If successful, this operation creates a new fleet resource and places it in\n NEW status while Amazon GameLift initiates the fleet creation workflow.
When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling\n on/off for each location.
\n\n Anywhere fleet\n
\nAn Anywhere fleet represents compute resources that are not owned or managed by\n Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use\n one to host game servers with on-premises hardware or other game hosting solutions.
\nTo create an Anywhere fleet, provide these required parameters:
\n\n ComputeType set to ANYWHERE\n
\n Locations specifying a custom location
\n Name\n
If successful, this operation creates a new fleet resource and places it in\n ACTIVE status. You can register computes with a fleet in\n ACTIVE status.
\n Learn more\n
\n\n Setting up\n fleets\n
\n\n Setting up a container fleet\n
\n\n Debug fleet creation issues\n
\n " } }, "com.amazonaws.gamelift#CreateFleetInput": { @@ -1014,13 +2004,13 @@ "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier for a custom game server build to be deployed on fleet\n instances. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift\n and in READY status. This fleet property can't be changed after the fleet is created.
The unique identifier for a custom game server build to be deployed to a fleet with\n compute type EC2. You can use either the build ID or ARN. The build must be\n uploaded to Amazon GameLift and in READY status. This fleet property can't be changed after the fleet is created.
The unique identifier for a Realtime configuration script to be deployed on fleet\n instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift\n prior to creating the fleet. This fleet property can't be changed after the fleet is created.
" + "smithy.api#documentation": "The unique identifier for a Realtime configuration script to be deployed to a fleet with\n compute type EC2. You can use either the script ID or ARN. Scripts must be\n uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be changed after the fleet is created.
The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance\n type determines the computing resources that will be used to host your game servers,\n including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions\n of Amazon EC2 instance types.
" + "smithy.api#documentation": "The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.\n Instance type determines the computing resources that will be used to host your game\n servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for\n detailed descriptions of Amazon EC2 instance types.
" } }, "EC2InboundPermissions": { "target": "com.amazonaws.gamelift#IpPermissionsList", "traits": { - "smithy.api#documentation": "The allowed IP address ranges and port settings that allow inbound traffic to access\n game sessions on this fleet. If the fleet is hosting a custom game build, this property\n must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift\n automatically sets TCP and UDP ranges.
" + "smithy.api#documentation": "The IP address ranges and port settings that allow inbound traffic to access game\n server processes and other processes on this fleet. Set this parameter for EC2 and container \n fleets. You can leave this parameter empty when creating the fleet, but you must call \n UpdateFleetPortSettings to set it before players can connect to game sessions. \n As a best practice, we recommend \n opening ports for remote access only when you need them and closing them when you're finished. \n For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
\nTo manage inbound access for a container fleet, set this parameter to the same port\n numbers that you set for the fleet's connection port range. During the life of the\n fleet, update this parameter to control which connection ports are open to inbound\n traffic.
" } }, "NewGameSessionProtectionPolicy": { @@ -1062,7 +2052,7 @@ "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "Instructions for how to launch and maintain server processes on instances in the\n fleet. The runtime configuration defines one or more server process configurations, each\n identifying a build executable or Realtime script file and the number of processes of\n that type to run concurrently.
\nThe RuntimeConfiguration parameter is required unless the fleet is\n being configured using the older parameters ServerLaunchPath and\n ServerLaunchParameters, which are still supported for backward\n compatibility.
Instructions for how to launch and run server processes on the fleet. Set runtime\n configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this\n parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration\n defines one or more server process configurations. Each server process identifies a game\n executable or Realtime script file and the number of processes to run concurrently.
\nThis parameter replaces the parameters ServerLaunchPath and\n ServerLaunchParameters, which are still supported for backward\n compatibility.
A set of remote locations to deploy additional instances to and manage as part of the\n fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that\n support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote\n location, in the form of an Amazon Web Services Region code such as us-west-2. To create\n a fleet with instances in the home Region only, don't use this parameter.
To use this parameter, Amazon GameLift requires you to use your home location in the\n request.
" + "smithy.api#documentation": "A set of remote locations to deploy additional instances to and manage as part of the\n fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that\n support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote\n location, in the form of an Amazon Web Services Region code, such as us-west-2 or Local\n Zone code. To create a fleet with instances in the home Region only, don't set this\n parameter.
When using this parameter, Amazon GameLift requires you to include your home location in the\n request.
" } }, "Tags": { @@ -1122,7 +2112,7 @@ "ComputeType": { "target": "com.amazonaws.gamelift#ComputeType", "traits": { - "smithy.api#documentation": "The type of compute resource used to host your game servers. You can use your own\n compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed\n Amazon GameLift. By default, this property is set to EC2.
The type of compute resource used to host your game servers.
\n\n EC2 – The game server build is deployed to Amazon EC2 instances for\n cloud hosting. This is the default setting.
\n CONTAINER – Container images with your game server build and\n supporting software are deployed to Amazon EC2 instances for cloud hosting. With this\n compute type, you must specify the ContainerGroupsConfiguration\n parameter.
\n ANYWHERE – Game servers or container images with your game server\n and supporting software are deployed to compute resources that are provided and\n managed by you. With this compute type, you can also set the\n AnywhereConfiguration parameter.
Prompts Amazon GameLift to generate a shared credentials file for the IAM role\n defined in InstanceRoleArn. The shared credentials file is stored on each\n fleet instance and refreshed as needed. Use shared credentials for applications that are\n deployed along with the game server executable, if the game server is integrated with \n server SDK version 5.x. For more information about using shared\n credentials, see Communicate\n with other Amazon Web Services resources from your fleets.
Prompts Amazon GameLift to generate a shared credentials file for the IAM role\n that's defined in InstanceRoleArn. The shared credentials file is stored on\n each fleet instance and refreshed as needed. Use shared credentials for applications\n that are deployed along with the game server executable, if the game server is\n integrated with server SDK version 5.x. For more information about using shared\n credentials, see Communicate\n with other Amazon Web Services resources from your fleets.
The container groups to deploy to instances in the container fleet and other fleet-level\n configuration settings. Use the CreateContainerGroupDefinition action\n to create container groups. A container fleet must have exactly one replica container\n group, and can optionally have one daemon container group. You can't change this\n property after you create the fleet.
" } } }, @@ -1169,6 +2165,9 @@ { "target": "com.amazonaws.gamelift#NotFoundException" }, + { + "target": "com.amazonaws.gamelift#NotReadyException" + }, { "target": "com.amazonaws.gamelift#UnauthorizedException" }, @@ -1177,7 +2176,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds remote locations to a fleet and begins populating the new locations with EC2\n instances. The new instances conform to the fleet's instance type, auto-scaling, and\n other configuration settings.
\nThis operation cannot be used with fleets that don't support remote locations.\n Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support\n this feature and were created after the feature was released in March 2021.
\nTo add fleet locations, specify the fleet to be updated and provide a list of one or\n more locations.
\nIf successful, this operation returns the list of added locations with their status\n set to NEW. Amazon GameLift initiates the process of starting an instance in each\n added location. You can track the status of each new location by monitoring location\n creation events using DescribeFleetEvents.
\n Learn more\n
\n\n Setting up\n fleets\n
\n " + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nAdds remote locations to an EC2 or container fleet and begins populating the new\n locations with instances. The new instances conform to the fleet's instance type,\n auto-scaling, and other configuration settings.
\nYou can't add remote locations to a fleet that resides in an Amazon Web Services Region that\n doesn't support multiple locations. Fleets created prior to March 2021 can't support\n multiple locations.
\nTo add fleet locations, specify the fleet to be updated and provide a list of one or\n more locations.
\nIf successful, this operation returns the list of added locations with their status\n set to NEW. Amazon GameLift initiates the process of starting an instance in each\n added location. You can track the status of each new location by monitoring location\n creation events using DescribeFleetEvents.
\n Learn more\n
\n\n Setting up\n fleets\n
\n " } }, "com.amazonaws.gamelift#CreateFleetLocationsInput": { @@ -2386,14 +3385,62 @@ "smithy.api#documentation": "Deletes a build. This operation permanently deletes the build resource and any\n uploaded build files. Deleting a build does not affect the status of any active fleets\n using the build, but you can no longer create new fleets with the deleted build.
\nTo delete a build, specify the build ID.
\n\n Learn more\n
\n\n Upload a Custom\n Server Build\n
\n\n All APIs by task\n
" } }, - "com.amazonaws.gamelift#DeleteBuildInput": { + "com.amazonaws.gamelift#DeleteBuildInput": { + "type": "structure", + "members": { + "BuildId": { + "target": "com.amazonaws.gamelift#BuildIdOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique identifier for the build to delete. You can use either the build ID or ARN value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#DeleteContainerGroupDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#DeleteContainerGroupDefinitionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" + }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#TaggingFailedException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + }, + { + "target": "com.amazonaws.gamelift#UnsupportedRegionException" + } + ], + "traits": { + "smithy.api#documentation": "\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n
\nDeletes a container group definition resource. You can delete a container group definition\n if there are no fleets using the definition.
\nTo delete a container group definition, identify the resource to delete.
\n\n Learn more\n
\nA unique identifier for the build to delete. You can use either the build ID or ARN value.
", + "smithy.api#documentation": "The unique identifier for the container group definition to delete. You can use either the Name or ARN\n value.
Deletes all resources and information related a fleet. Any current fleet instances,\n including those in remote locations, are shut down. You don't need to call\n DeleteFleetLocations separately.
If the fleet being deleted has a VPC peering connection, you first need to get a\n valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the\n VPC peering connection.
\nTo delete a fleet, specify the fleet ID to be terminated. During the deletion process\n the fleet status is changed to DELETING. When completed, the status\n switches to TERMINATED and the fleet event FLEET_DELETED is\n sent.
\n Learn more\n
\n\n Setting up Amazon GameLift\n Fleets\n
" + "smithy.api#documentation": "Deletes all resources and information related to a fleet and shuts down any currently\n running fleet instances, including those in remote locations.
\nIf the fleet being deleted has a VPC peering connection, you first need to get a\n valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You don't need to explicitly delete the\n VPC peering connection.
\nTo delete a fleet, specify the fleet ID to be terminated. During the deletion process,\n the fleet status is changed to DELETING. When completed, the status\n switches to TERMINATED and the fleet event FLEET_DELETED is\n emitted.
\n Learn more\n
\n\n Setting up Amazon GameLift\n Fleets\n
" } }, "com.amazonaws.gamelift#DeleteFleetInput": { @@ -3028,7 +4075,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes a compute resource from an Amazon GameLift Anywhere fleet. Deregistered computes can no\n longer host game sessions through Amazon GameLift.
" + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRemoves a compute resource from an Amazon GameLift Anywhere fleet or container fleet.\n Deregistered computes can no longer host game sessions through Amazon GameLift.
\nFor an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent\n handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the\n Agent, call this operation to deregister fleet computes.
\nTo deregister a compute, call this operation from the compute that's being\n deregistered and specify the compute name and the fleet ID.
" } }, "com.amazonaws.gamelift#DeregisterComputeInput": { @@ -3046,7 +4093,7 @@ "target": "com.amazonaws.gamelift#ComputeNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the compute resource to remove from the specified Anywhere fleet.
", + "smithy.api#documentation": "The unique identifier of the compute resource to deregister. For an Anywhere fleet\n compute, use the registered compute name. For a container fleet, use the compute name\n (for example,\n a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)\n or the compute ARN.
Retrieves properties for a compute resource in an Amazon GameLift fleet. Call ListCompute to get a list of compute resources in a fleet. You can\n request information for computes in either managed EC2 fleets or Anywhere fleets.
\nTo request compute properties, specify the compute name and fleet ID.
\nIf successful, this operation returns details for the requested compute resource. For\n managed EC2 fleets, this operation returns the fleet's EC2 instances. For Anywhere\n fleets, this operation returns the fleet's registered computes.
" + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all\n computes in a fleet, call ListCompute.
\nTo request information on a specific compute, provide the fleet ID and compute\n name.
\nIf successful, this operation returns details for the requested compute resource.\n Depending on the fleet's compute type, the result includes the following information:
\nFor EC2 fleets, this operation returns information about the EC2\n instance.
For ANYWHERE fleets, this operation returns information about the\n registered compute.
For CONTAINER fleets, this operation returns information about\n the container that's registered as a compute, and the instance it's running on.\n The compute name is the container name.
A unique identifier for the fleet that the compute is registered to. You can use either the fleet ID or ARN\n value.
", + "smithy.api#documentation": "A unique identifier for the fleet that the compute belongs to. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, @@ -3265,7 +4312,7 @@ "target": "com.amazonaws.gamelift#ComputeNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique identifier of the compute resource to retrieve properties for. For an\n Anywhere fleet compute, use the registered compute name. For a managed EC2 fleet\n instance, use the instance ID.
", + "smithy.api#documentation": "The unique identifier of the compute resource to retrieve properties for. For an\n Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use\n the instance ID. For a container fleet, use the compute name (for example,\n a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)\n or the compute ARN.
\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n
\nRetrieves the properties of a container group definition, including all container\n definitions in the group.
\nTo retrieve a container group definition, provide a resource identifier. If successful,\n this operation returns the complete properties of the container group definition.
\n\n Learn more\n
\nThe unique identifier for the container group definition to retrieve properties for. You can use either the Name or\n ARN value.
The properties of the requested container group definition resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#DescribeEC2InstanceLimits": { "type": "operation", "input": { @@ -3371,7 +4477,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves core fleet-wide properties, including the computing hardware and deployment\n configuration for all instances in the fleet.
\nThis operation can be used in the following ways:
\nTo get attributes for one or more specific fleets, provide a list of fleet IDs\n or fleet ARNs.
\nTo get attributes for all fleets, do not provide a fleet identifier.
\nWhen requesting attributes for multiple fleets, use the pagination parameters to\n retrieve results as a set of sequential pages.
\nIf successful, a FleetAttributes object is returned for each fleet\n requested, unless the fleet identifier is not found.
Some API operations limit the number of fleet IDs that allowed in one request. If\n a request exceeds this limit, the request fails and the error message contains the\n maximum allowed number.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
", + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing\n hardware and deployment configuration for instances in the fleet.
\nYou can use this operation in the following ways:
\nTo get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.
\nTo get attributes for all fleets, do not provide a fleet identifier.
\nWhen requesting attributes for multiple fleets, use the pagination parameters to\n retrieve results as a set of sequential pages.
\nIf successful, a FleetAttributes object is returned for each fleet\n requested, unless the fleet identifier is not found.
Some API operations limit the number of fleet IDs that allowed in one request. If\n a request exceeds this limit, the request fails and the error message contains the\n maximum allowed number.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3449,7 +4555,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the resource capacity settings for one or more fleets. The data returned\n includes the current fleet capacity (number of EC2 instances), and settings that can\n control how capacity scaling. For fleets with remote locations, this operation retrieves\n data for the fleet's home Region only.
\nThis operation can be used in the following ways:
\nTo get capacity data for one or more specific fleets, provide a list of fleet\n IDs or fleet ARNs.
\nTo get capacity data for all fleets, do not provide a fleet identifier.\n
\nWhen requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.
\nIf successful, a FleetCapacity object is returned for each requested\n fleet ID. Each FleetCapacity object includes a Location property, which is\n set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects\n are returned only for fleets that currently exist.
Some API operations may limit the number of fleet IDs that are allowed in one\n request. If a request exceeds this limit, the request fails and the error message\n includes the maximum allowed.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
\n\n GameLift metrics for fleets\n
", + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves the resource capacity settings for one or more fleets. For a container\n fleet, this operation also returns counts for replica container groups.
\nWith multi-location fleets, this operation retrieves data for the fleet's home Region\n only. To retrieve capacity for remote locations, see \n DescribeFleetLocationCapacity.
\nThis operation can be used in the following ways:
\nTo get capacity data for one or more specific fleets, provide a list of fleet\n IDs or fleet ARNs.
\nTo get capacity data for all fleets, do not provide a fleet identifier.\n
\nWhen requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.
\nIf successful, a FleetCapacity object is returned for each requested\n fleet ID. Each FleetCapacity object includes a Location\n property, which is set to the fleet's home Region. Capacity values are returned only for\n fleets that currently exist.
Some API operations may limit the number of fleet IDs that are allowed in one\n request. If a request exceeds this limit, the request fails and the error message\n includes the maximum allowed.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
\n\n GameLift metrics for fleets\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3722,7 +4828,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the resource capacity settings for a fleet location. The data returned\n includes the current capacity (number of EC2 instances) and some scaling settings for\n the requested fleet location. Use this operation to retrieve capacity information for a\n fleet's remote location or home Region (you can also retrieve home Region capacity by\n calling DescribeFleetCapacity).
To retrieve capacity data, identify a fleet and location.
\nIf successful, a FleetCapacity object is returned for the requested fleet\n location.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
\n\n GameLift metrics for fleets\n
" + "smithy.api#documentation": "Retrieves the resource capacity settings for a fleet location. The data returned\n includes the current capacity (number of EC2 instances) and some scaling settings for\n the requested fleet location. For a container fleet, this operation also returns counts\n for replica container groups.
\nUse this operation to retrieve capacity information for a fleet's remote location or\n home Region (you can also retrieve home Region capacity by calling\n DescribeFleetCapacity).
To retrieve capacity data, identify a fleet and location.
\nIf successful, a FleetCapacity object is returned for the requested fleet\n location.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
\n\n GameLift metrics for fleets\n
" } }, "com.amazonaws.gamelift#DescribeFleetLocationCapacityInput": { @@ -3856,7 +4962,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a fleet's inbound connection permissions. Connection permissions specify the\n range of IP addresses and port settings that incoming traffic can use to access server\n processes in the fleet. Game sessions that are running on instances in the fleet must\n use connections that fall in this range.
\nThis operation can be used in the following ways:
\nTo retrieve the inbound connection permissions for a fleet, identify the\n fleet's unique identifier.
\nTo check the status of recent updates to a fleet remote location, specify the\n fleet ID and a location. Port setting updates can take time to propagate across\n all locations.
\nIf successful, a set of IpPermission objects is returned for the\n requested fleet ID. When a location is specified, a pending status is included. If the\n requested fleet has been deleted, the result set is empty.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" + "smithy.api#documentation": "Retrieves a fleet's inbound connection permissions. Connection permissions specify IP\n addresses and port settings that incoming traffic can use to access server processes in\n the fleet. Game server processes that are running in the fleet must use a port that\n falls within this range. To connect to game server processes on a container fleet, the\n port settings should include one or more of the fleet's connection ports.
\nUse this operation in the following ways:
\nTo retrieve the port settings for a fleet, identify the fleet's unique\n identifier.
\nTo check the status of recent updates to a fleet remote location, specify the\n fleet ID and a location. Port setting updates can take time to propagate across\n all locations.
\nIf successful, a set of IpPermission objects is returned for the\n requested fleet ID. When specifying a location, this operation returns a pending status.\n If the requested fleet has been deleted, the result set is empty.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" } }, "com.amazonaws.gamelift#DescribeFleetPortSettingsInput": { @@ -4981,7 +6087,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a fleet's runtime configuration settings. The runtime configuration tells\n Amazon GameLift which server processes to run (and how) on each instance in the fleet.
\nTo get the runtime configuration that is currently in forces for a fleet, provide the\n fleet ID.
\nIf successful, a RuntimeConfiguration object is returned for the\n requested fleet. If the requested fleet has been deleted, the result set is\n empty.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
\n\n Running multiple\n processes on a fleet\n
" + "smithy.api#documentation": "Retrieves a fleet's runtime configuration settings. The runtime configuration\n determines which server processes run, and how, on computes in the fleet. For managed\n EC2 fleets, the runtime configuration describes server processes that run on each fleet\n instance. For container fleets, the runtime configuration describes server processes\n that run in each replica container group. You can update a fleet's runtime configuration\n at any time using UpdateRuntimeConfiguration.
\nTo get the current runtime configuration for a fleet, provide the fleet ID.
\nIf successful, a RuntimeConfiguration object is returned for the\n requested fleet. If the requested fleet has been deleted, the result set is\n empty.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
\n\n Running multiple\n processes on a fleet\n
" } }, "com.amazonaws.gamelift#DescribeRuntimeConfigurationInput": { @@ -5006,7 +6112,7 @@ "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "Instructions that describe how server processes should be launched and maintained on\n each instance in the fleet.
" + "smithy.api#documentation": "Instructions that describe how server processes are launched and maintained on\n computes in the fleet.
" } } }, @@ -6489,6 +7595,12 @@ "traits": { "smithy.api#documentation": "Location of stored logs with additional detail that is related to the event. This is\n useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet\n creation logs through the Amazon GameLift console.
" } + }, + "Count": { + "target": "com.amazonaws.gamelift#EventCount", + "traits": { + "smithy.api#documentation": "The number of times that this event occurred.
" + } } }, "traits": { @@ -6704,6 +7816,15 @@ } } }, + "com.amazonaws.gamelift#EventCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 101 + } + } + }, "com.amazonaws.gamelift#EventList": { "type": "list", "member": { @@ -6794,13 +7915,13 @@ "FleetType": { "target": "com.amazonaws.gamelift#FleetType", "traits": { - "smithy.api#documentation": "Indicates whether to use On-Demand or Spot instances for this fleet. By default, this\n property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
Indicates whether the fleet uses On-Demand or Spot instances. For more information,\n see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
" } }, "InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "The Amazon EC2 instance type that determines the computing resources of each instance in\n the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See\n Amazon Elastic Compute Cloud Instance Types\n for detailed descriptions.
" + "smithy.api#documentation": "The Amazon EC2 instance type that the fleet uses. Instance type determines the computing\n resources of each instance in the fleet, including CPU, memory, storage, and networking\n capacity. See Amazon Elastic Compute Cloud Instance\n Types for detailed descriptions. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".
Current status of the fleet. Possible fleet statuses include the following:
\n\n NEW -- A new fleet has been defined and desired\n instances is set to 1.
\n\n DOWNLOADING/VALIDATING/BUILDING/ACTIVATING --\n Amazon GameLift is setting up the new fleet, creating new instances with the game build\n or Realtime script and starting server processes.
\n\n ACTIVE -- Hosts can now accept game\n sessions.
\n\n ERROR -- An error occurred when downloading,\n validating, building, or activating the fleet.
\n\n DELETING -- Hosts are responding to a delete\n fleet request.
\n\n TERMINATED -- The fleet no longer\n exists.
\nCurrent status of the fleet. Possible fleet statuses include the following:
\nNEW -- A new fleet has been defined and desired\n instances is set to 1.
\nDOWNLOADING/VALIDATING/BUILDING/ACTIVATING --\n Amazon GameLift is setting up the new fleet, creating new instances with the game build\n or Realtime script and starting server processes.
\nACTIVE -- Hosts can now accept game sessions.
\nERROR -- An error occurred when downloading,\n validating, building, or activating the fleet.
\nDELETING -- Hosts are responding to a delete fleet request.
\nTERMINATED -- The fleet no longer exists.
\nA unique identifier for the build resource that is deployed on instances in this fleet.
" + "smithy.api#documentation": "A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with\n fleets where ComputeType is \"EC2\".
The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in\n this fleet. In a GameLift build ARN, the resource ID matches the BuildId\n value.
The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in\n this fleet. In a GameLift build ARN, the resource ID matches the BuildId\n value. This attribute is used with fleets where ComputeType is \"EC2\".
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
" + "smithy.api#documentation": "A unique identifier for the Realtime script resource that is deployed on instances in this fleet.\n This attribute is used with fleets where ComputeType is \"EC2\".
\n This parameter is no longer used. Server launch paths\n are now defined using the fleet's\n RuntimeConfiguration\n . Requests that use this parameter instead continue to be valid.
" + "smithy.api#documentation": "\n This parameter is no longer used. Server launch paths\n are now defined using the fleet's\n RuntimeConfiguration\n . Requests that use this parameter continue to be valid.
" } }, "ServerLaunchParameters": { "target": "com.amazonaws.gamelift#LaunchParametersStringModel", "traits": { - "smithy.api#documentation": "\n This parameter is no longer used. Server launch\n parameters are now defined using the fleet's runtime configuration\n . Requests that use this parameter instead continue to be valid.
" + "smithy.api#documentation": "\n This parameter is no longer used. Server launch\n parameters are now defined using the fleet's runtime configuration\n . Requests that use this parameter continue to be valid.
" } }, "LogPaths": { @@ -6878,13 +7999,13 @@ "NewGameSessionProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { - "smithy.api#documentation": "The type of game session protection to set on all new instances that are started in\n the fleet.
\n\n NoProtection -- The game session can be\n terminated during a scale-down event.
\n\n FullProtection -- If the game session is in an\n ACTIVE status, it cannot be terminated during a scale-down\n event.
The type of game session protection to set on all new instances that are started in\n the fleet. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".
\n NoProtection -- The game session can be\n terminated during a scale-down event.
\n\n FullProtection -- If the game session is in an\n ACTIVE status, it cannot be terminated during a scale-down\n event.
The operating system of the fleet's computing resources. A fleet's operating system is\n determined by the OS of the build or script that is deployed on this fleet.
" + "smithy.api#documentation": "The operating system of the fleet's computing resources. A fleet's operating system is\n determined by the OS of the build or script that is deployed on this fleet.\n This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".
Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch,\n you can view aggregated metrics for fleets that are in a metric group. A fleet can be\n included in only one metric group at a time.
" + "smithy.api#documentation": "Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch,\n you can view aggregated metrics for fleets that are in a metric group. A fleet can be\n included in only one metric group at a time. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
" + "smithy.api#documentation": "A list of fleet activity that has been suspended using StopFleetActions. \n This includes fleet auto-scaling. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".
A unique identifier for an IAM role with access permissions to other Amazon Web Services services. \n Any application that runs on an instance in the fleet--including install scripts, server processes, and other \n processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to.\n For more information about using the role with your game server builds, see \n \n Communicate with other Amazon Web Services resources from your fleets.
" + "smithy.api#documentation": "A unique identifier for an IAM role with access permissions to other Amazon Web Services services. \n Any application that runs on an instance in the fleet--including install scripts, server processes, and other \n processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to.\n For more information about using the role with your game server builds, see \n \n Communicate with other Amazon Web Services resources from your fleets. This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".
Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. \n All instances in a fleet share the same certificate.
" + } }, "ComputeType": { "target": "com.amazonaws.gamelift#ComputeType", @@ -6918,17 +8042,26 @@ } }, "AnywhereConfiguration": { - "target": "com.amazonaws.gamelift#AnywhereConfiguration" + "target": "com.amazonaws.gamelift#AnywhereConfiguration", + "traits": { + "smithy.api#documentation": "\n This property is used with the Amazon GameLift containers feature, which is currently in public preview. A set of attributes that describe the container groups that are deployed on the fleet.\n These attributes are included for fleets with compute type CONTAINER only.\n This attribute is used with fleets where ComputeType is \"Container\".
Indicates that fleet instances maintain a shared credentials file for the IAM role\n defined in InstanceRoleArn. Shared credentials allow applications that are\n deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used \n only when the game server is integrated with the\n server SDK version 5.x. For more information about using shared credentials, see Communicate\n with other Amazon Web Services resources from your fleets.
Indicates that fleet instances maintain a shared credentials file for the IAM role\n defined in InstanceRoleArn. Shared credentials allow applications that are\n deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used \n only when the game server is integrated with the\n server SDK version 5.x. For more information about using shared credentials, see Communicate\n with other Amazon Web Services resources from your fleets.\n This attribute is used with\n fleets where ComputeType is \"EC2\" or \"Container\".
A set of properties that describe the container groups that are deployed to the fleet.\n These attributes are included for fleets with compute type\n CONTAINER.
Describes a Amazon GameLift fleet of game hosting resources.
\n\n Related actions\n
" + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nDescribes an Amazon GameLift fleet of game hosting resources. Attributes differ based on\n the fleet's compute type, as follows:
\nEC2 fleet attributes identify a Build resource (for fleets with \n customer game server builds) or a Script resource (for Realtime Servers fleets).
Container fleets have ContainerGroupsAttributes, which identify\n the fleet's ContainerGroupDefinition resources.
Amazon GameLift Anywhere fleets have an abbreviated set of attributes, because most fleet configurations\n are set directly on the fleet's computes. Attributes include fleet identifiers and descriptive\n properties, creation/termination time, and fleet status.
\n\n Returned by:\n DescribeFleetAttributes\n
" } }, "com.amazonaws.gamelift#FleetAttributesList": { @@ -6955,21 +8088,30 @@ "InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "The Amazon EC2 instance type that is used for all instances in a fleet. The instance type\n determines the computing resources in use, including CPU, memory, storage, and\n networking capacity. See Amazon Elastic Compute Cloud\n Instance Types for detailed descriptions.
" + "smithy.api#documentation": "The Amazon EC2 instance type that is used for instances in a fleet. Instance type\n determines the computing resources in use, including CPU, memory, storage, and\n networking capacity. See Amazon Elastic Compute Cloud\n Instance Types for detailed descriptions.
" } }, "InstanceCounts": { - "target": "com.amazonaws.gamelift#EC2InstanceCounts" + "target": "com.amazonaws.gamelift#EC2InstanceCounts", + "traits": { + "smithy.api#documentation": "The current number of instances in the fleet, listed by instance status. Counts for pending and\n terminating instances might be non-zero if the fleet is adjusting to a scaling event\n or if access to resources is temporarily affected.
" + } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location for the instance count information, expressed as an Amazon Web Services Region\n code, such as us-west-2.
\n This property is used with the Amazon GameLift containers feature, which is currently in public preview. The number and status of replica container groups in a container fleet.
" + } } }, "traits": { - "smithy.api#documentation": "Current resource capacity settings in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.
\n\n Related actions\n
\n\n DescribeFleetCapacity | DescribeFleetLocationCapacity | UpdateFleetCapacity\n
" + "smithy.api#documentation": "Current resource capacity settings for managed EC2 fleets and container fleets. For\n multi-location fleets, location values might refer to a fleet's remote location or its\n home Region.
\n\n Returned by:\n DescribeFleetCapacity, DescribeFleetLocationCapacity, UpdateFleetCapacity\n
" } }, "com.amazonaws.gamelift#FleetCapacityExceededException": { @@ -7153,7 +8295,7 @@ } }, "traits": { - "smithy.api#documentation": "Current resource utilization statistics in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.
\n\n Related actions\n
" + "smithy.api#documentation": "Current resource utilization statistics in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home region.
" } }, "com.amazonaws.gamelift#FleetUtilizationList": { @@ -7201,6 +8343,9 @@ { "target": "com.amazonaws.gamelift#CreateBuild" }, + { + "target": "com.amazonaws.gamelift#CreateContainerGroupDefinition" + }, { "target": "com.amazonaws.gamelift#CreateFleet" }, @@ -7246,6 +8391,9 @@ { "target": "com.amazonaws.gamelift#DeleteBuild" }, + { + "target": "com.amazonaws.gamelift#DeleteContainerGroupDefinition" + }, { "target": "com.amazonaws.gamelift#DeleteFleet" }, @@ -7294,6 +8442,9 @@ { "target": "com.amazonaws.gamelift#DescribeCompute" }, + { + "target": "com.amazonaws.gamelift#DescribeContainerGroupDefinition" + }, { "target": "com.amazonaws.gamelift#DescribeEC2InstanceLimits" }, @@ -7393,6 +8544,9 @@ { "target": "com.amazonaws.gamelift#ListCompute" }, + { + "target": "com.amazonaws.gamelift#ListContainerGroupDefinitions" + }, { "target": "com.amazonaws.gamelift#ListFleets" }, @@ -8422,6 +9576,15 @@ } } }, + "com.amazonaws.gamelift#GameLiftAgentEndpointOutput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.gamelift#GameLiftServiceSdkEndpointOutput": { "type": "string", "traits": { @@ -10064,7 +11227,7 @@ } ], "traits": { - "smithy.api#documentation": "Requests authorization to remotely connect to a compute resource in an Amazon GameLift fleet.\n Call this action to connect to an instance in a managed EC2 fleet if the fleet's game\n build uses Amazon GameLift server SDK 5.x or later. To connect to instances with game builds\n that use server SDK 4.x or earlier, call GetInstanceAccess.
\nTo request access to a compute, identify the specific EC2 instance and the fleet it\n belongs to. You can retrieve instances for a managed EC2 fleet by calling ListCompute.
\nIf successful, this operation returns a set of temporary Amazon Web Services credentials, including\n a two-part access key and a session token. Use these credentials with Amazon EC2 Systems Manager (SSM)\n to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide.
\n\n Learn more\n
\n\n Remotely connect to fleet\n instances\n
\n\n Debug fleet\n issues\n
" + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRequests authorization to remotely connect to a hosting resource in a Amazon GameLift managed\n fleet. This operation is not used with Amazon GameLift Anywhere fleets
\nTo request access, specify the compute name and the fleet ID. If successful, this\n operation returns a set of temporary Amazon Web Services credentials, including a two-part access key\n and a session token.
\n\n EC2 fleets\n
\nWith an EC2 fleet (where compute type is EC2), use these credentials with\n Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User\n Guide.
\n Container fleets\n
\nWith a container fleet (where compute type is CONTAINER), use\n these credentials and the target value with SSM to connect to the fleet instance where\n the container is running. After you're connected to the instance, use Docker commands to\n interact with the container.
\n Learn more\n
\n\n Debug fleet\n issues\n
\nA unique identifier for the fleet that contains the compute resource you want to connect to. You can use either\n the fleet ID or ARN value.
", + "smithy.api#documentation": "A unique identifier for the fleet that holds the compute resource that you want to connect to. You can use either the\n fleet ID or ARN value.
", "smithy.api#required": {} } }, @@ -10082,7 +11245,7 @@ "target": "com.amazonaws.gamelift#ComputeNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique identifier for the compute resource that you want to connect to. You can use\n either a registered compute name or an instance ID.
", + "smithy.api#documentation": "A unique identifier for the compute resource that you want to connect to. For an EC2\n fleet compute, use the instance ID. For a container fleet, use the compute name (for\n example,\n a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)\n or the compute ARN.
The ID of the fleet that contains the compute resource to be accessed.
" + "smithy.api#documentation": "The ID of the fleet that holds the compute resource to be accessed.
" } }, "FleetArn": { @@ -10123,6 +11286,12 @@ "traits": { "smithy.api#documentation": "A set of temporary Amazon Web Services credentials for use when connecting to the\n compute resource with Amazon EC2 Systems Manager (SSM).
" } + }, + "Target": { + "target": "com.amazonaws.gamelift#SessionTarget", + "traits": { + "smithy.api#documentation": "(For container fleets only) The instance ID where the compute resource is\n running.
" + } } }, "traits": { @@ -10152,7 +11321,7 @@ } ], "traits": { - "smithy.api#documentation": "Requests an authentication token from Amazon GameLift for a registered compute in an Anywhere\n fleet. The game servers that are running on the compute use this token to authenticate\n with the Amazon GameLift service. Each server process must provide a valid authentication token\n in its call to the Amazon GameLift server SDK action InitSDK().
Authentication tokens are valid for a limited time span. Use a mechanism to regularly\n request a fresh authentication token before the current token expires.
\n\n Learn more\n
\n\n Server SDK\n reference guides (for version 5.x)
\nRequests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift\n Anywhere fleet or container fleet. Game servers that are running on the compute use this\n token to communicate with the Amazon GameLift service, such as when calling the Amazon GameLift server\n SDK action InitSDK(). Authentication tokens are valid for a limited time\n span, so you need to request a fresh token before the current token expires.
Use this operation based on the fleet compute type:
\nFor EC2 fleets, auth token retrieval and refresh is handled\n automatically. All game servers that are running on all fleet instances have\n access to a valid auth token.
For ANYWHERE and CONTAINER fleets, if you're using\n the Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for\n any container or Anywhere compute where the Agent is running. If you're not\n using the Agent, create a mechanism to retrieve and refresh auth tokens for\n computes that are running game server processes.
\n Learn more\n
\n\n Server SDK\n reference guides (for version 5.x)
\nThe name of the compute resource you are requesting the authentication token\n for.
", + "smithy.api#documentation": "The name of the compute resource you are requesting the authentication token for. For\n an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance,\n use the instance ID. For a container fleet, use the compute name (for example,\n a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9)\n or the compute ARN.
Information and credentials that you can use to remotely connect to an instance in an\n EC2 managed fleet. This data type is returned in response to a call to GetInstanceAccess.
" + "smithy.api#documentation": "Information and credentials that you can use to remotely connect to an instance in an\n EC2 managed fleet. This data type is returned in response to a call to \n GetInstanceAccess.
" } }, "com.amazonaws.gamelift#InstanceCredentials": { @@ -10498,7 +11677,7 @@ } }, "traits": { - "smithy.api#documentation": "A set of credentials that allow remote access to an instance in an EC2 managed fleet.\n These credentials are returned in response to a call to GetInstanceAccess, which requests access for instances that are running\n game servers with the Amazon GameLift server SDK version 4.x or earlier.
", + "smithy.api#documentation": "A set of credentials that allow remote access to an instance in an EC2 managed fleet.\n These credentials are returned in response to a call to \n GetInstanceAccess, which requests access for instances that are running\n game servers with the Amazon GameLift server SDK version 4.x or earlier.
", "smithy.api#sensitive": {} } }, @@ -10681,7 +11860,7 @@ } }, "traits": { - "smithy.api#documentation": "A range of IP addresses and port settings that allow inbound traffic to connect to\n server processes on an instance in a fleet. New game sessions are assigned an IP\n address/port number combination, which must fall into the fleet's allowed ranges. Fleets\n with custom game builds must have permissions explicitly set. For Realtime Servers fleets, Amazon GameLift\n automatically opens two port ranges, one for TCP messaging and one for UDP.
" + "smithy.api#documentation": "A range of IP addresses and port settings that allow inbound traffic to connect to\n processes on an instance in a fleet. Processes are assigned an IP address/port number\n combination, which must fall into the fleet's allowed ranges. For container fleets, the\n port settings must use the same port numbers as the fleet's connection ports.
\nFor Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging\n and one for UDP.
" } }, "com.amazonaws.gamelift#IpPermissionsList": { @@ -11002,7 +12181,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the compute resources in an Amazon GameLift fleet. You can request information for\n either managed EC2 fleets or Anywhere fleets.
\nTo request a list of computes, specify the fleet ID. You can filter the result set by\n location. Use the pagination parameters to retrieve results in a set of sequential\n pages.
\nIf successful, this operation returns the compute resource for the requested fleet.\n For managed EC2 fleets, it returns a list of EC2 instances. For Anywhere fleets, it\n returns a list of registered compute names.
", + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves information on the compute resources in an Amazon GameLift fleet.
\nTo request a list of computes, specify the fleet ID. Use the pagination parameters to\n retrieve results in a set of sequential pages.
\nYou can filter the result set by location.
\nIf successful, this operation returns information on all computes in the requested\n fleet. Depending on the fleet's compute type, the result includes the following\n information:
\nFor EC2 fleets, this operation returns information about the EC2\n instance. Compute names are instance IDs.
For ANYWHERE fleets, this operation returns the compute names and\n details provided when the compute was registered with\n RegisterCompute. The GameLiftServiceSdkEndpoint or\n GameLiftAgentEndpoint is included.
For CONTAINER fleets, this operation returns information about\n containers that are registered as computes, and the instances they're running\n on. Compute names are container names.
The name of a location to retrieve compute resources for.
" + "smithy.api#documentation": "The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere\n fleet, use a custom location. For a multi-location EC2 or container fleet, provide a\n Amazon Web Services Region or Local Zone code (for example: us-west-2 or\n us-west-2-lax-1).
\n This operation is used with the Amazon GameLift containers feature, which is currently in public preview. \n
\nRetrieves all container group definitions for the Amazon Web Services account and Amazon Web Services Region that are currently in use. You can filter the result set by the container\n groups' scheduling strategy. Use the pagination parameters to retrieve results in a set of\n sequential pages.
\nThis operation returns the list of container group definitions in no particular order.
\n\n Learn more\n
\nThe type of container group definitions to retrieve.
\n\n DAEMON -- Daemon container groups run background processes and are deployed once\n per fleet instance.
\n REPLICA -- Replica container groups run your game server application and\n supporting software. Replica groups might be deployed multiple times per fleet\n instance.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.gamelift#ListContainerGroupDefinitionsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.gamelift#ListContainerGroupDefinitionsOutput": { + "type": "structure", + "members": { + "ContainerGroupDefinitions": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionList", + "traits": { + "smithy.api#documentation": "A result set of container group definitions that match the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.gamelift#NonEmptyString", + "traits": { + "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.gamelift#ListFleets": { "type": "operation", "input": { @@ -11088,7 +12354,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this\n operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor\n specify a Region in your request. You can filter the result set to find only those\n fleets that are deployed with a specific build or script. For fleets that have multiple\n locations, this operation retrieves fleets based on their home Region only.
\nThis operation can be used in the following ways:
\nTo get a list of all fleets in a Region, don't provide a build or script\n identifier.
\nTo get a list of all fleets where a specific custom game build is deployed,\n provide the build ID.
\nTo get a list of all Realtime Servers fleets with a specific configuration script,\n provide the script ID.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a list of fleet IDs that match the request parameters is returned. A\n NextToken value is also returned if there are more result pages to retrieve.
\nFleet resources are not listed in a particular order.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
", + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRetrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the\n result set to find only those fleets that are deployed with a specific build or script.\n For fleets that have multiple locations, this operation retrieves fleets based on their\n home Region only.
\nYou can use operation in the following ways:
\nTo get a list of all fleets in a Region, don't provide a build or script\n identifier.
\nTo get a list of all fleets where a specific game build is deployed, provide\n the build ID.
\nTo get a list of all Realtime Servers fleets with a specific configuration script,\n provide the script ID.
\n To get a list of all fleets with a specific container group definition, provide\n the ContainerGroupDefinition ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, this operation returns a list of fleet IDs that match the request\n parameters. A NextToken value is also returned if there are more result pages to\n retrieve.
\nFleet IDs are returned in no particular order.
\nA unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a\n specified script. Use either the script ID or ARN value.
" } }, + "ContainerGroupDefinitionName": { + "target": "com.amazonaws.gamelift#ContainerGroupDefinitionNameOrArn", + "traits": { + "smithy.api#documentation": "The container group definition name to request fleets for. Use this parameter to\n return only fleets that are deployed with the specified container group\n definition.
" + } + }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { @@ -11565,7 +12837,7 @@ } }, "traits": { - "smithy.api#documentation": "A remote location where a multi-location fleet can deploy game servers for game\n hosting.
" + "smithy.api#documentation": "\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nA remote location where a multi-location fleet can deploy game servers for game\n hosting.
" } }, "com.amazonaws.gamelift#LocationConfigurationList": { @@ -11638,7 +12910,7 @@ } }, "traits": { - "smithy.api#documentation": "Properties of a location
" + "smithy.api#documentation": "Properties of a custom location for use in an Amazon GameLift Anywhere fleet. This data type is returned in response to a call to https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html.
" } }, "com.amazonaws.gamelift#LocationModelList": { @@ -12247,6 +13519,25 @@ "smithy.api#pattern": "^\\d{1,5}(?:\\.\\d{1,5})?$" } }, + "com.amazonaws.gamelift#NonZeroAnd128MaxAsciiString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.gamelift#NonZeroAnd255MaxString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.gamelift#NonZeroAndMaxString": { "type": "string", "traits": { @@ -12268,6 +13559,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.gamelift#NotReadyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.gamelift#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "The operation failed because Amazon GameLift has not yet finished validating this compute. We\n recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential\n backoffs and jitter.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.gamelift#OperatingSystem": { "type": "enum", "members": { @@ -12940,12 +14243,15 @@ { "target": "com.amazonaws.gamelift#LimitExceededException" }, + { + "target": "com.amazonaws.gamelift#NotReadyException" + }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { - "smithy.api#documentation": "Registers a compute resource to an Amazon GameLift Anywhere fleet. With Anywhere fleets you can\n incorporate your own computing hardware into an Amazon GameLift game hosting solution.
\nTo register a compute to a fleet, give the compute a name (must be unique within the\n fleet) and specify the compute resource's DNS name or IP address. Provide the Anywhere\n fleet ID and a fleet location to associate with the compute being registered. You can\n optionally include the path to a TLS certificate on the compute resource.
\nIf successful, this operation returns the compute details, including an Amazon GameLift SDK\n endpoint. Game server processes that run on the compute use this endpoint to communicate\n with the Amazon GameLift service. Each server process includes the SDK endpoint in its call to\n the Amazon GameLift server SDK action InitSDK().
\n Learn more\n
\n\n Server SDK\n reference guides (for version 5.x)
\n\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nRegisters a compute resource in an Amazon GameLift fleet. Register computes with an Amazon GameLift\n Anywhere fleet or a container fleet.
\nFor an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent\n handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the\n Agent, call this operation to register fleet computes.
\nTo register a compute, give the compute a name (must be unique within the\n fleet) and specify the compute resource's DNS name or IP address. Provide a \n fleet ID and a fleet location to associate with the compute being registered. You can\n optionally include the path to a TLS certificate on the compute resource.
\nIf successful, this operation returns compute details, including an Amazon GameLift SDK\n endpoint or Agent endpoint. Game server processes running on the compute can use this\n endpoint to communicate with the Amazon GameLift service. Each server process includes the SDK\n endpoint in its call to the Amazon GameLift server SDK action InitSDK().
To view compute details, call DescribeCompute with the compute name.
\n\n Learn more\n
\n\n Server SDK\n reference guides (for version 5.x)
\nThe number of container groups that are starting up but have not yet registered.
" + } + }, + "ACTIVE": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "\n The number of container groups that have active game sessions.\n
" + } + }, + "IDLE": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "\n The number of container groups that have no active game sessions.\n
" + } + }, + "TERMINATING": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "The number of container groups that are in the process of shutting down.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This data type is used with the Amazon GameLift containers feature, which is currently in public preview.\n
\nThe number and status of replica container groups that are deployed across a fleet with\n compute type CONTAINER. This information, combined with the number of server\n processes being hosted per container group (see RuntimeConfiguration), tells you\n how many game sessions the fleet is currently capable of hosting concurrently.
\n Returned by:\n DescribeFleetCapacity, DescribeFleetLocationCapacity\n
" + } + }, + "com.amazonaws.gamelift#ReplicaContainerGroupsPerInstance": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5000 + } + } + }, "com.amazonaws.gamelift#RequestUploadCredentials": { "type": "operation", "input": { @@ -13120,7 +14467,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a fresh set of credentials for use when uploading a new set of game build\n files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see\n GameSession.
\nTo request new credentials, specify the build ID as returned with an initial\n CreateBuild request. If successful, a new set of credentials are\n returned, along with the S3 storage location associated with the build ID.
\n Learn more\n
\n\n Create a Build with Files in S3\n
\n\n All APIs by task\n
" + "smithy.api#documentation": "Retrieves a fresh set of credentials for use when uploading a new set of game build\n files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see\n CreateBuild.
\nTo request new credentials, specify the build ID as returned with an initial\n CreateBuild request. If successful, a new set of credentials are\n returned, along with the S3 storage location associated with the build ID.
\n Learn more\n
\n\n Create a Build with Files in S3\n
\n\n All APIs by task\n
" } }, "com.amazonaws.gamelift#RequestUploadCredentialsInput": { @@ -13185,7 +14532,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the fleet ID that an alias is currently pointing to.
\n\n Related actions\n
\n\n All APIs by task\n
" + "smithy.api#documentation": "Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique\n alias identifier.
\nIf the alias has a SIMPLE routing strategy, Amazon GameLift returns a fleet ID.\n If the alias has a TERMINAL routing strategy, the result is a\n TerminalRoutingStrategyException.
\n Related actions\n
\n\n All APIs by task\n
" } }, "com.amazonaws.gamelift#ResolveAliasInput": { @@ -13375,13 +14722,13 @@ "ServerProcesses": { "target": "com.amazonaws.gamelift#ServerProcessList", "traits": { - "smithy.api#documentation": "A collection of server process configurations that identify what server processes to\n run on each instance in a fleet.
" + "smithy.api#documentation": "A collection of server process configurations that identify what server processes to\n run on fleet computes.
" } }, "MaxConcurrentGameSessionActivations": { "target": "com.amazonaws.gamelift#MaxConcurrentGameSessionActivations", "traits": { - "smithy.api#documentation": "The number of game sessions in status ACTIVATING to allow on an instance.\n This setting limits the instance resources that can be used for new game activations at\n any one time.
The number of game sessions in status ACTIVATING to allow on an instance or container.\n This setting limits the instance resources that can be used for new game activations at\n any one time.
A collection of server process configurations that describe the set of processes to\n run on each instance in a fleet. Server processes run either an executable in a custom\n game build or a Realtime Servers script. Amazon GameLift launches the configured processes, manages their\n life cycle, and replaces them as needed. Each instance checks regularly for an updated\n runtime configuration.
\nA Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the\n total number of processes in a runtime configuration, add the values of the\n ConcurrentExecutions parameter for each server process. Learn more\n about Running Multiple\n Processes on a Fleet.
\n This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nA set of instructions that define the set of server processes to run on computes in a\n fleet. Server processes run either an executable in a custom game build or a Realtime Servers\n script. Amazon GameLift launches the processes, manages their life cycle, and replaces them as\n needed. Computes check regularly for an updated runtime configuration.
\nOn a container fleet, the Amazon GameLift Agent uses the runtime configuration to manage the\n lifecycle of server processes in a replica container group.
\nAn Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the\n total number of processes defined in a runtime configuration, add the values of the\n ConcurrentExecutions parameter for each server process. Learn more\n about Running Multiple\n Processes on a Fleet.
Retrieves all active game sessions that match a set of search criteria and sorts them\n into a specified order.
\nThis operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or game session placement queue.
\nWhen searching for game sessions, you specify exactly where you want to search and\n provide a search filter expression, a sort expression, or both. A search request can\n search only one fleet, but it can search all of a fleet's locations.
\nThis operation can be used in the following ways:
\nTo search all game sessions that are currently running on all locations in a\n fleet, provide a fleet or alias ID. This approach returns game sessions in the\n fleet's home Region and all remote locations that fit the search\n criteria.
\nTo search all game sessions that are currently running on a specific fleet\n location, provide a fleet or alias ID and a location name. For location, you can\n specify a fleet's home Region or any remote location.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a GameSession object is returned for each game session\n that matches the request. Search finds game sessions that are in ACTIVE\n status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .
To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.
\n\n gameSessionId -- A unique identifier for the game session. You can use either a\n GameSessionId or GameSessionArn value.
\n gameSessionName -- Name assigned to a game\n session. Game session names do not need to be unique to a game session.
\n\n gameSessionProperties -- A set of key-value pairs that can store custom data in a game session.\n For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}.\n The filter expression must specify the GameProperty -- a Key and a string Value to search for the game sessions.
For example, to search for the above key-value pair, specify the following search filter: gameSessionProperties.difficulty = \"novice\".\n All game property values are searched as strings.
\n For examples of searching game sessions, see the ones below, and also see Search game sessions by game property.\n
\n\n maximumSessions -- Maximum number of player\n sessions allowed for a game session.
\n\n creationTimeMillis -- Value indicating when a\n game session was created. It is expressed in Unix time as milliseconds.
\n\n playerSessionCount -- Number of players\n currently connected to a game session. This value changes rapidly as players\n join the session or drop out.
\n\n hasAvailablePlayerSessions -- Boolean value\n indicating whether a game session has reached its maximum number of players. It\n is highly recommended that all search requests include this filter attribute to\n optimize search performance and return only sessions that players can join.\n
\nReturned values for playerSessionCount and\n hasAvailablePlayerSessions change quickly as players join sessions\n and others drop out. Results should be considered a snapshot in time. Be sure to\n refresh search results often, and handle sessions that fill up before a player can\n join.
\n All APIs by task\n
", + "smithy.api#documentation": "Retrieves all active game sessions that match a set of search criteria and sorts them\n into a specified order.
\nThis operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or a game session placement queue.
\nWhen searching for game sessions, you specify exactly where you want to search and\n provide a search filter expression, a sort expression, or both. A search request can\n search only one fleet, but it can search all of a fleet's locations.
\nThis operation can be used in the following ways:
\nTo search all game sessions that are currently running on all locations in a\n fleet, provide a fleet or alias ID. This approach returns game sessions in the\n fleet's home Region and all remote locations that fit the search\n criteria.
\nTo search all game sessions that are currently running on a specific fleet\n location, provide a fleet or alias ID and a location name. For location, you can\n specify a fleet's home Region or any remote location.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a GameSession object is returned for each game session\n that matches the request. Search finds game sessions that are in ACTIVE\n status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .
To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.
\n\n gameSessionId -- A unique identifier for the game session. You can use either a\n GameSessionId or GameSessionArn value.
\n gameSessionName -- Name assigned to a game\n session. Game session names do not need to be unique to a game session.
\n\n gameSessionProperties -- A set of key-value pairs that can store custom data in a game session.\n For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}.\n The filter expression must specify the GameProperty -- a Key and a string Value to search for the game sessions.
For example, to search for the above key-value pair, specify the following search filter: gameSessionProperties.difficulty = \"novice\".\n All game property values are searched as strings.
\n For examples of searching game sessions, see the ones below, and also see Search game sessions by game property.\n
\n\n maximumSessions -- Maximum number of player\n sessions allowed for a game session.
\n\n creationTimeMillis -- Value indicating when a\n game session was created. It is expressed in Unix time as milliseconds.
\n\n playerSessionCount -- Number of players\n currently connected to a game session. This value changes rapidly as players\n join the session or drop out.
\n\n hasAvailablePlayerSessions -- Boolean value\n indicating whether a game session has reached its maximum number of players. It\n is highly recommended that all search requests include this filter attribute to\n optimize search performance and return only sessions that players can join.\n
\nReturned values for playerSessionCount and\n hasAvailablePlayerSessions change quickly as players join sessions\n and others drop out. Results should be considered a snapshot in time. Be sure to\n refresh search results often, and handle sessions that fill up before a player can\n join.
\n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -13798,13 +15145,13 @@ "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of server processes using this configuration that run concurrently on each\n instance.
", + "smithy.api#documentation": "The number of server processes using this configuration that run concurrently on each\n instance or container..
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A set of instructions for launching server processes on each instance in a fleet.\n Server processes run either an executable in a custom game build or a Realtime Servers script.\n Server process configurations are part of a fleet's runtime configuration.
" + "smithy.api#documentation": "A set of instructions for launching server processes on fleet computes. Server\n processes run either an executable in a custom game build or a Realtime Servers script. Server\n process configurations are part of a fleet's runtime configuration.
" } }, "com.amazonaws.gamelift#ServerProcessList": { @@ -13830,6 +15177,21 @@ "smithy.api#pattern": "^\\d+\\.\\d+\\.\\d+$" } }, + "com.amazonaws.gamelift#SessionTarget": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 400 + } + } + }, + "com.amazonaws.gamelift#Sha256": { + "type": "string", + "traits": { + "smithy.api#pattern": "^sha256:[a-fA-F0-9]{64}$" + } + }, "com.amazonaws.gamelift#SnsArnStringModel": { "type": "string", "traits": { @@ -14210,7 +15572,7 @@ } ], "traits": { - "smithy.api#documentation": "Suspends certain types of activity in a fleet location. Currently, this operation is\n used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed\n separately for each location.
\nStopping fleet actions has several potential purposes. It allows you to temporarily\n stop auto-scaling activity but retain your scaling policies for use in the future. For\n multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it\n for certain locations.
\nThis operation can be used in the following ways:
\nTo stop actions on instances in the fleet's home Region, provide a fleet ID\n and the type of actions to suspend.
\nTo stop actions on instances in one of the fleet's remote locations, provide a\n fleet ID, a location name, and the type of actions to suspend.
\nIf successful, Amazon GameLift no longer initiates scaling events except in response to manual\n changes using UpdateFleetCapacity.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n Fleets\n
" + "smithy.api#documentation": "Suspends certain types of activity in a fleet location. Currently, this operation is\n used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed\n separately for each location.
\nStopping fleet actions has several potential purposes. It allows you to temporarily\n stop auto-scaling activity but retain your scaling policies for use in the future. For\n multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it\n for certain locations.
\nThis operation can be used in the following ways:
\nTo stop actions on instances in the fleet's home Region, provide a fleet ID\n and the type of actions to suspend.
\nTo stop actions on instances in one of the fleet's remote locations, provide a\n fleet ID, a location name, and the type of actions to suspend.
\nIf successful, Amazon GameLift no longer initiates scaling events except in response to manual\n changes using UpdateFleetCapacity. To restart fleet actions again, call \n StartFleetActions.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n Fleets\n
" } }, "com.amazonaws.gamelift#StopFleetActionsInput": { @@ -14727,7 +16089,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates properties for an alias. To update properties, specify the alias ID to be\n updated and provide the information to be changed. To reassign an alias to another\n fleet, provide an updated routing strategy. If successful, the updated alias record is\n returned.
\n\n Related actions\n
\n\n All APIs by task\n
" + "smithy.api#documentation": "Updates properties for an alias. Specify the unique identifier of the alias to be\n updated and the new property values. When reassigning an alias to a new fleet, provide\n an updated routing strategy. If successful, the updated alias record is returned.
\n\n Related actions\n
\n\n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateAliasInput": { @@ -14878,7 +16240,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a fleet's mutable attributes, including game session protection and resource\n creation limits.
\nTo update fleet attributes, specify the fleet ID and the property values that you want\n to change.
\nIf successful, an updated FleetAttributes object is returned.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" + "smithy.api#documentation": "Updates a fleet's mutable attributes, such as game session protection and resource\n creation limits.
\nTo update fleet attributes, specify the fleet ID and the property values that you want\n to change. If successful, Amazon GameLift returns the identifiers for the updated fleet.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" } }, "com.amazonaws.gamelift#UpdateFleetAttributesInput": { @@ -14988,7 +16350,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates capacity settings for a fleet. For fleets with multiple locations, use this\n operation to manage capacity settings in each location individually. Fleet capacity\n determines the number of game sessions and players that can be hosted based on the fleet\n configuration. Use this operation to set the following fleet capacity properties:
\nMinimum/maximum size: Set hard limits on fleet capacity. Amazon GameLift cannot set\n the fleet's capacity to a value outside of this range, whether the capacity is\n changed manually or through automatic scaling.
\nDesired capacity: Manually set the number of Amazon EC2 instances to be maintained\n in a fleet location. Before changing a fleet's desired capacity, you may want to\n call DescribeEC2InstanceLimits to get the maximum capacity of the\n fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to\n adjust capacity based on player demand.
\nThis operation can be used in the following ways:
\nTo update capacity for a fleet's home Region, or if the fleet has no remote\n locations, omit the Location parameter. The fleet must be in\n ACTIVE status.
To update capacity for a fleet's remote location, include the\n Location parameter set to the location to be updated. The\n location must be in ACTIVE status.
If successful, capacity settings are updated immediately. In response a change in\n desired capacity, Amazon GameLift initiates steps to start new instances or terminate existing\n instances in the requested fleet location. This continues until the location's active\n instance count matches the new desired instance count. You can track a fleet's current\n capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is\n higher than the instance type's limit, the LimitExceeded exception\n occurs.
\n Learn more\n
\n " + "smithy.api#documentation": "\n This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.\n
\nUpdates capacity settings for a managed EC2 fleet or container fleet. For these\n fleets, you adjust capacity by changing the number of instances in the fleet. Fleet\n capacity determines the number of game sessions and players that the fleet can host\n based on its configuration. For fleets with multiple locations, use this operation to\n manage capacity settings in each location individually.
\nUse this operation to set these fleet capacity properties:
\nMinimum/maximum size: Set hard limits on the number of Amazon EC2 instances allowed. If Amazon GameLift receives a \n request--either through manual update or automatic scaling--it won't change the capacity \n to a value outside of this range.
\nDesired capacity: As an alternative to automatic scaling, manually set the number of Amazon EC2 \n instances to be maintained. \n Before changing a fleet's desired capacity, check the maximum capacity of the\n fleet's Amazon EC2 instance type by calling DescribeEC2InstanceLimits.
\nTo update capacity for a fleet's home Region, or if the fleet has no remote\n locations, omit the Location parameter. The fleet must be in\n ACTIVE status.
To update capacity for a fleet's remote location, set the\n Location parameter to the location to update. The location must be in\n ACTIVE status.
If successful, Amazon GameLift updates the capacity settings and returns the identifiers for\n the updated fleet and/or location. If a requested change to desired capacity exceeds the\n instance type's limit, the LimitExceeded exception occurs.
Updates often prompt an immediate change in fleet capacity, such as when current\n capacity is different than the new desired capacity or outside the new limits. In this\n scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet\n location. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity.
\n\n Learn more\n
\n " } }, "com.amazonaws.gamelift#UpdateFleetCapacityInput": { @@ -15089,7 +16451,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates permissions that allow inbound traffic to connect to game sessions that are\n being hosted on instances in the fleet.
\nTo update settings, specify the fleet ID to be updated and specify the changes to be\n made. List the permissions you want to add in\n InboundPermissionAuthorizations, and permissions you want to remove in\n InboundPermissionRevocations. Permissions to be removed must match\n existing fleet permissions.
If successful, the fleet ID for the updated fleet is returned. For fleets with remote\n locations, port setting updates can take time to propagate across all locations. You can\n check the status of updates in each location by calling\n DescribeFleetPortSettings with a location name.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" + "smithy.api#documentation": "Updates permissions that allow inbound traffic to connect to game sessions in the\n fleet.
\nTo update settings, specify the fleet ID to be updated and specify the changes to be\n made. List the permissions you want to add in\n InboundPermissionAuthorizations, and permissions you want to remove in\n InboundPermissionRevocations. Permissions to be removed must match\n existing fleet permissions.
For a container fleet, inbound permissions must specify port numbers that are defined\n in the fleet's connection port settings.
\nIf successful, the fleet ID for the updated fleet is returned. For fleets with remote\n locations, port setting updates can take time to propagate across all locations. You can\n check the status of updates in each location by calling\n DescribeFleetPortSettings with a location name.
\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" } }, "com.amazonaws.gamelift#UpdateFleetPortSettingsInput": { @@ -15644,6 +17006,9 @@ { "target": "com.amazonaws.gamelift#InvalidRequestException" }, + { + "target": "com.amazonaws.gamelift#LimitExceededException" + }, { "target": "com.amazonaws.gamelift#NotFoundException" }, @@ -15652,7 +17017,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the current runtime configuration for the specified fleet, which tells Amazon GameLift\n how to launch server processes on all instances in the fleet. You can update a fleet's\n runtime configuration at any time after the fleet is created; it does not need to be in\n ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a\n RuntimeConfiguration with an updated set of server process\n configurations.
If successful, the fleet's runtime configuration settings are updated. Each instance\n in the fleet regularly checks for and retrieves updated runtime configurations.\n Instances immediately begin complying with the new configuration by launching new server\n processes or not replacing existing processes when they shut down. Updating a fleet's\n runtime configuration never affects existing server processes.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" + "smithy.api#documentation": "Updates the runtime configuration for the specified fleet. The runtime configuration\n tells Amazon GameLift how to launch server processes on computes in the fleet. For managed EC2\n fleets, it determines what server processes to run on each fleet instance. For container\n fleets, it describes what server processes to run in each replica container group. You\n can update a fleet's runtime configuration at any time after the fleet is created; it\n does not need to be in ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a\n RuntimeConfiguration with an updated set of server process\n configurations.
If successful, the fleet's runtime configuration settings are updated. Fleet computes\n that run game server processes regularly check for and receive updated runtime\n configurations. The computes immediately take action to comply with the new\n configuration by launching new server processes or by not replacing existing processes\n when they shut down. Updating a fleet's runtime configuration never affects existing\n server processes.
\n\n Learn more\n
\n\n Setting up Amazon GameLift\n fleets\n
" } }, "com.amazonaws.gamelift#UpdateRuntimeConfigurationInput": { @@ -15670,7 +17035,7 @@ "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Instructions for launching server processes on each instance in the fleet. Server\n processes run either a custom game build executable or a Realtime Servers script. The runtime\n configuration lists the types of server processes to run on an instance, how to launch\n them, and the number of processes to run concurrently.
", + "smithy.api#documentation": "Instructions for launching server processes on fleet computes. Server processes run\n either a custom game build executable or a Realtime Servers script. The runtime configuration lists\n the types of server processes to run, how to launch them, and the number of processes to\n run concurrently.
", "smithy.api#required": {} } } @@ -15685,7 +17050,7 @@ "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "The runtime configuration currently in use by all instances in the fleet. If the\n update was successful, all property changes are shown.
" + "smithy.api#documentation": "The runtime configuration currently in use by computes in the fleet. If the update is\n successful, all property changes are shown.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/greengrassv2.2020-11-30.json b/codegen/sdk-codegen/aws-models/greengrassv2.2020-11-30.json index 80822331e3c..5559fece8ac 100644 --- a/codegen/sdk-codegen/aws-models/greengrassv2.2020-11-30.json +++ b/codegen/sdk-codegen/aws-models/greengrassv2.2020-11-30.json @@ -2724,7 +2724,7 @@ "sdkId": "GreengrassV2", "arnNamespace": "greengrass", "cloudFormationName": "GreengrassV2", - "cloudTrailEventSource": "greengrassv2.amazonaws.com", + "cloudTrailEventSource": "greengrass.amazonaws.com", "endpointPrefix": "greengrass" }, "aws.auth#sigv4": { diff --git a/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json b/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json index 9ae0a85b886..3efe5ed0c90 100644 --- a/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json +++ b/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json @@ -1869,6 +1869,23 @@ "smithy.api#pattern": "^\\d{12}|o-[a-z0-9]{10,32}$" } }, + "com.amazonaws.inspector2#CisReportFormat": { + "type": "enum", + "members": { + "PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PDF" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + } + }, "com.amazonaws.inspector2#CisReportStatus": { "type": "enum", "members": { @@ -3530,6 +3547,12 @@ "smithy.api#documentation": "Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range.
" } }, + "scanMode": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED and EC2_HYBRID.
The date and time the resource was last checked for vulnerabilities.
" } + }, + "scanMode": { + "target": "com.amazonaws.inspector2#ScanMode", + "traits": { + "smithy.api#documentation": "The scan method that is applied to the instance.
" + } } }, "traits": { @@ -4952,6 +4981,35 @@ } } }, + "com.amazonaws.inspector2#Ec2Configuration": { + "type": "structure", + "members": { + "scanMode": { + "target": "com.amazonaws.inspector2#Ec2ScanMode", + "traits": { + "smithy.api#documentation": "The scan method that is applied to the instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Enables agent-based scanning, which scans instances that are not managed by SSM.
" + } + }, + "com.amazonaws.inspector2#Ec2ConfigurationState": { + "type": "structure", + "members": { + "scanModeState": { + "target": "com.amazonaws.inspector2#Ec2ScanModeState", + "traits": { + "smithy.api#documentation": "An object that contains details about the state of the Amazon EC2 scan mode.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the state of the EC2 scan configuration for your environment.
" + } + }, "com.amazonaws.inspector2#Ec2DeepInspectionStatus": { "type": "string", "traits": { @@ -5142,6 +5200,56 @@ ] } }, + "com.amazonaws.inspector2#Ec2ScanMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2_SSM_AGENT_BASED", + "name": "EC2_SSM_AGENT_BASED" + }, + { + "value": "EC2_HYBRID", + "name": "EC2_HYBRID" + } + ] + } + }, + "com.amazonaws.inspector2#Ec2ScanModeState": { + "type": "structure", + "members": { + "scanMode": { + "target": "com.amazonaws.inspector2#Ec2ScanMode", + "traits": { + "smithy.api#documentation": "The scan method that is applied to the instance.
" + } + }, + "scanModeStatus": { + "target": "com.amazonaws.inspector2#Ec2ScanModeStatus", + "traits": { + "smithy.api#documentation": "The status of the Amazon EC2 scan mode setting.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The state of your Amazon EC2 scan mode configuration.
" + } + }, + "com.amazonaws.inspector2#Ec2ScanModeStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "PENDING", + "name": "PENDING" + } + ] + } + }, "com.amazonaws.inspector2#EcrConfiguration": { "type": "structure", "members": { @@ -6308,7 +6416,7 @@ "lastObservedAt": { "target": "com.amazonaws.inspector2#DateTimeTimestamp", "traits": { - "smithy.api#documentation": "The date and time that the finding was last observed.
", + "smithy.api#documentation": "\n The date and time the finding was last observed. \n This timestamp for this field remains unchanged until a finding is updated.\n
", "smithy.api#required": {} } }, @@ -6889,6 +6997,9 @@ { "target": "com.amazonaws.inspector2#InternalServerException" }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, { "target": "com.amazonaws.inspector2#ThrottlingException" }, @@ -6902,7 +7013,8 @@ { "title": "Sample GetCisScanReport Call", "input": { - "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38" + "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", + "reportFormat": "PDF" }, "output": { "url": "www.s3.amazon.com/abcdef", @@ -6932,6 +7044,13 @@ "traits": { "smithy.api#documentation": "The target accounts.
" } + }, + "reportFormat": { + "target": "com.amazonaws.inspector2#CisReportFormat", + "traits": { + "smithy.api#default": "PDF", + "smithy.api#documentation": "\n The format of the report. \n Valid values are PDF and CSV. \n If no value is specified, the report format defaults to PDF.\n
\n The URL where the CIS scan report PDF can be downloaded.\n
" + "smithy.api#documentation": "\n The URL where a PDF or CSV of the CIS scan report can be downloaded.\n
" } }, "status": { @@ -7151,6 +7270,12 @@ "traits": { "smithy.api#documentation": "Specifies how the ECR automated re-scan duration is currently configured for your environment.
" } + }, + "ec2Configuration": { + "target": "com.amazonaws.inspector2#Ec2ConfigurationState", + "traits": { + "smithy.api#documentation": "Specifies how the Amazon EC2 automated scan mode is currently configured for your environment.
" + } } } }, @@ -12454,6 +12579,21 @@ ] } }, + "com.amazonaws.inspector2#ScanMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2_SSM_AGENT_BASED", + "name": "EC2_SSM_AGENT_BASED" + }, + { + "value": "EC2_AGENTLESS", + "name": "EC2_AGENTLESS" + } + ] + } + }, "com.amazonaws.inspector2#ScanStatus": { "type": "structure", "members": { @@ -14393,8 +14533,13 @@ "ecrConfiguration": { "target": "com.amazonaws.inspector2#EcrConfiguration", "traits": { - "smithy.api#documentation": "Specifies how the ECR automated re-scan will be updated for your environment.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies how the ECR automated re-scan will be updated for your environment.
" + } + }, + "ec2Configuration": { + "target": "com.amazonaws.inspector2#Ec2Configuration", + "traits": { + "smithy.api#documentation": "Specifies how the Amazon EC2 automated scan will be updated for your environment.
" } } } diff --git a/codegen/sdk-codegen/aws-models/ivs-realtime.2020-07-14.json b/codegen/sdk-codegen/aws-models/ivs-realtime.2020-07-14.json index 48f09f35dce..8f144a2e2c1 100644 --- a/codegen/sdk-codegen/aws-models/ivs-realtime.2020-07-14.json +++ b/codegen/sdk-codegen/aws-models/ivs-realtime.2020-07-14.json @@ -828,7 +828,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$" + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivsrealtime#ChannelDestinationConfiguration": { @@ -3731,7 +3731,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivsrealtime#ResourceNotFoundException": { @@ -4407,6 +4407,9 @@ { "target": "com.amazonaws.ivsrealtime#AccessDeniedException" }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, { "target": "com.amazonaws.ivsrealtime#PendingVerification" }, diff --git a/codegen/sdk-codegen/aws-models/ivs.2020-07-14.json b/codegen/sdk-codegen/aws-models/ivs.2020-07-14.json index 94571f6d477..3f00894941e 100644 --- a/codegen/sdk-codegen/aws-models/ivs.2020-07-14.json +++ b/codegen/sdk-codegen/aws-models/ivs.2020-07-14.json @@ -908,7 +908,7 @@ "arn": { "target": "com.amazonaws.ivs#ResourceArn", "traits": { - "smithy.api#documentation": "Channel ARN.
" + "smithy.api#documentation": "ARN of an IVS resource; e.g., channel.
" } }, "code": { @@ -1262,7 +1262,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$" + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#ChannelArnList": { @@ -3249,7 +3249,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$" + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#PlaybackKeyPairFingerprint": { @@ -3755,7 +3755,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#ResourceNotFoundException": { @@ -4130,7 +4130,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+$" + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#StreamKeyArnList": { diff --git a/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.2018-05-23.json b/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.2018-05-23.json index 5c488f7aa7e..632bb62ab58 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.2018-05-23.json +++ b/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.2018-05-23.json @@ -3684,7 +3684,7 @@ "sdkId": "Kinesis Analytics V2", "arnNamespace": "kinesisanalytics", "cloudFormationName": "KinesisAnalyticsV2", - "cloudTrailEventSource": "kinesisanalyticsv2.amazonaws.com", + "cloudTrailEventSource": "kinesisanalytics.amazonaws.com", "docId": "kinesisanalyticsv2-2018-05-23", "endpointPrefix": "kinesisanalytics" }, diff --git a/codegen/sdk-codegen/aws-models/license-manager.2018-08-01.json b/codegen/sdk-codegen/aws-models/license-manager.2018-08-01.json index fcaa57d69f0..0d5798b6cf2 100644 --- a/codegen/sdk-codegen/aws-models/license-manager.2018-08-01.json +++ b/codegen/sdk-codegen/aws-models/license-manager.2018-08-01.json @@ -189,7 +189,7 @@ "sdkId": "License Manager", "arnNamespace": "license-manager", "cloudFormationName": "LicenseManager", - "cloudTrailEventSource": "licensemanager.amazonaws.com", + "cloudTrailEventSource": "license-manager.amazonaws.com", "endpointPrefix": "license-manager" }, "aws.auth#sigv4": { diff --git a/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json b/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json index 4e908dd8f24..216f9a9406c 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json +++ b/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json @@ -344,6 +344,25 @@ ], "type": "tree" }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "cn-northwest-1" + ] + } + ], + "endpoint": { + "url": "https://entitlement-marketplace.cn-northwest-1.amazonaws.com.cn", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -445,6 +464,19 @@ "UseDualStack": true } }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entitlement-marketplace.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { diff --git a/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json b/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json index 08e24986a11..319afa13746 100644 --- a/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json +++ b/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json @@ -1545,6 +1545,13 @@ "smithy.api#documentation": "Controls how SCTE-35 messages create cues. Splice Insert mode treats all segmentation signals traditionally. With Time Signal APOS mode only Time Signal Placement Opportunity and Break messages create segment breaks. With ESAM mode, signals are forwarded to an ESAM server for possible update.", "smithy.api#jsonName": "availSettings" } + }, + "Scte35SegmentationScope": { + "target": "com.amazonaws.medialive#Scte35SegmentationScope", + "traits": { + "smithy.api#documentation": "Configures whether SCTE 35 passthrough triggers segment breaks in all output groups that use segmented outputs. Insertion of a SCTE 35 message typically results in a segment break, in addition to the regular cadence of breaks. The segment breaks appear in video outputs, audio outputs, and captions outputs (if any).\n\nALL_OUTPUT_GROUPS: Default. Insert the segment break in in all output groups that have segmented outputs. This is the legacy behavior.\nSCTE35_ENABLED_OUTPUT_GROUPS: Insert the segment break only in output groups that have SCTE 35 passthrough enabled. This is the recommended value, because it reduces unnecessary segment breaks.", + "smithy.api#jsonName": "scte35SegmentationScope" + } } }, "traits": { @@ -25567,6 +25574,26 @@ "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_descriptor." } }, + "com.amazonaws.medialive#Scte35SegmentationScope": { + "type": "enum", + "members": { + "ALL_OUTPUT_GROUPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_OUTPUT_GROUPS" + } + }, + "SCTE35_ENABLED_OUTPUT_GROUPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCTE35_ENABLED_OUTPUT_GROUPS" + } + } + }, + "traits": { + "smithy.api#documentation": "Scte35 Segmentation Scope" + } + }, "com.amazonaws.medialive#Scte35SpliceInsert": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/oam.2022-06-10.json b/codegen/sdk-codegen/aws-models/oam.2022-06-10.json index d6ed3a8d78b..eacdd89b6ad 100644 --- a/codegen/sdk-codegen/aws-models/oam.2022-06-10.json +++ b/codegen/sdk-codegen/aws-models/oam.2022-06-10.json @@ -58,7 +58,7 @@ "aws:RequestTag/${TagKey}", "oam:ResourceTypes" ], - "smithy.api#documentation": "Creates a link between a source account and a sink that you have created in a monitoring account.
\nBefore you create a link, you must create a sink in the monitoring account and create a\n sink policy in that account. The sink policy must permit the source account to link to it. You\n can grant permission to source accounts by granting permission to an entire organization or to\n individual accounts.
\nFor more information, see\n CreateSink and\n PutSinkPolicy.
\nEach monitoring account can be linked to as many as 100,000 source accounts.
\nEach source account can be linked to as many as five monitoring accounts.
", + "smithy.api#documentation": "Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, \n data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters\n that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
\nBefore you create a link, you must create a sink in the monitoring account and create a\n sink policy in that account. The sink policy must permit the source account to link to it. You\n can grant permission to source accounts by granting permission to an entire organization or to\n individual accounts.
\nFor more information, see \n CreateSink and\n PutSinkPolicy.
\nEach monitoring account can be linked to as many as 100,000 source accounts.
\nEach source account can be linked to as many as five monitoring accounts.
", "smithy.api#http": { "method": "POST", "uri": "/CreateLink" @@ -71,28 +71,34 @@ "LabelTemplate": { "target": "com.amazonaws.oam#LabelTemplate", "traits": { - "smithy.api#documentation": "Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring\n account.
\nYou can use a custom label or use the following variables:
\n\n $AccountName is the name of the account
\n $AccountEmail is the globally unique email address of the account
\n $AccountEmailNoDomain is the email address of the account without the domain name
Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring\n account.
\nYou can use a custom label or use the following variables:
\n\n $AccountName is the name of the account
\n $AccountEmail is the globally unique email address of the account
\n $AccountEmailNoDomain is the email address of the account without the domain name
An array of strings that define which types of data that the source account shares with the monitoring\n account.
", + "smithy.api#documentation": "An array of strings that define which types of data that the source account shares with the monitoring \n account.
", "smithy.api#required": {} } }, "SinkIdentifier": { "target": "com.amazonaws.oam#ResourceIdentifier", "traits": { - "smithy.api#documentation": "The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.
\nFor more information about sinks, see\n CreateSink.
", + "smithy.api#documentation": "The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.
\nFor more information about sinks, see \n CreateSink.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.oam#TagMapInput", "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see\n Controlling access to Amazon Web Services resources using tags.
" + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
" + } + }, + "LinkConfiguration": { + "target": "com.amazonaws.oam#LinkConfiguration", + "traits": { + "smithy.api#documentation": "Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from \n the source account to the monitoring account.
" } } }, @@ -118,7 +124,7 @@ "Label": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The label that you assigned to this link. If the labelTemplate includes variables,\n this field displays the variables resolved to their actual values.
The label that you assigned to this link. If the labelTemplate includes variables, \n this field displays the variables resolved to their actual values.
The tags assigned to the link.
" } + }, + "LinkConfiguration": { + "target": "com.amazonaws.oam#LinkConfiguration", + "traits": { + "smithy.api#documentation": "This structure includes filters that specify which metric namespaces and which log groups are shared from \n the source account to the monitoring account.
" + } } }, "traits": { @@ -180,7 +192,7 @@ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], - "smithy.api#documentation": "Use this to create a sink in the current account, so that it can be\n used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that\n represents an attachment point in a monitoring account. Source accounts can link to the sink\n to send observability data.
\nAfter you create a sink, you must create a sink policy that allows source accounts to attach to it.\n For more information, see PutSinkPolicy.
\nEach account can contain one sink. If you delete a sink, you can then create a new one in that account.
", + "smithy.api#documentation": "Use this to create a sink in the current account, so that it can be\n used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that\n represents an attachment point in a monitoring account. Source accounts can link to the sink\n to send observability data.
\nAfter you create a sink, you must create a sink policy that allows source accounts to attach to it. \n For more information, see PutSinkPolicy.
\nEach account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.
", "smithy.api#http": { "method": "POST", "uri": "/CreateSink" @@ -200,7 +212,7 @@ "Tags": { "target": "com.amazonaws.oam#TagMapInput", "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see\n Controlling access to Amazon Web Services resources using tags.
" + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
" } } }, @@ -266,7 +278,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "Deletes a link between a monitoring account sink and a source account. You must run this operation\n in the source account.
", + "smithy.api#documentation": "Deletes a link between a monitoring account sink and a source account. You must run this operation\n in the source account.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteLink" @@ -446,6 +458,12 @@ "traits": { "smithy.api#documentation": "The tags assigned to the link.
" } + }, + "LinkConfiguration": { + "target": "com.amazonaws.oam#LinkConfiguration", + "traits": { + "smithy.api#documentation": "This structure includes filters that specify which metric namespaces and which log groups are shared from \n the source account to the monitoring account.
" + } } }, "traits": { @@ -559,7 +577,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "Returns the current sink policy attached to this sink. The sink policy specifies what\n accounts can attach to this sink as source accounts, and what types of data they can share.
", + "smithy.api#documentation": "Returns the current sink policy attached to this sink. The sink policy specifies what \n accounts can attach to this sink as source accounts, and what types of data they can share.
", "smithy.api#http": { "method": "POST", "uri": "/GetSinkPolicy" @@ -657,6 +675,26 @@ } } }, + "com.amazonaws.oam#LinkConfiguration": { + "type": "structure", + "members": { + "LogGroupConfiguration": { + "target": "com.amazonaws.oam#LogGroupConfiguration", + "traits": { + "smithy.api#documentation": "Use this structure to filter which log groups are to send log events from \n the source account to the monitoring account.
" + } + }, + "MetricConfiguration": { + "target": "com.amazonaws.oam#MetricConfiguration", + "traits": { + "smithy.api#documentation": "Use this structure to filter which metric namespaces are to be shared from \n the source account to the monitoring account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from \n the source account to the monitoring account.
" + } + }, "com.amazonaws.oam#ListAttachedLinks": { "type": "operation", "input": { @@ -748,7 +786,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that contains information about one link attached to this monitoring\n account sink.
" + "smithy.api#documentation": "A structure that contains information about one link attached to this monitoring \n account sink.
" } }, "com.amazonaws.oam#ListAttachedLinksItems": { @@ -807,7 +845,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation in a source account to return a list of links to monitoring account sinks that\n this source account has.
\nTo find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
", + "smithy.api#documentation": "Use this operation in a source account to return a list of links to monitoring account sinks that\n this source account has.
\nTo find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
", "smithy.api#http": { "method": "POST", "uri": "/ListLinks" @@ -1066,7 +1104,7 @@ "ResourceArn": { "target": "com.amazonaws.oam#Arn", "traits": { - "smithy.api#documentation": "The ARN of the resource that you want to view tags for.
\nThe ARN format of a sink is\n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is\n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs\n resources and operations.
\nUnlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags\n for links or sinks you must have the oam:RequestTag permission. The\n aws:ReguestTag permission does not allow you to tag and untag links and\n sinks.
The ARN of the resource that you want to view tags for.
\nThe ARN format of a sink is \n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is \n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
\nUnlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags\n for links or sinks you must have the oam:RequestTag permission. The\n aws:ReguestTag permission does not allow you to tag and untag links and\n sinks.
Use this field to specify which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or\n more of the following operands. Use single quotation marks (') around log group names. The matching of log group names is case sensitive.\n Each filter has a limit of five conditional operands. Conditional operands are AND and OR.
\n = and !=\n
\n AND\n
\n OR\n
\n LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end\n of the string that you want to search for and include.
\n IN and NOT IN, using parentheses ( )\n
Examples:
\n\n LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and \n Other-Log-Group.
\n LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and \n Private-Log-Group-2.
\n LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or \n AWSLogs.
If you are updating a link that uses filters, you can specify * as the only value for the \n filter parameter to delete the filter and share all log groups with the monitoring account.
This structure contains the Filter parameter which you can use to specify which log groups are to \n share log events from this source account to the monitoring account.
Use this field to specify which metrics are to be shared with the monitoring account. Use the term Namespace and one or\n more of the following operands. Use single quotation marks (') around namespace names. The matching of namespace names is case sensitive.\n Each filter has a limit of five conditional operands. Conditional operands are AND and OR.
\n = and !=\n
\n AND\n
\n OR\n
\n LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end\n of the string that you want to search for and include.
\n IN and NOT IN, using parentheses ( )\n
Examples:
\n\n Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/, such as custom namespaces.
\n Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing, and Amazon S3 namespaces.
\n Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
If you are updating a link that uses filters, you can specify * as the only value for the \n filter parameter to delete the filter and share all metric namespaces with the monitoring account.
This structure contains the Filter parameter which you can use to specify which metric namespaces are to \n be shared from this source account to the monitoring account.
Creates or updates the resource policy that grants permissions to source\n accounts to link to the monitoring account sink. When you create a sink policy, you can grant\n permissions to all accounts in an organization or to individual accounts.
\nYou can also use a sink policy to limit the types of data that is shared. The three types that\n you can allow or deny are:
\n\n Metrics - Specify with\n AWS::CloudWatch::Metric\n
\n Log groups - Specify with AWS::Logs::LogGroup\n
\n Traces - Specify with AWS::XRay::Trace\n
\n Application Insights - Applications - Specify with AWS::ApplicationInsights::Application\n
See the examples in this section to see how to specify permitted source accounts and data types.
", + "smithy.api#documentation": "Creates or updates the resource policy that grants permissions to source\n accounts to link to the monitoring account sink. When you create a sink policy, you can grant\n permissions to all accounts in an organization or to individual accounts.
\nYou can also use a sink policy to limit the types of data that is shared. The three types that \n you can allow or deny are:
\n\n Metrics - Specify with\n AWS::CloudWatch::Metric\n
\n Log groups - Specify with AWS::Logs::LogGroup\n
\n Traces - Specify with AWS::XRay::Trace\n
\n Application Insights - Applications - Specify with AWS::ApplicationInsights::Application\n
See the examples in this section to see how to specify permitted source accounts and data types.
", "smithy.api#http": { "method": "POST", "uri": "/PutSinkPolicy" @@ -1159,7 +1245,7 @@ "Policy": { "target": "com.amazonaws.oam#SinkPolicy", "traits": { - "smithy.api#documentation": "The JSON policy to use. If you are updating an existing policy, the entire existing policy is\n replaced by what you specify here.
\nThe policy must be in JSON string format with quotation marks escaped and no newlines.
\nFor examples of different types of policies, see the Examples section on this page.
", + "smithy.api#documentation": "The JSON policy to use. If you are updating an existing policy, the entire existing policy is\n replaced by what you specify here.
\nThe policy must be in JSON string format with quotation marks escaped and no newlines.
\nFor examples of different types of policies, see the Examples section on this page.
", "smithy.api#required": {} } } @@ -1368,7 +1454,7 @@ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified resource.\n Both sinks and links can be tagged.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm,\n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.
You can associate as many as 50 tags with a resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:ResourceTag permission does not allow you to tag and untag links and\n sinks.
Assigns one or more tags (key-value pairs) to the specified resource. \n Both sinks and links can be tagged.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.
You can associate as many as 50 tags with a resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:ResourceTag permission does not allow you to tag and untag links and\n sinks.
The ARN of the resource that you're adding tags to.
\nThe ARN format of a sink is\n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is\n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs\n resources and operations.
", + "smithy.api#documentation": "The ARN of the resource that you're adding tags to.
\nThe ARN format of a sink is \n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is \n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1450,7 +1536,7 @@ "aws.iam#conditionKeys": [ "aws:TagKeys" ], - "smithy.api#documentation": "Removes one or more tags from the specified resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:TagResource permission does not allow you to tag and untag links and\n sinks.
Removes one or more tags from the specified resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:TagResource permission does not allow you to tag and untag links and\n sinks.
The ARN of the resource that you're removing tags from.
\nThe ARN format of a sink is\n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is\n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs\n resources and operations.
", + "smithy.api#documentation": "The ARN of the resource that you're removing tags from.
\nThe ARN format of a sink is \n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is \n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1516,7 +1602,7 @@ "aws:ResourceTag/${TagKey}", "oam:ResourceTypes" ], - "smithy.api#documentation": "Use this operation to change what types of data are shared from a source account to its linked\n monitoring account sink. You can't change the sink or change the monitoring account with this operation.
\nTo update the list of tags associated with the sink, use\n TagResource.
", + "smithy.api#documentation": "Use this operation to change what types of data are shared from a source account to its linked\n monitoring account sink. You can't change the sink or change the monitoring account with this operation.
\nWhen you update a link, you can optionally specify filters\n that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
\nTo update the list of tags associated with the sink, use \n TagResource.
", "smithy.api#http": { "method": "POST", "uri": "/UpdateLink" @@ -1536,9 +1622,15 @@ "ResourceTypes": { "target": "com.amazonaws.oam#ResourceTypesInput", "traits": { - "smithy.api#documentation": "An array of strings that define which types of data that the source account will send to the monitoring\n account.
\nYour input here replaces the current set of data types that are shared.
", + "smithy.api#documentation": "An array of strings that define which types of data that the source account will send to the monitoring \n account.
\nYour input here replaces the current set of data types that are shared.
", "smithy.api#required": {} } + }, + "LinkConfiguration": { + "target": "com.amazonaws.oam#LinkConfiguration", + "traits": { + "smithy.api#documentation": "Use this structure to filter which metric namespaces and which log groups are to be shared from \n the source account to the monitoring account.
" + } } }, "traits": { @@ -1589,6 +1681,12 @@ "traits": { "smithy.api#documentation": "The tags assigned to the link.
" } + }, + "LinkConfiguration": { + "target": "com.amazonaws.oam#LinkConfiguration", + "traits": { + "smithy.api#documentation": "This structure includes filters that specify which metric namespaces and which log groups are shared from \n the source account to the monitoring account.
" + } } }, "traits": { @@ -1702,7 +1800,7 @@ "X-Amz-Requested-Operation" ] }, - "smithy.api#documentation": "Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and\n monitoring accounts by using CloudWatch cross-account observability. With\n CloudWatch cross-account observability, you can monitor and troubleshoot applications that span\n multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,\n logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.
\nSet up one or more Amazon Web Services accounts as monitoring\n accounts and link them with multiple source accounts. A\n monitoring account is a central Amazon Web Services account that can view and interact with\n observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.\n Source accounts share their observability data with the monitoring account. The shared\n observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.
", + "smithy.api#documentation": "Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and\n monitoring accounts by using CloudWatch cross-account observability. With\n CloudWatch cross-account observability, you can monitor and troubleshoot applications that span\n multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,\n logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.
\nSet up one or more Amazon Web Services accounts as monitoring\n accounts and link them with multiple source accounts. A\n monitoring account is a central Amazon Web Services account that can view and interact with\n observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.\n Source accounts share their observability data with the monitoring account. The shared\n observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.
", "smithy.api#title": "CloudWatch Observability Access Manager", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk-codegen/aws-models/omics.2022-11-28.json b/codegen/sdk-codegen/aws-models/omics.2022-11-28.json index 7214d5b5fa0..f3db885ee59 100644 --- a/codegen/sdk-codegen/aws-models/omics.2022-11-28.json +++ b/codegen/sdk-codegen/aws-models/omics.2022-11-28.json @@ -125,7 +125,7 @@ } ], "traits": { - "smithy.api#documentation": "\nAccepts a share for an analytics store. \n
", + "smithy.api#documentation": "Accept a resource share request.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -142,7 +142,7 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\nThe ID for a share offer for analytics store data. \n
", + "smithy.api#documentation": "The ID of the resource share.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -158,7 +158,7 @@ "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "\nThe status of an analytics store share. \n
" + "smithy.api#documentation": "The status of the resource share.
" } } }, @@ -508,6 +508,9 @@ }, "list": { "target": "com.amazonaws.omics#ListAnnotationStores" + }, + "traits": { + "smithy.api#documentation": "Represents a resource that stores annotation data" } }, "com.amazonaws.omics#AnnotationStoreItem": { @@ -1263,6 +1266,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create an Annotation Store" + }, "smithy.api#documentation": "Creates an annotation store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -2192,7 +2198,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber. \n
", + "smithy.api#documentation": "Creates a cross-account shared resource. The resource owner makes an offer to share the resource \n with the principal subscriber (an AWS user with a different account than the resource owner).
\nThe following resources support cross-account sharing:
\nHealthomics variant stores
\nHealthomics annotation stores
\nPrivate workflows
\n\n The resource ARN for the analytics store to be shared.\n
", + "smithy.api#documentation": "The ARN of the resource to be shared.
", "smithy.api#required": {} } }, "principalSubscriber": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The principal subscriber is the account being given access to the analytics store data through the share offer. \n
", + "smithy.api#documentation": "The principal subscriber is the account being offered shared access to the resource.
", "smithy.api#required": {} } }, "shareName": { "target": "com.amazonaws.omics#ShareName", "traits": { - "smithy.api#documentation": "\n A name given to the share. \n
" + "smithy.api#documentation": "A name that the owner defines for the share.
" } } }, @@ -2237,19 +2243,19 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n An ID generated for the share. \n
" + "smithy.api#documentation": "The ID that HealthOmics generates for the share.
" } }, "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "\n The status of a share. \n
" + "smithy.api#documentation": "The status of the share.
" } }, "shareName": { "target": "com.amazonaws.omics#ShareName", "traits": { - "smithy.api#documentation": "\n A name given to the share. \n
" + "smithy.api#documentation": "The name of the share.
" } } }, @@ -2289,6 +2295,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create a Variant Store" + }, "smithy.api#documentation": "Creates a variant store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -2476,7 +2485,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "A storage capacity for the workflow in gibibytes.
", + "smithy.api#documentation": "The storage capacity for the workflow in gibibytes.
", "smithy.api#range": { "min": 0, "max": 100000 @@ -2590,6 +2599,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an Annotation Store" + }, "smithy.api#documentation": "Deletes an annotation store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -3097,7 +3109,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deletes a share of an analytics store. \n
", + "smithy.api#documentation": "Deletes a resource share. If you are the resource owner, the subscriber will no longer have \n access to the shared resource. If you are the subscriber, this operation deletes your access to the share.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -3115,7 +3127,7 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The ID for the share request to be deleted. \n
", + "smithy.api#documentation": "The ID for the resource share to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3131,7 +3143,7 @@ "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "\n The status of the share being deleted. \n
" + "smithy.api#documentation": "The status of the share being deleted.
" } } }, @@ -3168,6 +3180,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a Variant Store" + }, "smithy.api#documentation": "Deletes a variant store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -3644,18 +3659,24 @@ "resourceArns": { "target": "com.amazonaws.omics#ArnList", "traits": { - "smithy.api#documentation": "\nThe Amazon Resource Number (Arn) for an analytics store. \n
" + "smithy.api#documentation": "Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.
" } }, "status": { "target": "com.amazonaws.omics#StatusList", "traits": { - "smithy.api#documentation": "\nThe status of an annotation store version. \n
" + "smithy.api#documentation": "Filter based on the resource status. You can specify up to 10 values.
" + } + }, + "type": { + "target": "com.amazonaws.omics#TypeList", + "traits": { + "smithy.api#documentation": "The type of resources to be filtered. You can specify one or more of the resource types.
" } } }, "traits": { - "smithy.api#documentation": "\nUse filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.\n
" + "smithy.api#documentation": "Use filters to return a subset of resources. You can define filters for specific parameters,\n such as the resource status.
" } }, "com.amazonaws.omics#FormatOptions": { @@ -3971,6 +3992,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get detailed information about an Annotation Store" + }, "smithy.api#documentation": "Gets information about an annotation store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -5935,7 +5959,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a workflow run.
", + "smithy.api#documentation": "Gets information about a workflow run.
\nIf a workflow is shared with you, you cannot export information about the run.
", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -6325,7 +6349,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The run's storage capacity in gigabytes.
", + "smithy.api#documentation": "The run's storage capacity in gibibytes. For dynamic storage, \n after the run has completed, this value is the maximum amount of storage\n used during the run.
", "smithy.api#range": { "min": 0, "max": 100000 @@ -6421,6 +6445,18 @@ "traits": { "smithy.api#documentation": "The destination for workflow outputs.
" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "The run's storage type.
" + } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "The ID of the workflow owner.
" + } } }, "traits": { @@ -6875,7 +6911,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Retrieves the metadata for a share. \n
", + "smithy.api#documentation": "Retrieves the metadata for the specified resource share.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -6893,7 +6929,7 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The generated ID for a share. \n
", + "smithy.api#documentation": "The ID of the share.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6909,7 +6945,7 @@ "share": { "target": "com.amazonaws.omics#ShareDetails", "traits": { - "smithy.api#documentation": "\n An analytic store share details object. contains status, resourceArn, ownerId, etc. \n
" + "smithy.api#documentation": "A resource share details object. The object includes the status, the resourceArn, and ownerId.
" } } }, @@ -7140,6 +7176,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get detailed information about a Variant Store" + }, "smithy.api#documentation": "Gets information about a variant store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -7377,7 +7416,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a workflow.
", + "smithy.api#documentation": "Gets information about a workflow.
\nIf a workflow is shared with you, you cannot export the workflow.
", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -7462,6 +7501,13 @@ "smithy.api#documentation": "The export format for the workflow.
", "smithy.api#httpQuery": "export" } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "The ID of the workflow owner.
", + "smithy.api#httpQuery": "workflowOwnerId" + } } }, "traits": { @@ -7542,7 +7588,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The workflow's storage capacity in gigabytes.
", + "smithy.api#documentation": "The workflow's storage capacity in gibibytes.
", "smithy.api#range": { "min": 0, "max": 100000 @@ -8169,12 +8215,12 @@ "status": { "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "\nThe status of an annotation store version. \n
" + "smithy.api#documentation": "The status of an annotation store version.
" } } }, "traits": { - "smithy.api#documentation": "\nUse filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.\n
" + "smithy.api#documentation": "Use filters to focus the returned annotation store versions on a specific parameter,\n such as the status of the annotation store.
" } }, "com.amazonaws.omics#ListAnnotationStoreVersionsRequest": { @@ -8267,6 +8313,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of information about Annotation Stores" + }, "smithy.api#documentation": "Retrieves a list of annotation stores.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -9810,7 +9859,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Lists all shares associated with an account. \n
", + "smithy.api#documentation": "Retrieves the resource shares associated with an account. Use the filter parameter to \n retrieve a specific subset of the shares.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -9834,27 +9883,27 @@ "resourceOwner": { "target": "com.amazonaws.omics#ResourceOwner", "traits": { - "smithy.api#documentation": "\n The account that owns the analytics store shared. \n
", + "smithy.api#documentation": "The account that owns the resource shares.
", "smithy.api#required": {} } }, "filter": { "target": "com.amazonaws.omics#Filter", "traits": { - "smithy.api#documentation": "\n Attributes used to filter for a specific subset of shares. \n
" + "smithy.api#documentation": "Attributes that you use to filter for a specific subset of resource shares.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.\n
", + "smithy.api#documentation": "Next token returned in the response of a previous ListReadSetUploadPartsRequest call.\n Used to get the next page of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The maximum number of shares to return in one page of results.\n
", + "smithy.api#documentation": "The maximum number of shares to return in one page of results.
", "smithy.api#httpQuery": "maxResults" } } @@ -9869,7 +9918,7 @@ "shares": { "target": "com.amazonaws.omics#ShareDetailsList", "traits": { - "smithy.api#documentation": "\n The shares available and their meta details. \n
", + "smithy.api#documentation": "The shares available and their metadata details.
", "smithy.api#required": {} } }, @@ -10118,6 +10167,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of metadata for Variant Stores" + }, "smithy.api#documentation": "Retrieves a list of variant stores.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -10275,14 +10327,14 @@ "type": { "target": "com.amazonaws.omics#WorkflowType", "traits": { - "smithy.api#documentation": "The workflows' type.
", + "smithy.api#documentation": "Filter the list by workflow type.
", "smithy.api#httpQuery": "type" } }, "name": { "target": "com.amazonaws.omics#WorkflowName", "traits": { - "smithy.api#documentation": "The workflows' name.
", + "smithy.api#documentation": "Filter the list by workflow name.
", "smithy.api#httpQuery": "name" } }, @@ -10315,7 +10367,7 @@ "items": { "target": "com.amazonaws.omics#WorkflowList", "traits": { - "smithy.api#documentation": "The workflows' items.
" + "smithy.api#documentation": "A list of workflow items.
" } }, "nextToken": { @@ -12865,7 +12917,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The run's storage capacity.
", + "smithy.api#documentation": "The run's storage capacity in gibibytes. For dynamic storage, \n after the run has completed, this value is the maximum amount of storage\n used during the run.
", "smithy.api#range": { "min": 0, "max": 100000 @@ -12889,6 +12941,12 @@ "traits": { "smithy.api#documentation": "When the run stopped.
" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "The run's storage type.
" + } } }, "traits": { @@ -13586,60 +13644,66 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The ID for a share offer for an analytics store .\n
" + "smithy.api#documentation": "The ID of the resource share.
" } }, "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The resource Arn of the analytics store being shared. \n
" + "smithy.api#documentation": "The Arn of the shared resource.
" + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the shared resource.
" } }, "principalSubscriber": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The principal subscriber is the account the analytics store data is being shared with. \n
" + "smithy.api#documentation": "The principal subscriber is the account that is sharing the resource.
" } }, "ownerId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The account ID for the data owner. The owner creates the share offer. \n
" + "smithy.api#documentation": "The account ID for the data owner. The owner creates the resource share.
" } }, "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "\n The status of a share. \n
" + "smithy.api#documentation": "The status of the share.
" } }, "statusMessage": { "target": "com.amazonaws.omics#StatusMessage", "traits": { - "smithy.api#documentation": "\n The status message for a share. It provides more details on the status of the share.\n
" + "smithy.api#documentation": "The status message for a resource share. It provides additional details about the share status.
" } }, "shareName": { "target": "com.amazonaws.omics#ShareName", "traits": { - "smithy.api#documentation": "\n The name of the share. \n
" + "smithy.api#documentation": "The name of the resource share.
" } }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { - "smithy.api#documentation": "\n The timestamp for when the share was created. \n
" + "smithy.api#documentation": "The timestamp of when the resource share was created.
" } }, "updateTime": { "target": "com.amazonaws.omics#UpdateTime", "traits": { - "smithy.api#documentation": "\n The timestamp of the share update. \n
" + "smithy.api#documentation": "The timestamp of the resource share update.
" } } }, "traits": { - "smithy.api#documentation": "\n The details of a share. \n
" + "smithy.api#documentation": "The details of a resource share.
" } }, "com.amazonaws.omics#ShareDetailsList": { @@ -13658,6 +13722,28 @@ "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" } }, + "com.amazonaws.omics#ShareResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VARIANT_STORE", + "name": "VARIANT_STORE", + "documentation": "The share is on a variant store" + }, + { + "value": "ANNOTATION_STORE", + "name": "ANNOTATION_STORE", + "documentation": "The share is on an annotation store" + }, + { + "value": "WORKFLOW", + "name": "WORKFLOW", + "documentation": "The share is on a workflow" + } + ] + } + }, "com.amazonaws.omics#ShareStatus": { "type": "string", "traits": { @@ -14520,7 +14606,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The\n remaining parameters are copied from the previous run.
\nThe total number of runs in your account is subject to a quota per Region. To avoid\n needing to delete runs manually, you can set the retention mode to REMOVE.\n Runs with this setting are deleted automatically when the run quoata is exceeded.
Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The\n remaining parameters are copied from the previous run.
\nStartRun will not support re-run for a workflow that is shared with you.
\nThe total number of runs in your account is subject to a quota per Region. To avoid\n needing to delete runs manually, you can set the retention mode to REMOVE.\n Runs with this setting are deleted automatically when the run quoata is exceeded.
By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. \n You can set the storage type to DYNAMIC. You do not set storageCapacity,\n because HealthOmics dynamically scales the storage up or down as required.\n For more information about static and dynamic storage, see Running workflows \n in the AWS HealthOmics User Guide.
A storage capacity for the run in gibibytes.
", + "smithy.api#documentation": "A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic\n (the system ignores any value that you enter).
", "smithy.api#range": { "min": 0, "max": 100000 @@ -14628,6 +14714,18 @@ "traits": { "smithy.api#documentation": "The retention mode for the run.
" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage.\n If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up \n or down, based on file system utilization.
" + } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "The ID of the workflow owner.
" + } } }, "traits": { @@ -14781,6 +14879,10 @@ "target": "com.amazonaws.omics#ShareStatus" }, "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, "smithy.api#uniqueItems": {} } }, @@ -14793,6 +14895,25 @@ } } }, + "com.amazonaws.omics#StorageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATIC", + "value": "STATIC" + }, + { + "name": "DYNAMIC", + "value": "DYNAMIC" + } + ], + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, "com.amazonaws.omics#StoreFormat": { "type": "string", "traits": { @@ -15333,6 +15454,19 @@ "smithy.api#documentation": "\nThe options for a TSV file.\n
" } }, + "com.amazonaws.omics#TypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#ShareResourceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.omics#UntagResource": { "type": "operation", "input": { @@ -15437,6 +15571,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update information about the Annotation Store" + }, "smithy.api#documentation": "Updates an annotation store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -15810,6 +15947,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update metadata about the Variant Store" + }, "smithy.api#documentation": "Updates a variant store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -16295,6 +16435,9 @@ }, "list": { "target": "com.amazonaws.omics#ListVariantStores" + }, + "traits": { + "smithy.api#documentation": "Represents a resource that stores variant data" } }, "com.amazonaws.omics#VariantStoreItem": { @@ -16722,6 +16865,12 @@ "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" } }, + "com.amazonaws.omics#WorkflowOwnerId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.omics#WorkflowParameter": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/opensearch.2021-01-01.json b/codegen/sdk-codegen/aws-models/opensearch.2021-01-01.json index 8157d81a080..078f76fc48a 100644 --- a/codegen/sdk-codegen/aws-models/opensearch.2021-01-01.json +++ b/codegen/sdk-codegen/aws-models/opensearch.2021-01-01.json @@ -373,7 +373,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of\n case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see\n Tagging Amazon OpenSearch Service domains.
", + "smithy.api#documentation": "Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of\n case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see\n Tagging Amazon OpenSearch Service domains.\n
", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/tags", @@ -6204,7 +6204,13 @@ "Endpoints": { "target": "com.amazonaws.opensearch#EndpointsMap", "traits": { - "smithy.api#documentation": "The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example\n key, value:\n 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:
\n\n IPv4 IP addresses -\n 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'\n
\n Dual stack IP addresses -\n 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'\n
The DualStack Hosted Zone Id for the domain.
" } }, "Processing": { @@ -7229,6 +7235,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#HostedZoneId": { + "type": "string" + }, "com.amazonaws.opensearch#IPAddressType": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/personalize-runtime.2018-05-22.json b/codegen/sdk-codegen/aws-models/personalize-runtime.2018-05-22.json index e3e39c56d69..b3d5f46816a 100644 --- a/codegen/sdk-codegen/aws-models/personalize-runtime.2018-05-22.json +++ b/codegen/sdk-codegen/aws-models/personalize-runtime.2018-05-22.json @@ -1164,6 +1164,9 @@ }, "value": { "target": "com.amazonaws.personalizeruntime#ColumnValue" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.personalizeruntime#MetadataColumns": { @@ -1255,6 +1258,12 @@ "traits": { "smithy.api#documentation": "Metadata about the item from your Items dataset.
" } + }, + "reason": { + "target": "com.amazonaws.personalizeruntime#ReasonList", + "traits": { + "smithy.api#documentation": "If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:
\nPromoted item - Indicates the item was included as part of a promotion that you applied in your recommendation request.
\nExploration - Indicates the item was included with exploration.\n With exploration, recommendations include items with less interactions data or relevance for the user.\n For more information about exploration, see \n Exploration.
\n \n Popular item - Indicates the item was included as a placeholder popular item.\n If you use a filter, depending on how many recommendations the filter removes, \n Amazon Personalize might add placeholder items to meet the numResults for your \n recommendation request. These items are popular items, based on interactions data, that satisfy your filter criteria.\n They don't have a relevance score for the user.\n
Creates a batch job that deletes all\n references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in \n an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains\n on the users’ data and no longer considers the users when generating user segments. \n For more information about creating a data deletion job, see Deleting users.
\nYour input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information\n about preparing the CSV file, see Preparing your data deletion file and uploading it to Amazon S3.
\nTo give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to\n read from the data source. This role \n needs GetObject and ListBucket permissions for the bucket and its content.\n These permissions are the same as importing data. For information on granting access to your Amazon S3\n bucket, see Giving\n Amazon Personalize Access to Amazon S3 Resources.
\n After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, \n Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments. \n
\n\n Status\n
\nA data deletion job can have one of the following statuses:
\nPENDING > IN_PROGRESS > COMPLETED -or- FAILED
\nTo get the status of the data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon Resource Name\n (ARN) of the job. If the status is FAILED, the response\n includes a failureReason key, which describes why the job\n failed.
\n Related APIs\n
\n\n ListDataDeletionJobs\n
\nThe name for the data deletion job.
", + "smithy.api#required": {} + } + }, + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset group that has the datasets you want to\n delete records from.
", + "smithy.api#required": {} + } + }, + "dataSource": { + "target": "com.amazonaws.personalize#DataSource", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket that contains the list of userIds of the users to delete.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.personalize#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3\n data source.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.personalize#Tags", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the data deletion job.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.personalize#CreateDataDeletionJobResponse": { + "type": "structure", + "members": { + "dataDeletionJobArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data deletion job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.personalize#CreateDataset": { "type": "operation", "input": { @@ -3182,18 +3279,145 @@ "smithy.api#output": {} } }, + "com.amazonaws.personalize#DataDeletionJob": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "The name of the data deletion job.
" + } + }, + "dataDeletionJobArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data deletion job.
" + } + }, + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset group the job deletes records from.
" + } + }, + "dataSource": { + "target": "com.amazonaws.personalize#DataSource" + }, + "roleArn": { + "target": "com.amazonaws.personalize#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3\n data source.
" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "The status of the data deletion job.
\nA data deletion job can have one of the following statuses:
\nPENDING > IN_PROGRESS > COMPLETED -or- FAILED
\nThe number of records deleted by a COMPLETED job.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The creation date and time (in Unix time) of the data deletion\n job.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The date and time (in Unix time) the data deletion job was last updated.
" + } + }, + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", + "traits": { + "smithy.api#documentation": "If a data deletion job fails, provides the reason why.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a job that deletes all\n references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, \n see Deleting users.
" + } + }, + "com.amazonaws.personalize#DataDeletionJobSummary": { + "type": "structure", + "members": { + "dataDeletionJobArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data deletion job.
" + } + }, + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset group the job deleted records from.
" + } + }, + "jobName": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "The name of the data deletion job.
" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "The status of the data deletion job.
\nA data deletion job can have one of the following statuses:
\nPENDING > IN_PROGRESS > COMPLETED -or- FAILED
\nThe creation date and time (in Unix time) of the data deletion\n job.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The date and time (in Unix time) the data deletion job was last updated.
" + } + }, + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", + "traits": { + "smithy.api#documentation": "If a data deletion job fails, provides the reason why.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of the properties of a data deletion job. For a complete listing, call the DescribeDataDeletionJob\n API operation.
" + } + }, + "com.amazonaws.personalize#DataDeletionJobs": { + "type": "list", + "member": { + "target": "com.amazonaws.personalize#DataDeletionJobSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.personalize#DataSource": { "type": "structure", "members": { "dataLocation": { "target": "com.amazonaws.personalize#S3Location", "traits": { - "smithy.api#documentation": "The path to the Amazon S3 bucket where the data that you want to upload to\n your dataset is stored. For example:
\n\n s3://bucket-name/folder-name/\n
For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to\n your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete.\n
\n\n For example:
\n\n s3://bucket-name/folder-name/fileName.csv\n
If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job\n to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a / after the folder\n name:
\n s3://bucket-name/folder-name/\n
Describes the data source that contains the data to upload to a\n dataset.
" + "smithy.api#documentation": "Describes the data source that contains the data to upload to a dataset, or the list of \n records to delete from Amazon Personalize.
" } }, "com.amazonaws.personalize#Dataset": { @@ -4559,6 +4783,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.personalize#DescribeDataDeletionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#DescribeDataDeletionJobRequest" + }, + "output": { + "target": "com.amazonaws.personalize#DescribeDataDeletionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the data deletion job created by CreateDataDeletionJob, including the job status.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#DescribeDataDeletionJobRequest": { + "type": "structure", + "members": { + "dataDeletionJobArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data deletion job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.personalize#DescribeDataDeletionJobResponse": { + "type": "structure", + "members": { + "dataDeletionJob": { + "target": "com.amazonaws.personalize#DataDeletionJob", + "traits": { + "smithy.api#documentation": "Information about the data deletion job, including the status.
\nThe status is one of the following values:
\nPENDING
\nIN_PROGRESS
\nCOMPLETED
\nFAILED
\nReturns a list of data deletion jobs for a dataset group ordered by creation time,\n with the most recent first.\n When\n a dataset group is not specified, all the data deletion jobs associated with\n the account are listed. The response provides the properties for each\n job, including the Amazon Resource Name (ARN). For more\n information on data deletion jobs, see Deleting users.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#ListDataDeletionJobsRequest": { + "type": "structure", + "members": { + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.
" + } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "A token returned from the previous call to\n ListDataDeletionJobs for getting the next set of jobs (if they exist).
The maximum number of data deletion jobs to return.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.personalize#ListDataDeletionJobsResponse": { + "type": "structure", + "members": { + "dataDeletionJobs": { + "target": "com.amazonaws.personalize#DataDeletionJobs", + "traits": { + "smithy.api#documentation": "The list of data deletion jobs.
" + } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of data deletion jobs (if they\n exist).
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.personalize#ListDatasetExportJobs": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/pi.2018-02-27.json b/codegen/sdk-codegen/aws-models/pi.2018-02-27.json index a48daf928cd..ea55a498dd5 100644 --- a/codegen/sdk-codegen/aws-models/pi.2018-02-27.json +++ b/codegen/sdk-codegen/aws-models/pi.2018-02-27.json @@ -1096,7 +1096,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide\n specific dimension groups and dimensions, and provide aggregation and filtering criteria for\n each group.
\nEach response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, \n only the first 500 bytes are returned.
\nRetrieve Performance Insights metrics for a set of data sources over a time period. You can provide\n specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for\n each metric.
\nEach response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, \n only the first 500 bytes are returned.
\nAn array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering\n criteria.
", + "smithy.api#documentation": "An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering\n criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load \n you must use db.load.avg. Valid values for aggregate functions include .avg, .min, \n .max, and .sum.
The name of a Performance Insights metric to be measured.
\nValid values for Metric are:
\n db.load.avg - A scaled representation of the number of active sessions for the \n database engine.
\n db.sampledload.avg - The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights\n operating system counters in the Amazon Aurora User Guide.
\nIf the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same\n value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the\n scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than\n db.load.avg. For most use cases, you can query db.load.avg only.
The name of a Performance Insights metric to be measured.
\nValid values for Metric are:
\n db.load.avg - A scaled representation of the number of active sessions for the \n database engine.
\n db.sampledload.avg - The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights\n operating system counters in the Amazon Aurora User Guide.
\nThe counter metrics listed in Performance Insights\n operating system counters in the Amazon RDS User Guide.
\nIf the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same\n value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the\n scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than\n db.load.avg. For most use cases, you can query db.load.avg only.
A single query to be processed. You must provide the metric to query. If no other\n parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can\n request that the data points be aggregated by dimension group (GroupBy), and return only \n those data points that match your criteria (Filter).
A single query to be processed. You must provide the metric to query and append an aggregate function to the metric.\n For example, to find the average for the metric db.load \n you must use db.load.avg. Valid values for aggregate functions include .avg, .min, \n .max, and .sum.\n If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can\n request that the data points be aggregated by dimension group (GroupBy), and return only \n those data points that match your criteria (Filter).
The name of a Performance Insights metric to be measured.
\nValid values for Metric are:
\n db.load.avg - A scaled representation of the number of active sessions for the database engine.
\n db.sampledload.avg - The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights\n operating system counters in the Amazon Aurora User Guide.
\nIf the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and \n db.sampledload.avg are the same value. If the number of active sessions is greater than the \n internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, \n db.sampledload.avg showing the raw values, and db.sampledload.avg less \n than db.load.avg. For most use cases, you can query db.load.avg only.\n
The name of a Performance Insights metric to be measured.
\nValid values for Metric are:
\n db.load.avg - A scaled representation of the number of active sessions for the database engine.
\n db.sampledload.avg - The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights\n operating system counters in the Amazon Aurora User Guide.
\nThe counter metrics listed in Performance Insights\n operating system counters in the Amazon RDS User Guide.
\nIf the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and \n db.sampledload.avg are the same value. If the number of active sessions is greater than the \n internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, \n db.sampledload.avg showing the raw values, and db.sampledload.avg less \n than db.load.avg. For most use cases, you can query db.load.avg only.\n
Associate a protect configuration with a configuration set. This replaces the\n configuration sets current protect configuration. A configuration set can\n only be associated with one protect configuration at a time. A protect configuration can\n be associated with multiple configuration sets.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfigurationRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the ConfigurationSet.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfigurationResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
", + "smithy.api#required": {} + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "traits": { + "smithy.api#documentation": "The name of the ConfigurationSet.
", + "smithy.api#required": {} + } + }, + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the protect configuration.
", + "smithy.api#required": {} + } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#AttachmentBody": { "type": "blob", "traits": { @@ -337,7 +431,7 @@ "IamRoleArn": { "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role\n that is able to write event data to an Amazon CloudWatch destination.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management role\n that is able to write event data to an Amazon CloudWatch destination.
", "smithy.api#required": {} } }, @@ -405,6 +499,10 @@ { "value": "default-sender-id", "name": "DEFAULT_SENDER_ID" + }, + { + "value": "protect-configuration-id", + "name": "PROTECT_CONFIGURATION_ID" } ] } @@ -451,6 +549,12 @@ "smithy.api#documentation": "The time when the ConfigurationSet was created, in UNIX epoch time format.
", "smithy.api#required": {} } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
" + } } }, "traits": { @@ -651,6 +755,22 @@ { "value": "VERIFICATION_ALREADY_COMPLETE", "name": "VERIFICATION_ALREADY_COMPLETE" + }, + { + "value": "PROTECT_CONFIGURATION_IS_ACCOUNT_DEFAULT", + "name": "PROTECT_CONFIGURATION_IS_ACCOUNT_DEFAULT" + }, + { + "value": "PROTECT_CONFIGURATION_ASSOCIATED_WITH_CONFIGURATION_SET", + "name": "PROTECT_CONFIGURATION_ASSOCIATED_WITH_CONFIGURATION_SET" + }, + { + "value": "PROTECT_CONFIGURATION_NOT_ASSOCIATED_WITH_CONFIGURATION_SET", + "name": "PROTECT_CONFIGURATION_NOT_ASSOCIATED_WITH_CONFIGURATION_SET" + }, + { + "value": "DESTINATION_COUNTRY_BLOCKED_BY_PROTECT_CONFIGURATION", + "name": "DESTINATION_COUNTRY_BLOCKED_BY_PROTECT_CONFIGURATION" } ] } @@ -843,13 +963,13 @@ "CloudWatchLogsDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#CloudWatchLogsDestination", "traits": { - "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon\n CloudWatch logs.
" + "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon CloudWatch Logs.
" } }, "KinesisFirehoseDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon\n Kinesis Data Firehose.
" + "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
" } }, "SnsDestination": { @@ -1161,6 +1281,113 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.\n
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfigurationResult": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the protect configuration.
", + "smithy.api#required": {} + } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the protect configuration was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + }, + "AccountDefault": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if the protect configuration is set as your account default protect configuration.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.\n
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#CreateRegistration": { "type": "operation", "input": { @@ -1711,6 +1938,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the current account default protect configuration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfigurationResult": { + "type": "structure", + "members": { + "DefaultProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the account default protect configuration.
", + "smithy.api#required": {} + } + }, + "DefaultProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the account default protect configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet": { "type": "operation", "input": { @@ -2108,27 +2393,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList": { + "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverride": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverrideRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverrideResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -2137,36 +2416,89 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are\n deleted.
\nIf the specified opt-out list name doesn't exist or is in-use by an origination phone\n number or pool, an error is returned.
" + "smithy.api#documentation": "Deletes an account-level monthly spending limit override for sending multimedia messages (MMS).\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Quotas for Server Migration Service\n in the Server Migration Service User Guide.
The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", - "smithy.api#required": {} - } - } - }, + "members": {}, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverrideResult": { "type": "structure", "members": { - "OptOutListArn": { - "target": "smithy.api#String", + "MonthlyLimit": { + "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList that was removed.
" + "smithy.api#documentation": "The current monthly limit, in US dollars.
" } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are\n deleted.
\nIf the specified opt-out list name doesn't exist or is in-use by an origination phone\n number or pool, an error is returned.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest": { + "type": "structure", + "members": { + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult": { + "type": "structure", + "members": { + "OptOutListArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList that was removed.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { "smithy.api#documentation": "The name of the OptOutList that was removed.
" } }, @@ -2398,6 +2730,98 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfigurationRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfigurationResult": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the protect configuration.
", + "smithy.api#required": {} + } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the protect configuration was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + }, + "AccountDefault": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if the protect configuration is set as your account default protect configuration.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#DeleteRegistration": { "type": "operation", "input": { @@ -3571,6 +3995,90 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
", + "smithy.api#paginated": { + "items": "ProtectConfigurations" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurationsRequest": { + "type": "structure", + "members": { + "ProtectConfigurationIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdList", + "traits": { + "smithy.api#documentation": "An array of protect configuration identifiers to search for.
" + } + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilterList", + "traits": { + "smithy.api#documentation": "An array of ProtectConfigurationFilter objects to filter the results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurationsResult": { + "type": "structure", + "members": { + "ProtectConfigurations": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationInformationList", + "traits": { + "smithy.api#documentation": "An array of ProtectConfigurationInformation objects that contain the details for the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachments": { "type": "operation", "input": { @@ -4634,13 +5142,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion": { + "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfigurationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfigurationResult" }, "errors": [ { @@ -4663,16 +5171,23 @@ } ], "traits": { - "smithy.api#documentation": "Discard the current version of the registration.
" + "smithy.api#documentation": "Disassociate a protect configuration from a configuration set.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest": { + "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfigurationRequest": { "type": "structure", "members": { - "RegistrationId": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the ConfigurationSet.
", "smithy.api#required": {} } } @@ -4681,41 +5196,34 @@ "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult": { + "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfigurationResult": { "type": "structure", "members": { - "RegistrationArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", - "smithy.api#required": {} - } - }, - "RegistrationId": { + "ConfigurationSetArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
", "smithy.api#required": {} } }, - "VersionNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#documentation": "The name of the ConfigurationSet.
", "smithy.api#required": {} } }, - "RegistrationVersionStatus": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", "traits": { - "smithy.api#documentation": "The status of the registration version.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The Amazon Resource Name (ARN) of the protect configuration.
", "smithy.api#required": {} } }, - "RegistrationVersionStatusHistory": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatusHistory", + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", "traits": { - "smithy.api#documentation": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
", + "smithy.api#documentation": "The unique identifier for the protect configuration.
", "smithy.api#required": {} } } @@ -4724,19 +5232,109 @@ "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#EventDestination": { - "type": "structure", - "members": { - "EventDestinationName": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", - "traits": { - "smithy.api#documentation": "The name of the EventDestination.
", - "smithy.api#required": {} - } - }, - "Enabled": { - "target": "smithy.api#Boolean", - "traits": { + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Discard the current version of the registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationVersionStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the registration version.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventDestination": { + "type": "structure", + "members": { + "EventDestinationName": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", + "traits": { + "smithy.api#documentation": "The name of the EventDestination.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { "smithy.api#documentation": "When set to true events will be logged.
", "smithy.api#required": {} } @@ -4757,7 +5355,7 @@ "KinesisFirehoseDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon\n Kinesis Data Firehose.
" + "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
" } }, "SnsDestination": { @@ -4768,7 +5366,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about an event destination.
\nEvent destinations are associated with configuration sets, which enable you to publish\n message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS.
" + "smithy.api#documentation": "Contains information about an event destination.
\nEvent destinations are associated with configuration sets, which enable you to publish\n message sending events to CloudWatch, Kinesis Data Firehose, or Amazon SNS.
" } }, "com.amazonaws.pinpointsmsvoicev2#EventDestinationList": { @@ -4890,6 +5488,74 @@ { "value": "VOICE_TTL_EXPIRED", "name": "VOICE_TTL_EXPIRED" + }, + { + "value": "MEDIA_ALL", + "name": "MEDIA_ALL" + }, + { + "value": "MEDIA_PENDING", + "name": "MEDIA_PENDING" + }, + { + "value": "MEDIA_QUEUED", + "name": "MEDIA_QUEUED" + }, + { + "value": "MEDIA_SUCCESSFUL", + "name": "MEDIA_SUCCESSFUL" + }, + { + "value": "MEDIA_DELIVERED", + "name": "MEDIA_DELIVERED" + }, + { + "value": "MEDIA_INVALID", + "name": "MEDIA_INVALID" + }, + { + "value": "MEDIA_INVALID_MESSAGE", + "name": "MEDIA_INVALID_MESSAGE" + }, + { + "value": "MEDIA_UNREACHABLE", + "name": "MEDIA_UNREACHABLE" + }, + { + "value": "MEDIA_CARRIER_UNREACHABLE", + "name": "MEDIA_CARRIER_UNREACHABLE" + }, + { + "value": "MEDIA_BLOCKED", + "name": "MEDIA_BLOCKED" + }, + { + "value": "MEDIA_CARRIER_BLOCKED", + "name": "MEDIA_CARRIER_BLOCKED" + }, + { + "value": "MEDIA_SPAM", + "name": "MEDIA_SPAM" + }, + { + "value": "MEDIA_UNKNOWN", + "name": "MEDIA_UNKNOWN" + }, + { + "value": "MEDIA_TTL_EXPIRED", + "name": "MEDIA_TTL_EXPIRED" + }, + { + "value": "MEDIA_FILE_INACCESSIBLE", + "name": "MEDIA_FILE_INACCESSIBLE" + }, + { + "value": "MEDIA_FILE_TYPE_UNSUPPORTED", + "name": "MEDIA_FILE_TYPE_UNSUPPORTED" + }, + { + "value": "MEDIA_FILE_SIZE_EXCEEDED", + "name": "MEDIA_FILE_SIZE_EXCEEDED" } ] } @@ -4902,7 +5568,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 25 + "max": 43 } } }, @@ -4970,9 +5636,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 128 }, - "smithy.api#pattern": "^[\\.:A-Za-z0-9_-]+$" + "smithy.api#pattern": "^[/\\.:A-Za-z0-9_-]+$" } }, "com.amazonaws.pinpointsmsvoicev2#FilterValueList": { @@ -4987,6 +5653,93 @@ } } }, + "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSetRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSetResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSetRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "NumberCapability": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapability", + "traits": { + "smithy.api#documentation": "The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.
The Amazon Resource Name (ARN) of the protect configuration.
", + "smithy.api#required": {} + } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "NumberCapability": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapability", + "traits": { + "smithy.api#documentation": "The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.
", + "smithy.api#required": {} + } + }, + "CountryRuleSet": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet", + "traits": { + "smithy.api#documentation": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#IamRoleArn": { "type": "string", "traits": { @@ -5161,7 +5914,7 @@ "IamRoleArn": { "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", "traits": { - "smithy.api#documentation": "The ARN of an Amazon Identity and Access Management (IAM) role that is able to write\n event data to an Amazon Firehose destination.
", + "smithy.api#documentation": "The ARN of an Identity and Access Management role that is able to write\n event data to an Amazon Kinesis Data Firehose destination.
", "smithy.api#required": {} } }, @@ -5174,7 +5927,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event\n destination.
\nEvent destinations, such as Kinesis Data Firehose, are associated with configuration\n sets, which enable you to publish message sending events.
" + "smithy.api#documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Kinesis Data Firehose event\n destination.
\nEvent destinations, such as Kinesis Data Firehose, are associated with configuration\n sets, which enable you to publish message sending events.
" } }, "com.amazonaws.pinpointsmsvoicev2#LanguageCode": { @@ -5533,6 +6286,38 @@ } } }, + "com.amazonaws.pinpointsmsvoicev2#MediaMessageOriginationIdentity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/\\+-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#MediaUrlList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#MediaUrlValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#MediaUrlValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^s3://([a-z0-9\\.-]{3,63})/(.+)$" + } + }, "com.amazonaws.pinpointsmsvoicev2#MessageType": { "type": "string", "traits": { @@ -5601,6 +6386,10 @@ { "value": "VOICE", "name": "VOICE" + }, + { + "value": "MMS", + "name": "MMS" } ] } @@ -5613,7 +6402,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 2 + "max": 3 } } }, @@ -6152,6 +6941,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentity" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSet" }, @@ -6164,6 +6956,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#CreatePool" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistration" }, @@ -6179,6 +6974,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumber" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet" }, @@ -6194,6 +6992,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverride" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber" }, @@ -6203,6 +7004,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DeletePool" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistration" }, @@ -6245,6 +7049,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DescribePools" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurations" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachments" }, @@ -6278,9 +7085,15 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSet" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities" }, @@ -6314,18 +7127,27 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCode" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SendMediaMessage" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessage" }, { "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType" }, { "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverride" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride" }, @@ -6350,6 +7172,12 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePool" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfiguration" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSet" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#UpdateSenderId" }, @@ -6367,7 +7195,7 @@ "name": "sms-voice" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.\n This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.
\nAmazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The Amazon Pinpoint SMS and\n Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels and supplements the resources provided by the Amazon Pinpoint\n API.
\nIf you're new to Amazon Pinpoint, it's also helpful to review the \n Amazon Pinpoint Developer Guide. The Amazon Pinpoint\n Developer Guide provides tutorials, code samples, and procedures that\n demonstrate how to use Amazon Pinpoint features programmatically and how to integrate\n Amazon Pinpoint functionality into mobile apps and other types of applications.\n The guide also provides key information, such as Amazon Pinpoint integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.
\n\n Regional availability\n
\nThe Amazon Pinpoint SMS and Voice, version 2 API Reference is\n available in several Amazon Web Services Regions and it provides an endpoint for each of\n these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see Amazon Web Services Service Endpoints and Amazon Pinpoint\n endpoints and quotas in the Amazon Web Services General Reference. To\n learn more about Amazon Web Services Regions, see Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.
\nIn each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These\n Availability Zones enable us to provide very high levels of availability and redundancy,\n while also minimizing latency. To learn more about the number of Availability Zones that\n are available in each Region, see Amazon Web Services\n Global Infrastructure.\n
", + "smithy.api#documentation": "Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.\n This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.
\nAmazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The Amazon Pinpoint SMS and\n Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels. Amazon Pinpoint SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
\nIf you're new to Amazon Pinpoint SMS, it's also helpful to review the \n Amazon Pinpoint SMS User Guide. The Amazon Pinpoint\n Developer Guide provides tutorials, code samples, and procedures that\n demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate\n Amazon Pinpoint functionality into mobile apps and other types of applications.\n The guide also provides key information, such as Amazon Pinpoint integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.
\n\n Regional availability\n
\nThe Amazon Pinpoint SMS and Voice, version 2 API Reference is\n available in several Amazon Web Services Regions and it provides an endpoint for each of\n these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see Amazon Web Services Service Endpoints and Amazon Pinpoint\n endpoints and quotas in the Amazon Web Services General Reference. To\n learn more about Amazon Web Services Regions, see Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.
\nIn each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These\n Availability Zones enable us to provide very high levels of availability and redundancy,\n while also minimizing latency. To learn more about the number of Availability Zones that\n are available in each Region, see Amazon Web Services\n Global Infrastructure.\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7394,6 +8222,197 @@ ] } }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet": { + "type": "map", + "key": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode" + }, + "value": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSetInformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSetInformation": { + "type": "structure", + "members": { + "ProtectStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectStatus", + "traits": { + "smithy.api#documentation": "The types of protection that can be used.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The types of statuses that can be used.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering protect configurations that meet a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "account-default", + "name": "ACCOUNT_DEFAULT" + }, + { + "value": "deletion-protection-enabled", + "name": "DELETION_PROTECTION_ENABLED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationInformation": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the protect configuration.
", + "smithy.api#required": {} + } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the protect configuration was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + }, + "AccountDefault": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if the protect configuration is set as your account default protect configuration.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information on the specified protect configuration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationInformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALLOW", + "name": "ALLOW" + }, + { + "value": "BLOCK", + "name": "BLOCK" + } + ] + } + }, "com.amazonaws.pinpointsmsvoicev2#PutKeyword": { "type": "operation", "input": { @@ -9516,6 +10535,10 @@ { "value": "verified-destination-number", "name": "VERIFIED_DESTINATION_NUMBER" + }, + { + "value": "protect-configuration", + "name": "PROTECT_CONFIGURATION" } ] } @@ -9725,6 +10748,126 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#SendMediaMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendMediaMessageRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendMediaMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendMediaMessageRequest": { + "type": "structure", + "members": { + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The destination phone number in E.164 format.
", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#MediaMessageOriginationIdentity", + "traits": { + "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
", + "smithy.api#required": {} + } + }, + "MessageBody": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageBody", + "traits": { + "smithy.api#documentation": "The text body of the message.
" + } + }, + "MediaUrls": { + "target": "com.amazonaws.pinpointsmsvoicev2#MediaUrlList", + "traits": { + "smithy.api#documentation": "An array of URLs to each media file to send.
\nThe media files have to be stored in a publicly available S3 bucket. Supported media file formats\n are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing\n objects, see Creating a bucket and Uploading objects in the S3 user guide.
" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + } + }, + "MaxPrice": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", + "traits": { + "smithy.api#documentation": "The maximum amount that you want to spend, in US dollars, per each MMS message.
" + } + }, + "TimeToLive": { + "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", + "traits": { + "smithy.api#documentation": "How long the text message is valid for. By default this is 72 hours.
" + } + }, + "Context": { + "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "traits": { + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + } + }, + "DryRun": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier of the protect configuration to use.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendMediaMessageResult": { + "type": "structure", + "members": { + "MessageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the message.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#SendTextMessage": { "type": "operation", "input": { @@ -9830,6 +10973,12 @@ "smithy.api#default": false, "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
" + } } }, "traits": { @@ -9950,6 +11099,12 @@ "smithy.api#default": false, "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
" + } } }, "traits": { @@ -10200,6 +11355,10 @@ "value": "KEYWORDS_PER_POOL", "name": "KEYWORDS_PER_POOL" }, + { + "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_MEDIA", + "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_MEDIA" + }, { "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT", "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT" @@ -10259,10 +11418,80 @@ { "value": "VERIFICATION_ATTEMPTS_PER_DAY", "name": "VERIFICATION_ATTEMPTS_PER_DAY" + }, + { + "value": "PROTECT_CONFIGURATIONS_PER_ACCOUNT", + "name": "PROTECT_CONFIGURATIONS_PER_ACCOUNT" } ] } }, + "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Set a protect configuration as your account default. You can only have one account\n default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfigurationRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfigurationResult": { + "type": "structure", + "members": { + "DefaultProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the account default protect configuration.
", + "smithy.api#required": {} + } + }, + "DefaultProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the account default protect configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType": { "type": "operation", "input": { @@ -10417,6 +11646,61 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverrideRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverrideResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sets an account level monthly spend limit override for sending MMS messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
The new monthly limit to enforce on text messages.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverrideResult": { + "type": "structure", + "members": { + "MonthlyLimit": { + "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "traits": { + "smithy.api#documentation": "The current monthly limit to enforce on sending text messages.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride": { "type": "operation", "input": { @@ -10608,6 +11892,10 @@ { "value": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", "name": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT" + }, + { + "value": "MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT", + "name": "MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT" } ] } @@ -11512,6 +12800,195 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update the setting for an existing protect configuration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSetRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSetResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "NumberCapability": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapability", + "traits": { + "smithy.api#documentation": "The number capability to apply the CountryRuleSetUpdates updates to.
", + "smithy.api#required": {} + } + }, + "CountryRuleSetUpdates": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet", + "traits": { + "smithy.api#documentation": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSetResult": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the protect configuration.
", + "smithy.api#required": {} + } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "NumberCapability": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapability", + "traits": { + "smithy.api#documentation": "The number capability that was updated
", + "smithy.api#required": {} + } + }, + "CountryRuleSet": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet", + "traits": { + "smithy.api#documentation": "An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationResult": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the protect configuration.
", + "smithy.api#required": {} + } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "The unique identifier for the protect configuration.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the protect configuration was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + }, + "AccountDefault": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if the protect configuration is set as your account default protect configuration.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#UpdateSenderId": { "type": "operation", "input": { @@ -11746,6 +13223,10 @@ "value": "MAXIMUM_SIZE_EXCEEDED", "name": "MAXIMUM_SIZE_EXCEEDED" }, + { + "value": "MEDIA_TYPE_NOT_SUPPORTED", + "name": "MEDIA_TYPE_NOT_SUPPORTED" + }, { "value": "MISSING_PARAMETER", "name": "MISSING_PARAMETER" diff --git a/codegen/sdk-codegen/aws-models/qbusiness.2023-11-27.json b/codegen/sdk-codegen/aws-models/qbusiness.2023-11-27.json index 4489441c994..a633282693e 100644 --- a/codegen/sdk-codegen/aws-models/qbusiness.2023-11-27.json +++ b/codegen/sdk-codegen/aws-models/qbusiness.2023-11-27.json @@ -1,6 +1,37 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.qbusiness#APISchema": { + "type": "union", + "members": { + "payload": { + "target": "com.amazonaws.qbusiness#Payload", + "traits": { + "smithy.api#documentation": "The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.\n
" + } + }, + "s3": { + "target": "com.amazonaws.qbusiness#S3", + "traits": { + "smithy.api#documentation": "Contains details about the S3 object containing the OpenAPI schema for a custom\n plugin. The schema could be in either JSON or YAML format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the OpenAPI schema for a custom plugin. For more information,\n see custom plugin OpenAPI schemas. You can either include\n the schema directly in the payload field or you can upload it to an S3 bucket and\n specify the S3 bucket location in the s3 field.
Performs an Amazon Q Business plugin action during a non-streaming chat\n conversation.
" } }, + "com.amazonaws.qbusiness#ActionExecutionEvent": { + "type": "structure", + "members": { + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "The identifier of the plugin for which the action is being requested.
", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.qbusiness#ActionExecutionPayload", + "traits": { + "smithy.api#documentation": "A mapping of field names to the field values in input that an end user provides to\n Amazon Q Business requests to perform their plugin action.
", + "smithy.api#required": {} + } + }, + "payloadFieldNameSeparator": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", + "traits": { + "smithy.api#documentation": "A string used to retain information about the hierarchical contexts within a action\n execution event payload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request from an end user signalling an intent to perform an Amazon Q Business plugin\n action during a streaming chat.
" + } + }, "com.amazonaws.qbusiness#ActionExecutionPayload": { "type": "map", "key": { @@ -199,6 +259,56 @@ "smithy.api#documentation": "An output event that Amazon Q Business returns to an user who wants to perform a plugin\n action during a non-streaming chat conversation. It contains information about the\n selected action with a list of possible user input fields, some pre-populated by\n Amazon Q Business.
" } }, + "com.amazonaws.qbusiness#ActionReviewEvent": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "The identifier of the conversation with which the action review event is\n associated.
" + } + }, + "userMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "The identifier of the conversation with which the plugin action is associated.
" + } + }, + "systemMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "The identifier of an Amazon Q Business AI generated associated with the action review\n event.
" + } + }, + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "The identifier of the plugin associated with the action review event.
" + } + }, + "pluginType": { + "target": "com.amazonaws.qbusiness#PluginType", + "traits": { + "smithy.api#documentation": "The type of plugin.
" + } + }, + "payload": { + "target": "com.amazonaws.qbusiness#ActionReviewPayload", + "traits": { + "smithy.api#documentation": "Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to\n perform the requested plugin action.
" + } + }, + "payloadFieldNameSeparator": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", + "traits": { + "smithy.api#documentation": "A string used to retain information about the hierarchical contexts within an action\n review event payload.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An output event that Amazon Q Business returns to an user who wants to perform a plugin\n action during a streaming chat conversation. It contains information about the selected\n action with a list of possible user input fields, some pre-populated by Amazon Q Business.\n
" + } + }, "com.amazonaws.qbusiness#ActionReviewPayload": { "type": "map", "key": { @@ -223,6 +333,12 @@ "smithy.api#documentation": "The display order of fields in a payload.
" } }, + "displayDescription": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "The field level description of each action review input field. This could be an\n explanation of the field. In the Amazon Q Business web experience, these descriptions could\n be used to display as tool tips to help users understand the field.
" + } + }, "type": { "target": "com.amazonaws.qbusiness#ActionPayloadFieldType", "traits": { @@ -241,6 +357,12 @@ "smithy.api#documentation": "Information about the field values that an end user can use to provide to\n Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" } }, + "allowedFormat": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "The expected data format for the action review input field value. For example, in PTO\n request, from and to would be of datetime allowed\n format.
A file directly uploaded into a web experience chat.
" } }, + "com.amazonaws.qbusiness#AttachmentInputEvent": { + "type": "structure", + "members": { + "attachment": { + "target": "com.amazonaws.qbusiness#AttachmentInput" + } + }, + "traits": { + "smithy.api#documentation": "A file input event activated by a end user request to upload files into their web\n experience chat.
" + } + }, "com.amazonaws.qbusiness#AttachmentName": { "type": "string", "traits": { @@ -705,6 +838,93 @@ } } }, + "com.amazonaws.qbusiness#AuthChallengeRequest": { + "type": "structure", + "members": { + "authorizationUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "The URL sent by Amazon Q Business to the third party authentication server to authenticate\n a custom plugin user through an OAuth protocol.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request made by Amazon Q Business to a third paty authentication server to authenticate\n a custom plugin user.
" + } + }, + "com.amazonaws.qbusiness#AuthChallengeRequestEvent": { + "type": "structure", + "members": { + "authorizationUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "The URL sent by Amazon Q Business to a third party authentication server in response to an\n authentication verification event activated by an end user request to use a custom\n plugin.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An authentication verification event activated by an end user request to use a custom\n plugin.
" + } + }, + "com.amazonaws.qbusiness#AuthChallengeResponse": { + "type": "structure", + "members": { + "responseMap": { + "target": "com.amazonaws.qbusiness#AuthorizationResponseMap", + "traits": { + "smithy.api#documentation": "The mapping of key-value pairs in an authentication challenge response.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the authentication information received from a third party\n authentication server in response to an authentication challenge.
" + } + }, + "com.amazonaws.qbusiness#AuthChallengeResponseEvent": { + "type": "structure", + "members": { + "responseMap": { + "target": "com.amazonaws.qbusiness#AuthorizationResponseMap", + "traits": { + "smithy.api#documentation": "The mapping of key-value pairs in an authentication challenge response.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An authentication verification event response by a third party authentication server\n to Amazon Q Business.
" + } + }, + "com.amazonaws.qbusiness#AuthResponseKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#AuthResponseValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.qbusiness#AuthorizationResponseMap": { + "type": "map", + "key": { + "target": "com.amazonaws.qbusiness#AuthResponseKey" + }, + "value": { + "target": "com.amazonaws.qbusiness#AuthResponseValue" + } + }, "com.amazonaws.qbusiness#BasicAuthConfiguration": { "type": "structure", "members": { @@ -988,6 +1208,149 @@ } } }, + "com.amazonaws.qbusiness#Chat": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ChatInput" + }, + "output": { + "target": "com.amazonaws.qbusiness#ChatOutput" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#LicenseNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts or continues a streaming Amazon Q Business conversation.
", + "smithy.api#http": { + "uri": "/applications/{applicationId}/conversations", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#ChatInput": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business\n conversation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#UserId", + "traits": { + "smithy.api#documentation": "The identifier of the user attached to the chat input.
", + "smithy.api#httpQuery": "userId" + } + }, + "userGroups": { + "target": "com.amazonaws.qbusiness#UserGroups", + "traits": { + "smithy.api#documentation": "The groups that a user associated with the chat input belongs to.
", + "smithy.api#httpQuery": "userGroups" + } + }, + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q Business conversation.
", + "smithy.api#httpQuery": "conversationId" + } + }, + "parentMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "The identifier used to associate a user message with a AI generated response.
", + "smithy.api#httpQuery": "parentMessageId" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "A token that you provide to identify the chat input.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "inputStream": { + "target": "com.amazonaws.qbusiness#ChatInputStream", + "traits": { + "smithy.api#documentation": "The streaming input for the Chat API.
A configuration event activated by an end user request to select a specific chat\n mode.
" + } + }, + "textEvent": { + "target": "com.amazonaws.qbusiness#TextInputEvent", + "traits": { + "smithy.api#documentation": "Information about the payload of the ChatInputStream event containing the\n end user message input.
A request by an end user to upload a file during chat.
" + } + }, + "actionExecutionEvent": { + "target": "com.amazonaws.qbusiness#ActionExecutionEvent", + "traits": { + "smithy.api#documentation": "A request from an end user to perform an Amazon Q Business plugin action.
" + } + }, + "endOfInputEvent": { + "target": "com.amazonaws.qbusiness#EndOfInputEvent", + "traits": { + "smithy.api#documentation": "The end of the streaming input for the Chat API.
An authentication verification event response by a third party authentication server\n to Amazon Q Business.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The streaming input for the Chat API.
Configuration information for Amazon Q Business conversation modes.
\nFor more information, see Admin controls and guardrails and Conversation settings.
" } }, + "com.amazonaws.qbusiness#ChatOutput": { + "type": "structure", + "members": { + "outputStream": { + "target": "com.amazonaws.qbusiness#ChatOutputStream", + "traits": { + "smithy.api#documentation": "The streaming output for the Chat API.
Information about the payload of the ChatOutputStream event containing\n the AI-generated message output.
A metadata event for a AI-generated text output message in a Amazon Q Business\n conversation.
" + } + }, + "actionReviewEvent": { + "target": "com.amazonaws.qbusiness#ActionReviewEvent", + "traits": { + "smithy.api#documentation": "A request from Amazon Q Business to the end user for information Amazon Q Business needs to\n successfully complete a requested plugin action.
" + } + }, + "failedAttachmentEvent": { + "target": "com.amazonaws.qbusiness#FailedAttachmentEvent", + "traits": { + "smithy.api#documentation": "A failed file upload event during a web experience chat.
" + } + }, + "authChallengeRequestEvent": { + "target": "com.amazonaws.qbusiness#AuthChallengeRequestEvent", + "traits": { + "smithy.api#documentation": "An authentication verification event activated by an end user request to use a custom\n plugin.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The streaming output for the Chat API.
A request from an end user to perform an Amazon Q Business plugin action.
" } }, + "authChallengeResponse": { + "target": "com.amazonaws.qbusiness#AuthChallengeResponse", + "traits": { + "smithy.api#documentation": "An authentication verification event response by a third party authentication server\n to Amazon Q Business.
" + } + }, "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { @@ -1128,7 +1551,7 @@ "chatMode": { "target": "com.amazonaws.qbusiness#ChatMode", "traits": { - "smithy.api#documentation": "The chat modes available in an Amazon Q Business web experience.
\n\n RETRIEVAL_MODE - The default chat mode for an\n Amazon Q Business application. When this mode is enabled, Amazon Q Business generates\n responses only from data sources connected to an Amazon Q Business\n application.
\n CREATOR_MODE - By selecting this mode, users can choose to\n generate responses only from the LLM knowledge, without consulting connected\n data sources, for a chat request.
\n PLUGIN_MODE - By selecting this mode, users can choose to\n use plugins in chat.
For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.
" + "smithy.api#documentation": "The chat modes available to an Amazon Q Business end user.
\n\n RETRIEVAL_MODE - The default chat mode for an\n Amazon Q Business application. When this mode is enabled, Amazon Q Business generates\n responses only from data sources connected to an Amazon Q Business\n application.
\n CREATOR_MODE - By selecting this mode, users can choose to\n generate responses only from the LLM knowledge, without consulting connected\n data sources, for a chat request.
\n PLUGIN_MODE - By selecting this mode, users can choose to\n use plugins in chat.
For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.
" } }, "chatModeConfiguration": { @@ -1182,6 +1605,12 @@ "smithy.api#documentation": "A request from Amazon Q Business to the end user for information Amazon Q Business needs to\n successfully complete a requested plugin action.
" } }, + "authChallengeRequest": { + "target": "com.amazonaws.qbusiness#AuthChallengeRequest", + "traits": { + "smithy.api#documentation": "An authentication verification event activated by an end user request to use a custom\n plugin.
" + } + }, "sourceAttributions": { "target": "com.amazonaws.qbusiness#SourceAttributions", "traits": { @@ -1208,6 +1637,26 @@ } } }, + "com.amazonaws.qbusiness#ConfigurationEvent": { + "type": "structure", + "members": { + "chatMode": { + "target": "com.amazonaws.qbusiness#ChatMode", + "traits": { + "smithy.api#documentation": "The chat modes available to an Amazon Q Business end user.
\n\n RETRIEVAL_MODE - The default chat mode for an\n Amazon Q Business application. When this mode is enabled, Amazon Q Business generates\n responses only from data sources connected to an Amazon Q Business\n application.
\n CREATOR_MODE - By selecting this mode, users can choose to\n generate responses only from the LLM knowledge, without consulting connected\n data sources, for a chat request.
\n PLUGIN_MODE - By selecting this mode, users can choose to\n use plugins in chat.
For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.
" + } + }, + "chatModeConfiguration": { + "target": "com.amazonaws.qbusiness#ChatModeConfiguration" + }, + "attributeFilter": { + "target": "com.amazonaws.qbusiness#AttributeFilter" + } + }, + "traits": { + "smithy.api#documentation": "A configuration event activated by an end user request to select a specific chat\n mode.
" + } + }, "com.amazonaws.qbusiness#ConflictException": { "type": "structure", "members": { @@ -1429,7 +1878,7 @@ "kms:DescribeKey", "kms:CreateGrant" ], - "smithy.api#documentation": "Creates an Amazon Q Business application.
", + "smithy.api#documentation": "Creates an Amazon Q Business application.
\nThere are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are \n also available in Amazon Q Business Lite. For information on what's included in \n Amazon Q Business Lite and what's included in \n Amazon Q Business Pro, see Amazon Q Business tiers. \n You must use the Amazon Q Business console to assign subscription tiers to users.
\nThe Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon\n CloudWatch logs and metrics.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon\n CloudWatch logs and metrics.
" } }, "identityCenterInstanceArn": { @@ -1727,6 +2175,12 @@ "smithy.api#required": {} } }, + "type": { + "target": "com.amazonaws.qbusiness#IndexType", + "traits": { + "smithy.api#documentation": "The index type that's suitable for your needs. For more information on what's included\n in each type of index or index tier, see Amazon Q Business\n tiers.
" + } + }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { @@ -1810,6 +2264,10 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], "aws.iam#requiredActions": [ "qbusiness:GetPlugin", "qbusiness:TagResource", @@ -1849,17 +2307,22 @@ "smithy.api#required": {} } }, + "authConfiguration": { + "target": "com.amazonaws.qbusiness#PluginAuthConfiguration", + "traits": { + "smithy.api#required": {} + } + }, "serverUrl": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "The source URL used for plugin configuration.
", - "smithy.api#required": {} + "smithy.api#documentation": "The source URL used for plugin configuration.
" } }, - "authConfiguration": { - "target": "com.amazonaws.qbusiness#PluginAuthConfiguration", + "customPluginConfiguration": { + "target": "com.amazonaws.qbusiness#CustomPluginConfiguration", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "Contains configuration for a custom plugin.
" } }, "tags": { @@ -1895,6 +2358,12 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a plugin.
" } + }, + "buildStatus": { + "target": "com.amazonaws.qbusiness#PluginBuildStatus", + "traits": { + "smithy.api#documentation": "The current status of a plugin. A plugin is modified asynchronously.
" + } } }, "traits": { @@ -2267,6 +2736,35 @@ } } }, + "com.amazonaws.qbusiness#CustomPluginConfiguration": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.qbusiness#PluginDescription", + "traits": { + "smithy.api#documentation": "A description for your custom plugin configuration.
", + "smithy.api#required": {} + } + }, + "apiSchemaType": { + "target": "com.amazonaws.qbusiness#APISchemaType", + "traits": { + "smithy.api#documentation": "The type of OpenAPI schema to use.
", + "smithy.api#required": {} + } + }, + "apiSchema": { + "target": "com.amazonaws.qbusiness#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the\n action group or the JSON or YAML-formatted payload defining the schema.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information required to create a custom plugin.
" + } + }, "com.amazonaws.qbusiness#DataSource": { "type": "structure", "members": { @@ -3543,7 +4041,7 @@ "operator": { "target": "com.amazonaws.qbusiness#DocumentEnrichmentConditionOperator", "traits": { - "smithy.api#documentation": "The identifier of the document attribute used for the condition.
\nFor example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.
\nAmazon Kendra currently does not support _document_body as an\n attribute key used for the condition.
The identifier of the document attribute used for the condition.
\nFor example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.
\nAmazon Q Business currently does not support _document_body as an attribute\n key used for the condition.
The name of the document attribute.
" } @@ -3864,6 +4362,16 @@ "smithy.api#pattern": "^\\P{C}*$" } }, + "com.amazonaws.qbusiness#DocumentMetadataConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$" + } + }, "com.amazonaws.qbusiness#DocumentStatus": { "type": "enum", "members": { @@ -3974,6 +4482,13 @@ "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt data indexed by\n Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
" } }, + "com.amazonaws.qbusiness#EndOfInputEvent": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The end of the streaming input for the Chat API.
Amazon Q is in preview release and is subject to change.
\nThis is the Amazon Q Business API Reference. Amazon Q Business is a fully\n managed, generative-AI powered enterprise chat assistant that you can deploy within your\n organization. Amazon Q Business enhances employee productivity by supporting key tasks such\n as question-answering, knowledge discovery, writing email messages, summarizing text,\n drafting document outlines, and brainstorming ideas. Users ask questions of\n Amazon Q Business and get answers that are presented in a conversational manner. For an\n introduction to the service, see the \n Amazon Q Business User Guide\n .
\nFor an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
\nFor information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q Business in the\n Amazon Q Business User Guide.
\nYou can use the following AWS SDKs to access Amazon Q Business APIs:
\n\n AWS SDK for C++\n
\n\n AWS SDK for Go\n
\n\n AWS SDK for Java\n
\n\n AWS SDK for .NET\n
\n\n AWS SDK for Ruby\n
\nThe following resources provide additional information about using the Amazon Q Business\n API:
\n\n \n Setting up for\n Amazon Q Business\n \n
\n\n \n Amazon Q Business CLI Reference\n \n
\n\n \n Amazon Web Services General Reference\n \n
\nThis is the Amazon Q Business API Reference. Amazon Q Business is a fully\n managed, generative-AI powered enterprise chat assistant that you can deploy within your\n organization. Amazon Q Business enhances employee productivity by supporting key tasks such\n as question-answering, knowledge discovery, writing email messages, summarizing text,\n drafting document outlines, and brainstorming ideas. Users ask questions of\n Amazon Q Business and get answers that are presented in a conversational manner. For an\n introduction to the service, see the \n Amazon Q Business User Guide\n .
\nFor an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
\nFor information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q Business in the\n Amazon Q Business User Guide.
\nYou can use the following AWS SDKs to access Amazon Q Business APIs:
\n\n AWS SDK for C++\n
\n\n AWS SDK for Go\n
\n\n AWS SDK for Java\n
\n\n AWS SDK for .NET\n
\n\n AWS SDK for Ruby\n
\nThe following resources provide additional information about using the Amazon Q Business\n API:
\n\n \n Setting up for\n Amazon Q Business\n \n
\n\n \n Amazon Q Business CLI Reference\n \n
\n\n \n Amazon Web Services General Reference\n \n
\nThe identifier of the conversation associated with the failed file upload.
" + } + }, + "userMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "The identifier of the end user chat message associated with the file upload.
" + } + }, + "systemMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "The identifier of the AI-generated message associated with the file upload.
" + } + }, + "attachment": { + "target": "com.amazonaws.qbusiness#AttachmentOutput" + } + }, + "traits": { + "smithy.api#documentation": "A failed file upload during web experience chat.
" + } + }, "com.amazonaws.qbusiness#FailedDocument": { "type": "structure", "members": { @@ -5163,6 +5710,12 @@ "smithy.api#documentation": "The name of the Amazon Q Business index.
" } }, + "type": { + "target": "com.amazonaws.qbusiness#IndexType", + "traits": { + "smithy.api#documentation": "The type of index attached to your Amazon Q Business application.
" + } + }, "indexArn": { "target": "com.amazonaws.qbusiness#IndexArn", "traits": { @@ -5320,6 +5873,18 @@ "authConfiguration": { "target": "com.amazonaws.qbusiness#PluginAuthConfiguration" }, + "customPluginConfiguration": { + "target": "com.amazonaws.qbusiness#CustomPluginConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information required to create a custom plugin.
" + } + }, + "buildStatus": { + "target": "com.amazonaws.qbusiness#PluginBuildStatus", + "traits": { + "smithy.api#documentation": "The current status of a plugin. A plugin is modified asynchronously.
" + } + }, "pluginArn": { "target": "com.amazonaws.qbusiness#PluginArn", "traits": { @@ -5647,13 +6212,13 @@ "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the retriever was created.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business web experience was last created.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the data source connector was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business web experience was last updated.
" } }, "title": { @@ -5689,6 +6254,9 @@ "authenticationConfiguration": { "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", "traits": { + "smithy.api#deprecated": { + "message": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management." + }, "smithy.api#documentation": "The authentication configuration information for your Amazon Q Business web\n experience.
" } }, @@ -5850,7 +6418,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q Business.
\nYou can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on\n the original or raw documents.
\nIf you want to apply advanced alterations on the Amazon Q Business structured documents,\n you must configure your Lambda function using PostExtractionHookConfiguration.
\nYou can only invoke one Lambda function. However, this function can invoke\n other functions it requires.
\nFor more information, see Custom document enrichment.
" + "smithy.api#documentation": "Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q Business.
\nYou can configure your Lambda function using the\n PreExtractionHookConfiguration parameter if you want to apply advanced\n alterations on the original or raw documents.
If you want to apply advanced alterations on the Amazon Q Business structured documents,\n you must configure your Lambda function using\n PostExtractionHookConfiguration.
You can only invoke one Lambda function. However, this function can invoke\n other functions it requires.
\nFor more information, see Custom document enrichment.
" } }, "com.amazonaws.qbusiness#IdcApplicationArn": { @@ -6038,6 +6606,23 @@ } } }, + "com.amazonaws.qbusiness#IndexType": { + "type": "enum", + "members": { + "ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTERPRISE" + } + }, + "STARTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTER" + } + } + } + }, "com.amazonaws.qbusiness#IndexedTextBytes": { "type": "long", "traits": { @@ -7781,6 +8366,44 @@ "target": "com.amazonaws.qbusiness#Message" } }, + "com.amazonaws.qbusiness#MetadataEvent": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "The identifier of the conversation with which the generated metadata is\n associated.
" + } + }, + "userMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "The identifier of an Amazon Q Business end user text input message within the\n conversation.
" + } + }, + "systemMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "The identifier of an Amazon Q Business AI generated message within the\n conversation.
" + } + }, + "sourceAttributions": { + "target": "com.amazonaws.qbusiness#SourceAttributions", + "traits": { + "smithy.api#documentation": "The source documents used to generate the conversation response.
" + } + }, + "finalTextMessage": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "The final text output message generated by the system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A metadata event for a AI-generated text output message in a Amazon Q Business\n conversation, containing associated metadata generated.
" + } + }, "com.amazonaws.qbusiness#MetricValue": { "type": "string", "traits": { @@ -7817,6 +8440,13 @@ } } }, + "com.amazonaws.qbusiness#NoAuthConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Information about invoking a custom plugin without any authentication or authorization\n requirement.
" + } + }, "com.amazonaws.qbusiness#NumberAttributeBoostingConfiguration": { "type": "structure", "members": { @@ -7877,6 +8507,12 @@ "smithy.api#documentation": "Information about the OAuth 2.0 authentication credential/token used to configure a\n plugin.
" } }, + "com.amazonaws.qbusiness#Payload": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.qbusiness#Plugin": { "type": "structure", "members": { @@ -7910,6 +8546,12 @@ "smithy.api#documentation": "The current status of the plugin.
" } }, + "buildStatus": { + "target": "com.amazonaws.qbusiness#PluginBuildStatus", + "traits": { + "smithy.api#documentation": "The status of the plugin.
" + } + }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { @@ -7951,12 +8593,65 @@ "traits": { "smithy.api#documentation": "Information about the OAuth 2.0 authentication credential/token used to configure a\n plugin.
" } + }, + "noAuthConfiguration": { + "target": "com.amazonaws.qbusiness#NoAuthConfiguration", + "traits": { + "smithy.api#documentation": "Information about invoking a custom plugin without any authentication.
" + } } }, "traits": { "smithy.api#documentation": "Authentication configuration information for an Amazon Q Business plugin.
" } }, + "com.amazonaws.qbusiness#PluginBuildStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, "com.amazonaws.qbusiness#PluginConfiguration": { "type": "structure", "members": { @@ -7972,6 +8667,15 @@ "smithy.api#documentation": "Configuration information required to invoke chat in PLUGIN_MODE.
For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.
" } }, + "com.amazonaws.qbusiness#PluginDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, "com.amazonaws.qbusiness#PluginId": { "type": "string", "traits": { @@ -8066,6 +8770,12 @@ "traits": { "smithy.api#enumValue": "ZENDESK" } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } } } }, @@ -8812,6 +9522,23 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.qbusiness#SnippetExcerpt": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.qbusiness#SnippetExcerptText", + "traits": { + "smithy.api#documentation": "The relevant text excerpt from a source that was used to generate a citation text\n segment in an Amazon Q chat response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the relevant text excerpt from a source that was used to generate a citation\n text segment in an Amazon Q Business chat response.
" + } + }, + "com.amazonaws.qbusiness#SnippetExcerptText": { + "type": "string" + }, "com.amazonaws.qbusiness#SourceAttribution": { "type": "structure", "members": { @@ -9323,6 +10050,53 @@ "smithy.api#documentation": "Provides information about text documents in an index.
" } }, + "com.amazonaws.qbusiness#TextInputEvent": { + "type": "structure", + "members": { + "userMessage": { + "target": "com.amazonaws.qbusiness#UserMessage", + "traits": { + "smithy.api#documentation": "A user message in a text message input event.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An input event for a end user message in an Amazon Q Business web experience.
" + } + }, + "com.amazonaws.qbusiness#TextOutputEvent": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "The identifier of the conversation with which the text output event is\n associated.
" + } + }, + "userMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "The identifier of an end user message in a TextOutputEvent.
The identifier of an AI-generated message in a TextOutputEvent.
An AI-generated message in a TextOutputEvent.
An output event for an AI-generated response in an Amazon Q Business web\n experience.
" + } + }, "com.amazonaws.qbusiness#TextSegment": { "type": "structure", "members": { @@ -9337,6 +10111,12 @@ "traits": { "smithy.api#documentation": "The zero-based location in the response string where the source attribution\n ends.
" } + }, + "snippetExcerpt": { + "target": "com.amazonaws.qbusiness#SnippetExcerpt", + "traits": { + "smithy.api#documentation": "The relevant text excerpt from a source that was used to generate a citation text\n segment in an Amazon Q Business chat response.
" + } } }, "traits": { @@ -9562,6 +10342,12 @@ "smithy.api#required": {} } }, + "identityCenterInstanceArn": { + "target": "com.amazonaws.qbusiness#InstanceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either\n creating for—or connecting to—your Amazon Q Business application.
" + } + }, "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { @@ -10000,6 +10786,12 @@ "smithy.api#documentation": "The source URL used for plugin configuration.
" } }, + "customPluginConfiguration": { + "target": "com.amazonaws.qbusiness#CustomPluginConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for a custom plugin.
" + } + }, "authConfiguration": { "target": "com.amazonaws.qbusiness#PluginAuthConfiguration", "traits": { @@ -10273,9 +11065,18 @@ "smithy.api#required": {} } }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business\n web experience and required resources.
" + } + }, "authenticationConfiguration": { "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", "traits": { + "smithy.api#deprecated": { + "message": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management." + }, "smithy.api#documentation": "The authentication configuration of the Amazon Q Business web experience.
" } }, diff --git a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json index 2b4cd4fca57..63489f660e3 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json @@ -866,19 +866,40 @@ "traits": { "smithy.api#documentation": "The Q search bar that you want to use for anonymous user embedding.
" } + }, + "GenerativeQnA": { + "target": "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "The Generative Q&A experience that you want to use for anonymous user embedding.
" + } } }, "traits": { "smithy.api#documentation": "The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.
" } }, + "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.
\nThe Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.
The settings that you want to use for the Generative Q&A experience.
" + } + }, "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration": { "type": "structure", "members": { "InitialTopicId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.
\nThe Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.
\nThe Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.
The edition of Amazon QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.
If you choose ENTERPRISE_AND_Q, the following parameters are\n required:
\n FirstName\n
\n LastName\n
\n EmailAddress\n
\n ContactNumber\n
The edition of Amazon QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.
If you choose ENTERPRISE_AND_Q, the following parameters are\n required:
\n FirstName\n
\n LastName\n
\n EmailAddress\n
\n ContactNumber\n
The admin group associated with your Active Directory or IAM Identity Center account. This field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + "smithy.api#documentation": "The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" } }, "AuthorGroup": { @@ -6672,6 +6692,24 @@ "smithy.api#documentation": "The reader group associated with your Active Directory or IAM Identity Center account.
\nFor more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" } }, + "AdminProGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + } + }, + "AuthorProGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "The author pro group associated with your Active Directory or IAM Identity Center account.
\nFor more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + } + }, + "ReaderProGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "The reader pro group associated with your Active Directory or IAM Identity Center account.
\nFor more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + } + }, "FirstName": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -23846,6 +23884,26 @@ "smithy.api#documentation": "The options that determine the presentation of the arc of a GaugeChartVisual.
The foreground color configuration of a GaugeChartVisual.
The background color configuration of a GaugeChartVisual.
The color configuration of a GaugeChartVisual.
The visual palette configuration of a GaugeChartVisual.
The color configuration of a GaugeChartVisual.
The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
", + "smithy.api#documentation": "The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.
", "smithy.api#required": {} } }, @@ -24289,7 +24353,7 @@ "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.
", + "smithy.api#documentation": "The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.
", "smithy.api#required": {} } }, @@ -35133,7 +35197,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 100 + "max": 500 } } }, @@ -36145,6 +36209,23 @@ } } }, + "com.amazonaws.quicksight#PurchaseMode": { + "type": "enum", + "members": { + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + }, + "AUTO_PURCHASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_PURCHASE" + } + } + } + }, "com.amazonaws.quicksight#PutDataSetRefreshProperties": { "type": "operation", "input": { @@ -36775,6 +36856,9 @@ { "target": "com.amazonaws.quicksight#UpdateRoleCustomPermission" }, + { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration" + }, { "target": "com.amazonaws.quicksight#UpdateTemplate" }, @@ -38636,7 +38720,7 @@ "IdentityType": { "target": "com.amazonaws.quicksight#IdentityType", "traits": { - "smithy.api#documentation": "Amazon QuickSight supports several ways of managing the identity of users. This\n\t\t\tparameter accepts two values:
\n\n IAM: A user whose identity maps to an existing IAM user or role.\n\t\t\t\t
\n QUICKSIGHT: A user whose identity is owned and managed internally by\n\t\t\t\t\tAmazon QuickSight.
The identity type that your Amazon QuickSight account uses to manage the identity of users.
", "smithy.api#required": {} } }, @@ -38691,7 +38775,7 @@ "CustomPermissionsName": { "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#documentation": "(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nTo add custom permissions to an existing user, use \n UpdateUser\n instead.
A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).
\nThis feature is available only to Amazon QuickSight Enterprise edition subscriptions.
" + "smithy.api#documentation": "(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nTo add custom permissions to an existing user, use \n UpdateUser\n instead.
A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).
\nThis feature is available only to Amazon QuickSight Enterprise edition subscriptions.
" } }, "ExternalLoginFederationProviderType": { @@ -38853,19 +38937,39 @@ "traits": { "smithy.api#documentation": "The type of embedding experience. In this case, Amazon QuickSight visuals.
" } + }, + "GenerativeQnA": { + "target": "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "The configuration details for embedding the Generative Q&A experience.
\nFor more information about embedding the Generative Q&A experience, see Embedding Overview in\n the Amazon QuickSight User Guide.
" + } } }, "traits": { "smithy.api#documentation": "The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.
\nExactly one of the experience configurations is required. You can choose\n Dashboard or QuickSightConsole. You cannot choose more\n than one experience configuration.
The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.
\nIf you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that provides information about the configuration of a Generative Q&A experience.
" + } + }, "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration": { "type": "structure", "members": { "InitialTopicId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the Q topic that you want to make the starting topic in the Q search bar.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.
\nIf you don't specify an initial topic, a list of all shared topics is shown in the Q bar\n for your readers. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the available ones in the list.
" + "smithy.api#documentation": "The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the list of available topics.
If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
" } } }, @@ -39470,6 +39574,24 @@ "traits": { "smithy.api#enumValue": "READER" } + }, + "ADMIN_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN_PRO" + } + }, + "AUTHOR_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR_PRO" + } + }, + "READER_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER_PRO" + } } } }, @@ -41456,7 +41578,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 10 + "max": 2000 } } }, @@ -44182,7 +44304,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 100 + "max": 500 } } }, @@ -47476,6 +47598,12 @@ "traits": { "smithy.api#documentation": "The name of the topic.
" } + }, + "UserExperienceVersion": { + "target": "com.amazonaws.quicksight#TopicUserExperienceVersion", + "traits": { + "smithy.api#documentation": "The user experience version of the topic.
" + } } }, "traits": { @@ -50865,6 +50993,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the SPICE capacity configuration for a Amazon QuickSight account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/spice-capacity-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PurchaseMode": { + "target": "com.amazonaws.quicksight#PurchaseMode", + "traits": { + "smithy.api#documentation": "Determines how SPICE capacity can be purchased. The following options are available.
\n\n MANUAL: SPICE capacity can only be purchased manually.
\n AUTO_PURCHASE: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.
The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateTemplate": { "type": "operation", "input": { @@ -52018,7 +52225,7 @@ "Role": { "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:
\n\n READER: A user who has read-only access to dashboards.
\n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.
\n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.
The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.
", + "smithy.api#documentation": "The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:
\n\n READER: A user who has read-only access to dashboards.
\n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.
\n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.
\n READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.
\n AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
\n ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.
", "smithy.api#required": {} } }, @@ -52296,7 +52503,7 @@ "Role": { "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "The Amazon QuickSight role for the user. The user role can be one of the\n following:.
\n\n READER: A user who has read-only access to dashboards.
\n AUTHOR: A user who can create data sources, datasets, analyses,\n and dashboards.
\n ADMIN: A user who is an author, who can also manage Amazon\n Amazon QuickSight settings.
\n RESTRICTED_READER: This role isn't currently available for\n use.
\n RESTRICTED_AUTHOR: This role isn't currently available for\n use.
The Amazon QuickSight role for the user. The user role can be one of the\n following:.
\n\n READER: A user who has read-only access to dashboards.
\n AUTHOR: A user who can create data sources, datasets, analyses,\n and dashboards.
\n ADMIN: A user who is an author, who can also manage Amazon\n Amazon QuickSight settings.
\n READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.
\n AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
\n ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
\n RESTRICTED_READER: This role isn't currently available for\n use.
\n RESTRICTED_AUTHOR: This role isn't currently available for\n use.
The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.
" + "smithy.api#documentation": "The time zone of the DB instance. \n The time zone parameter is currently supported only by RDS for Db2 and\n RDS for SQL Server.
" } }, "EnableIAMDatabaseAuthentication": { @@ -8857,6 +8857,12 @@ "smithy.api#documentation": "JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). \n RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, \n and UNIX/Linux user and group using the installation parameters. For more information, \n see JSON fields in the CEV manifest in the Amazon RDS User Guide.\n
" } }, + "SupportsLimitlessDatabase": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the DB engine version supports Aurora Limitless Database.
" + } + }, "SupportsCertificateRotationWithoutRestart": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -9222,7 +9228,7 @@ "Timezone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.
The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n RDS for Db2 and RDS for SQL Server DB instances \n that were created with a time zone specified.
The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.\n For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.
The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.\n For example, arn:aws:rds:us-east-1:12345667890:db:my-orcl-db.
The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.
\nChanging the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.
This parameter doesn't apply to RDS Custom DB instances.
\nConstraints:
\nIf supplied, must match existing DB subnet group.
\nExample: mydbsubnetgroup\n
The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.
\nChanging the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.
This setting doesn't apply to RDS Custom DB instances.
\nConstraints:
\nIf supplied, must match existing DB subnet group.
\nExample: mydbsubnetgroup\n
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.
" + "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.
\nThis setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. \n For more information, see ModifyDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
" } }, + "SupportsLimitlessDatabase": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "Indicates whether the DB engine version supports Aurora Limitless Database.
" + } + }, "SupportsLocalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { diff --git a/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json b/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json index ad0d218df9a..bf66f50b8c0 100644 --- a/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json +++ b/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json @@ -77,7 +77,7 @@ "parameterKey": { "target": "com.amazonaws.redshiftserverless#ParameterKey", "traits": { - "smithy.api#documentation": "The key of the parameter. The\n options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,\n query_group, search_path, require_ssl, and query monitoring metrics that let \n you define performance boundaries. For more information about query monitoring rules and available metrics, see \n Query monitoring metrics for Amazon Redshift Serverless.
The key of the parameter. The\n options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,\n query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let \n you define performance boundaries. For more information about query monitoring rules and available metrics, see \n Query monitoring metrics for Amazon Redshift Serverless.
An array of parameters to set for advanced control over a database. The\n options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,\n query_group, search_path, require_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see \n \n Query monitoring metrics for Amazon Redshift Serverless.
An array of parameters to set for advanced control over a database. The\n options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,\n query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see \n \n Query monitoring metrics for Amazon Redshift Serverless.
All of the returned scheduled action objects.
" + "smithy.api#documentation": "All of the returned scheduled action association objects.
" } } }, @@ -5086,6 +5086,26 @@ "smithy.api#documentation": "The schedule of when Amazon Redshift Serverless should run the scheduled action.
" } }, + "com.amazonaws.redshiftserverless#ScheduledActionAssociation": { + "type": "structure", + "members": { + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "Name of associated Amazon Redshift Serverless namespace.
" + } + }, + "scheduledActionName": { + "target": "com.amazonaws.redshiftserverless#ScheduledActionName", + "traits": { + "smithy.api#documentation": "Name of associated scheduled action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains names of objects associated with a scheduled action.
" + } + }, "com.amazonaws.redshiftserverless#ScheduledActionName": { "type": "string", "traits": { @@ -5190,7 +5210,7 @@ "com.amazonaws.redshiftserverless#ScheduledActionsList": { "type": "list", "member": { - "target": "com.amazonaws.redshiftserverless#ScheduledActionName" + "target": "com.amazonaws.redshiftserverless#ScheduledActionAssociation" } }, "com.amazonaws.redshiftserverless#SecurityGroupId": { @@ -6468,7 +6488,7 @@ "configParameters": { "target": "com.amazonaws.redshiftserverless#ConfigParameterList", "traits": { - "smithy.api#documentation": "An array of parameters to set for advanced control over a database. The\n options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,\n query_group, search_path, require_ssl, and query monitoring metrics that let you \n define performance boundaries. For more information about query monitoring rules and available metrics, see \n \n Query monitoring metrics for Amazon Redshift Serverless.
An array of parameters to set for advanced control over a database. The\n options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,\n query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you \n define performance boundaries. For more information about query monitoring rules and available metrics, see \n \n Query monitoring metrics for Amazon Redshift Serverless.
An array of parameters to set for advanced control over a database. The\n options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,\n query_group, search_path, require_ssl, and query monitoring metrics that let you define performance boundaries. \n For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
An array of parameters to set for advanced control over a database. The\n options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,\n query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. \n For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
A value that specifies whether the workgroup \n can be accessible from a public network
" + "smithy.api#documentation": "A value that specifies whether the workgroup can be accessible from a public network.
" } }, "creationDate": { diff --git a/codegen/sdk-codegen/aws-models/route53-recovery-readiness.2019-12-02.json b/codegen/sdk-codegen/aws-models/route53-recovery-readiness.2019-12-02.json index e1f506e5f4e..891399271ca 100644 --- a/codegen/sdk-codegen/aws-models/route53-recovery-readiness.2019-12-02.json +++ b/codegen/sdk-codegen/aws-models/route53-recovery-readiness.2019-12-02.json @@ -2845,7 +2845,7 @@ "sdkId": "Route53 Recovery Readiness", "arnNamespace": "route53-recovery-readiness", "cloudFormationName": "Route53RecoveryReadiness", - "cloudTrailEventSource": "route53recoveryreadiness.amazonaws.com", + "cloudTrailEventSource": "route53-recovery-readiness.amazonaws.com", "endpointPrefix": "route53-recovery-readiness" }, "aws.auth#sigv4": { diff --git a/codegen/sdk-codegen/aws-models/route53resolver.2018-04-01.json b/codegen/sdk-codegen/aws-models/route53resolver.2018-04-01.json index f8ae5ce7185..8d56c9b1a0a 100644 --- a/codegen/sdk-codegen/aws-models/route53resolver.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/route53resolver.2018-04-01.json @@ -37,7 +37,7 @@ } }, "traits": { - "smithy.api#documentation": "The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
", + "smithy.api#documentation": "The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
\nThis error can also be thrown when a customer has reached the 5120 character limit for a\n\t\t\tresource policy for CloudWatch Logs.
", "smithy.api#error": "client" } }, @@ -757,10 +757,16 @@ "smithy.api#required": {} } }, + "FirewallDomainRedirectionAction": { + "target": "com.amazonaws.route53resolver#FirewallDomainRedirectionAction", + "traits": { + "smithy.api#documentation": "\n\t\t\tHow you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS. \n\t\t
\n\n Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be \n\t\t\tadded to the allow domain list.
\n Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to \n\t\tthe domain alloww list.
\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t
\n\n\t\t\t\tA: Returns an IPv4 address.
\nAAAA: Returns an Ipv6 address.
\nCAA: Restricts CAs that can create SSL/TLS certifications for the domain.
\nCNAME: Returns another domain name.
\nDS: Record that identifies the DNSSEC signing key of a delegated zone.
\nMX: Specifies mail servers.
\nNAPTR: Regular-expression-based rewriting of domain names.
\nNS: Authoritative name servers.
\nPTR: Maps an IP address to a domain name.
\nSOA: Start of authority record for the zone.
\nSPF: Lists the servers authorized to send emails from a domain.
\nSRV: Application specific values that identify servers.
\nTXT: Verifies email senders and application-specific values.
\n\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t
\n\n\t\t\t\tA: Returns an IPv4 address.
\nAAAA: Returns an Ipv6 address.
\nCAA: Restricts CAs that can create SSL/TLS certifications for the domain.
\nCNAME: Returns another domain name.
\nDS: Record that identifies the DNSSEC signing key of a delegated zone.
\nMX: Specifies mail servers.
\nNAPTR: Regular-expression-based rewriting of domain names.
\nNS: Authoritative name servers.
\nPTR: Maps an IP address to a domain name.
\nSOA: Start of authority record for the zone.
\nSPF: Lists the servers authorized to send emails from a domain.
\nSRV: Application specific values that identify servers.
\nTXT: Verifies email senders and application-specific values.
\nA query type you define by using the DNS type ID, for example 28 for AAAA. The values must be\n\t\t\t\tdefined as TYPENUMBER, where the\n\t\t\t\tNUMBER can be 1-65334, for\n\t\t\t\texample, TYPE28. For more information, see \n\t\t\t\tList of DNS record types.
\nThe ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify \n\t\t\tmust include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). \n\t\t\tInbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port \n\t\t\tthat you're using for DNS queries on your network.
", + "smithy.api#documentation": "The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify \n\t\t\tmust include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). \n\t\t\tInbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port \n\t\t\tthat you're using for DNS queries on your network.
\nSome security group rules will cause your connection to be tracked. For outbound resolver endpoint, it can potentially impact the \n\t\t\tmaximum queries per second from outbound endpoint to your target name server. For inbound resolver endpoint, it can bring down the overall maximum queries per second per IP address to as low as 1500. \n\t\t\tTo avoid connection tracking caused by security group, see \n\t\t\tUntracked connections.
", "smithy.api#required": {} } }, @@ -1369,7 +1375,7 @@ "Qtype": { "target": "com.amazonaws.route53resolver#Qtype", "traits": { - "smithy.api#documentation": "\n\t\t\tThe DNS query type that the rule you are deleting evaluates. Allowed values are;\n\t\t
\n\n\t\t\t\tA: Returns an IPv4 address.
\nAAAA: Returns an Ipv6 address.
\nCAA: Restricts CAs that can create SSL/TLS certifications for the domain.
\nCNAME: Returns another domain name.
\nDS: Record that identifies the DNSSEC signing key of a delegated zone.
\nMX: Specifies mail servers.
\nNAPTR: Regular-expression-based rewriting of domain names.
\nNS: Authoritative name servers.
\nPTR: Maps an IP address to a domain name.
\nSOA: Start of authority record for the zone.
\nSPF: Lists the servers authorized to send emails from a domain.
\nSRV: Application specific values that identify servers.
\nTXT: Verifies email senders and application-specific values.
\n\n\t\t\tThe DNS query type that the rule you are deleting evaluates. Allowed values are;\n\t\t
\n\n\t\t\t\tA: Returns an IPv4 address.
\nAAAA: Returns an Ipv6 address.
\nCAA: Restricts CAs that can create SSL/TLS certifications for the domain.
\nCNAME: Returns another domain name.
\nDS: Record that identifies the DNSSEC signing key of a delegated zone.
\nMX: Specifies mail servers.
\nNAPTR: Regular-expression-based rewriting of domain names.
\nNS: Authoritative name servers.
\nPTR: Maps an IP address to a domain name.
\nSOA: Start of authority record for the zone.
\nSPF: Lists the servers authorized to send emails from a domain.
\nSRV: Application specific values that identify servers.
\nTXT: Verifies email senders and application-specific values.
\nA query type you define by using the DNS type ID, for example 28 for AAAA. The values must be\n\t\t\t\tdefined as TYPENUMBER, where the\n\t\t\t\tNUMBER can be 1-65334, for\n\t\t\t\texample, TYPE28. For more information, see \n\t\t\t\tList of DNS record types.
\nThe date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).
" } }, + "FirewallDomainRedirectionAction": { + "target": "com.amazonaws.route53resolver#FirewallDomainRedirectionAction", + "traits": { + "smithy.api#documentation": "\n\t\t\tHow you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS. \n\t\t
\n\n Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be \n\t\t\tadded to the allow domain list.
\n Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to \n\t\t\tthe domain alloww list.
\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t
\n\n\t\t\t\tA: Returns an IPv4 address.
\nAAAA: Returns an Ipv6 address.
\nCAA: Restricts CAs that can create SSL/TLS certifications for the domain.
\nCNAME: Returns another domain name.
\nDS: Record that identifies the DNSSEC signing key of a delegated zone.
\nMX: Specifies mail servers.
\nNAPTR: Regular-expression-based rewriting of domain names.
\nNS: Authoritative name servers.
\nPTR: Maps an IP address to a domain name.
\nSOA: Start of authority record for the zone.
\nSPF: Lists the servers authorized to send emails from a domain.
\nSRV: Application specific values that identify servers.
\nTXT: Verifies email senders and application-specific values.
\n\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t
\n\n\t\t\t\tA: Returns an IPv4 address.
\nAAAA: Returns an Ipv6 address.
\nCAA: Restricts CAs that can create SSL/TLS certifications for the domain.
\nCNAME: Returns another domain name.
\nDS: Record that identifies the DNSSEC signing key of a delegated zone.
\nMX: Specifies mail servers.
\nNAPTR: Regular-expression-based rewriting of domain names.
\nNS: Authoritative name servers.
\nPTR: Maps an IP address to a domain name.
\nSOA: Start of authority record for the zone.
\nSPF: Lists the servers authorized to send emails from a domain.
\nSRV: Application specific values that identify servers.
\nTXT: Verifies email senders and application-specific values.
\nA query type you define by using the DNS type ID, for example 28 for AAAA. The values must be\n\t\t\t\tdefined as TYPENUMBER, where the\n\t\t\t\tNUMBER can be 1-65334, for\n\t\t\t\texample, TYPE28. For more information, see \n\t\t\t\tList of DNS record types.
\nThe name of the rule.
" } }, + "FirewallDomainRedirectionAction": { + "target": "com.amazonaws.route53resolver#FirewallDomainRedirectionAction", + "traits": { + "smithy.api#documentation": "\n\t\t\tHow you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS. \n\t\t
\n\n Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be \n\t\t\tadded to the allow domain list.
\n Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to \n\t\t\tthe domain alloww list.
\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t
\n\n\t\t\t\tA: Returns an IPv4 address.
\nAAAA: Returns an Ipv6 address.
\nCAA: Restricts CAs that can create SSL/TLS certifications for the domain.
\nCNAME: Returns another domain name.
\nDS: Record that identifies the DNSSEC signing key of a delegated zone.
\nMX: Specifies mail servers.
\nNAPTR: Regular-expression-based rewriting of domain names.
\nNS: Authoritative name servers.
\nPTR: Maps an IP address to a domain name.
\nSOA: Start of authority record for the zone.
\nSPF: Lists the servers authorized to send emails from a domain.
\nSRV: Application specific values that identify servers.
\nTXT: Verifies email senders and application-specific values.
\n\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t
\n\n\t\t\t\tA: Returns an IPv4 address.
\nAAAA: Returns an Ipv6 address.
\nCAA: Restricts CAs that can create SSL/TLS certifications for the domain.
\nCNAME: Returns another domain name.
\nDS: Record that identifies the DNSSEC signing key of a delegated zone.
\nMX: Specifies mail servers.
\nNAPTR: Regular-expression-based rewriting of domain names.
\nNS: Authoritative name servers.
\nPTR: Maps an IP address to a domain name.
\nSOA: Start of authority record for the zone.
\nSPF: Lists the servers authorized to send emails from a domain.
\nSRV: Application specific values that identify servers.
\nTXT: Verifies email senders and application-specific values.
\nA query type you define by using the DNS type ID, for example 28 for AAAA. The values must be\n\t\t\t\tdefined as TYPENUMBER, where the\n\t\t\t\tNUMBER can be 1-65334, for\n\t\t\t\texample, TYPE28. For more information, see \n\t\t\t\tList of DNS record types.
\nContains information about the infrastructure health check configuration for the training job.
" } + }, + "SessionChainingConfig": { + "target": "com.amazonaws.sagemaker#SessionChainingConfig", + "traits": { + "smithy.api#documentation": "Contains information about attribute-based access control (ABAC) for the training\n job.
" + } } }, "traits": { @@ -26020,6 +26026,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#EnableSessionTagChaining": { + "type": "boolean" + }, "com.amazonaws.sagemaker#Endpoint": { "type": "structure", "members": { @@ -50484,6 +50493,54 @@ "smithy.api#enumValue": "ml.g5.48xlarge" } }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, "ML_P4D_24XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -57361,6 +57418,20 @@ "smithy.api#documentation": "Details that you specify to provision a service catalog product. \n For information about service catalog, see What is Amazon Web Services Service Catalog.\n
" } }, + "com.amazonaws.sagemaker#SessionChainingConfig": { + "type": "structure", + "members": { + "EnableSessionTagChaining": { + "target": "com.amazonaws.sagemaker#EnableSessionTagChaining", + "traits": { + "smithy.api#documentation": "Set to True to allow SageMaker to extract session tags from a \n training job creation role and reuse these tags when assuming the training \n job execution role.
Contains information about attribute-based access control (ABAC) for a training job.\n The session chaining configuration uses Amazon Security Token Service (STS) for your\n training job to request temporary, limited-privilege credentials to tenants. For more\n information, see Attribute-based access control (ABAC) for multi-tenancy\n training.
" + } + }, "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds": { "type": "integer", "traits": { @@ -62147,6 +62218,330 @@ "smithy.api#enumValue": "ml.m5.24xlarge" } }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + }, "ML_G4DN_XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -62182,6 +62577,54 @@ "traits": { "smithy.api#enumValue": "ml.g4dn.16xlarge" } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json b/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json index ec1616ef5f6..7a5383ff17e 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json +++ b/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json @@ -214,6 +214,12 @@ "type": "list", "member": { "target": "com.amazonaws.securityhub#AccountDetails" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } } }, "com.amazonaws.securityhub#AccountId": { @@ -33952,7 +33958,7 @@ "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.\n
", + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a \n configuration policy, or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration.\n
\n The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.\n
", + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a \n configuration policy, or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration.\n
\n UpdateFindings is deprecated. Instead of UpdateFindings, use\n BatchUpdateFindings.
Updates the Note and RecordState of the Security Hub-aggregated\n findings that the filter attributes specify. Any member account that can view the finding\n also sees the update to the finding.
\n UpdateFindings is a deprecated operation. Instead of UpdateFindings, use\n the BatchUpdateFindings operation.
Updates the Note and RecordState of the Security Hub-aggregated\n findings that the filter attributes specify. Any member account that can view the finding\n also sees the update to the finding.
Finding updates made with UpdateFindings might not be persisted if the same finding is later updated by the \n finding provider through the BatchImportFindings operation.
Updates a private DNS\n namespace.
", "smithy.api#examples": [ { - "title": "To update a private DNS namespace", - "documentation": "The following example updates the description of a private DNS namespace.", + "title": "To update a public DNS namespace", + "documentation": "The following example updates the description of a public DNS namespace.", "input": { "Id": "ns-bk3aEXAMPLE", "UpdaterRequestId": "", @@ -5148,12 +5148,12 @@ } }, "output": { - "OperationId": "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE" + "OperationId": "ft52xe2koxhoeormaceymagglsdjEXAMPLE" } }, { - "title": "To update a public DNS namespace", - "documentation": "The following example updates the description of a public DNS namespace.", + "title": "To update a private DNS namespace", + "documentation": "The following example updates the description of a private DNS namespace.", "input": { "Id": "ns-bk3aEXAMPLE", "UpdaterRequestId": "", @@ -5162,7 +5162,7 @@ } }, "output": { - "OperationId": "ft52xe2koxhoeormaceymagglsdjEXAMPLE" + "OperationId": "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE" } } ] diff --git a/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json b/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json index 68f31c8d7dc..95bdbe5fa2b 100644 --- a/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json +++ b/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json @@ -460,6 +460,12 @@ "traits": { "smithy.api#documentation": "The ReplacementEmailContent associated with a\n BulkEmailEntry.
The list of message headers associated with the BulkEmailEntry data type.
Headers Not Present in BulkEmailEntry: If a header is specified in\n \n Template\n but not in BulkEmailEntry, the header\n from Template will be added to the outgoing email.
Headers Present in BulkEmailEntry: If a header is specified in\n BulkEmailEntry, it takes precedence over any header of the same name specified\n in \n Template\n :
If the header is also defined within Template,\n the value from BulkEmailEntry will replace the header's\n value in the email.
If the header is not defined within Template,\n it will simply be added to the email as specified in\n BulkEmailEntry.
Lists the contacts present in a specific contact list.
", "smithy.api#http": { - "method": "GET", - "uri": "/v2/email/contact-lists/{ContactListName}/contacts", + "method": "POST", + "uri": "/v2/email/contact-lists/{ContactListName}/contacts/list", "code": 200 }, "smithy.api#paginated": { @@ -6327,15 +6333,13 @@ "PageSize": { "target": "com.amazonaws.sesv2#MaxItems", "traits": { - "smithy.api#documentation": "The number of contacts that may be returned at once, which is dependent on if there\n are more or less contacts than the value of the PageSize. Use this parameter to paginate\n results. If additional contacts exist beyond the specified limit, the\n NextToken element is sent in the response. Use the\n NextToken value in subsequent requests to retrieve additional\n contacts.
The number of contacts that may be returned at once, which is dependent on if there\n are more or less contacts than the value of the PageSize. Use this parameter to paginate\n results. If additional contacts exist beyond the specified limit, the\n NextToken element is sent in the response. Use the\n NextToken value in subsequent requests to retrieve additional\n contacts.
A string token indicating that there might be additional contacts available to be\n listed. Use the token provided in the Response to use in the subsequent call to\n ListContacts with the same parameters to retrieve the next page of contacts.
", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "A string token indicating that there might be additional contacts available to be\n listed. Use the token provided in the Response to use in the subsequent call to\n ListContacts with the same parameters to retrieve the next page of contacts.
" } } }, @@ -6942,8 +6946,8 @@ "traits": { "smithy.api#documentation": "Lists all of the import jobs.
", "smithy.api#http": { - "method": "GET", - "uri": "/v2/email/import-jobs", + "method": "POST", + "uri": "/v2/email/import-jobs/list", "code": 200 }, "smithy.api#paginated": { @@ -6965,15 +6969,13 @@ "NextToken": { "target": "com.amazonaws.sesv2#NextToken", "traits": { - "smithy.api#documentation": "A string token indicating that there might be additional import jobs available to be\n listed. Copy this token to a subsequent call to ListImportJobs with the\n same parameters to retrieve the next page of import jobs.
A string token indicating that there might be additional import jobs available to be\n listed. Copy this token to a subsequent call to ListImportJobs with the\n same parameters to retrieve the next page of import jobs.
Maximum number of import jobs to return at once. Use this parameter to paginate\n results. If additional import jobs exist beyond the specified limit, the\n NextToken element is sent in the response. Use the\n NextToken value in subsequent requests to retrieve additional\n addresses.
Maximum number of import jobs to return at once. Use this parameter to paginate\n results. If additional import jobs exist beyond the specified limit, the\n NextToken element is sent in the response. Use the\n NextToken value in subsequent requests to retrieve additional\n addresses.
Validates the syntax of a state machine definition.
\nYou can validate that a state machine definition is correct without \n creating a state machine resource. Step Functions will implicitly perform the same\n syntax check when you invoke CreateStateMachine and\n UpdateStateMachine. State machine definitions are specified using a\n JSON-based, structured language. For more information on Amazon States Language see Amazon States Language (ASL).
Suggested uses for ValidateStateMachineDefinition:
Integrate automated checks into your code review or Continuous Integration\n (CI) process to validate state machine definitions before starting\n deployments.
\nRun the validation from a Git pre-commit hook to check your state machine\n definitions before committing them to your source repository.
\nErrors found in the state machine definition will be returned in the response as a list of diagnostic elements, rather than raise an exception.
\nA value of ERROR means that you cannot create or update a state machine with this definition.
Identifying code for the diagnostic.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionMessage", + "traits": { + "smithy.api#documentation": "Message describing the diagnostic condition.
", + "smithy.api#required": {} + } + }, + "location": { + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionLocation", + "traits": { + "smithy.api#documentation": "Location of the issue in the state machine, if available.
\nFor errors specific to a field, the location could be in the format: /States/, for example: /States/FailState/ErrorPath.
Describes an error found during validation. Validation errors found in the definition\n return in the response as diagnostic elements, rather\n than raise an exception.
" + } + }, + "com.amazonaws.sfn#ValidateStateMachineDefinitionDiagnosticList": { + "type": "list", + "member": { + "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionDiagnostic" + } + }, + "com.amazonaws.sfn#ValidateStateMachineDefinitionInput": { + "type": "structure", + "members": { + "definition": { + "target": "com.amazonaws.sfn#Definition", + "traits": { + "smithy.api#documentation": "The Amazon States Language definition of the state machine. For more information, see\n Amazon States Language (ASL).
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.sfn#StateMachineType", + "traits": { + "smithy.api#documentation": "The target type of state machine for this definition. The default is STANDARD.
The result value will be OK when no syntax errors are found, or\n FAIL if the workflow definition does not pass verification.
If the result is OK, this field will be empty. When there are errors,\n this field will contain an array of Diagnostic objects\n to help you troubleshoot.
The AWS Signer action permitted as part of cross-account permissions.
", + "smithy.api#documentation": "For cross-account signing. Grant a designated account permission to perform one or more of the following actions. Each action is associated with a specific API's operations. For more information about cross-account signing, see Using cross-account signing with signing profiles in the AWS Signer Developer Guide.
\n\t\tYou can designate the following actions to an account.
\n\t\t\n signer:StartSigningJob. This action isn't supported for container image workflows. For details, see StartSigningJob.
\n signer:SignPayload. This action isn't supported for AWS Lambda workflows. For details, see SignPayload\n
\n signer:GetSigningProfile. For details, see GetSigningProfile.
\n signer:RevokeSignature. For details, see RevokeSignature.
Initiates a signing job to be performed on the code provided. Signing jobs are\n\t\t\tviewable by the ListSigningJobs operation for two years after they are\n\t\t\tperformed. Note the following requirements:
You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the\n\t\t\t\t\t\tAmazon S3 Getting Started Guide.
\n\t\t\tYour S3 source bucket must be version enabled.
\n\t\t\tYou must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to\n\t\t\t\t\twrite your signed code.
\n\t\t\tYou specify the name of the source and destination buckets when calling the\n\t\t\t\t\t\tStartSigningJob operation.
You must also specify a request token that identifies your request to Signer.
\n\t\t\tYou can call the DescribeSigningJob and the ListSigningJobs actions after you call\n\t\t\tStartSigningJob.
For a Java example that shows how to use this action, see StartSigningJob.
", + "smithy.api#documentation": "Initiates a signing job to be performed on the code provided. Signing jobs are\n\t\t\tviewable by the ListSigningJobs operation for two years after they are\n\t\t\tperformed. Note the following requirements:
You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the\n\t\t\t\t\t\tAmazon S3 Getting Started Guide.
\n\t\t\tYour S3 source bucket must be version enabled.
\n\t\t\tYou must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to\n\t\t\t\t\twrite your signed code.
\n\t\t\tYou specify the name of the source and destination buckets when calling the\n\t\t\t\t\t\tStartSigningJob operation.
You must ensure the S3 buckets are from the same Region as the signing profile. Cross-Region signing isn't supported.
\n\t\t\tYou must also specify a request token that identifies your request to Signer.
\n\t\t\tYou can call the DescribeSigningJob and the ListSigningJobs actions after you call\n\t\t\tStartSigningJob.
For a Java example that shows how to use this action, see StartSigningJob.
", "smithy.api#http": { "method": "POST", "uri": "/signing-jobs", diff --git a/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json b/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json index 7fb525c8648..9622ad1d888 100644 --- a/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json +++ b/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json @@ -533,6 +533,9 @@ { "target": "com.amazonaws.ssm#DescribeInstancePatchStatesForPatchGroup" }, + { + "target": "com.amazonaws.ssm#DescribeInstanceProperties" + }, { "target": "com.amazonaws.ssm#DescribeInventoryDeletions" }, @@ -1868,6 +1871,15 @@ } } }, + "com.amazonaws.ssm#Architecture": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#AssociateOpsItemRelatedItem": { "type": "operation", "input": { @@ -6186,7 +6198,7 @@ "Name": { "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "A name for the SSM document.
\nYou can't use the following strings as document name prefixes. These are reserved by Amazon Web Services\n for use as document name prefixes:
\n\n aws\n
\n amazon\n
\n amzn\n
A name for the SSM document.
\nYou can't use the following strings as document name prefixes. These are reserved by Amazon Web Services\n for use as document name prefixes:
\n\n aws\n
\n amazon\n
\n amzn\n
\n AWSEC2\n
\n AWSConfigRemediation\n
\n AWSSupport\n
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window\n until the specified future date.
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window\n until the specified future date.
When using a rate schedule, if you provide a start date that occurs in the past, the\n current date and time are used as the start date.
\nAn API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceProperties", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssm#DescribeInstancePropertiesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ssm#DescribeInstancePropertiesRequest": { + "type": "structure", + "members": { + "InstancePropertyFilterList": { + "target": "com.amazonaws.ssm#InstancePropertyFilterList", + "traits": { + "smithy.api#documentation": "An array of instance property filters.
" + } + }, + "FiltersWithOperator": { + "target": "com.amazonaws.ssm#InstancePropertyStringFilterList", + "traits": { + "smithy.api#documentation": "The request filters to use with the operator.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.ssm#DescribeInstancePropertiesMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of items to return for the call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "The token provided by a previous request to use to return the next set of properties.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssm#DescribeInstancePropertiesResult": { + "type": "structure", + "members": { + "InstanceProperties": { + "target": "com.amazonaws.ssm#InstanceProperties", + "traits": { + "smithy.api#documentation": "Properties for the managed instances.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of properties to return. Use this token to get the next set of\n results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssm#DescribeInventoryDeletions": { "type": "operation", "input": { @@ -13900,7 +14014,7 @@ "Names": { "target": "com.amazonaws.ssm#ParameterNameList", "traits": { - "smithy.api#documentation": "The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For\n parameters shared with you from another account, you must use the full ARNs.
\nTo query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".
For more information about shared parameters, see Working with\n shared parameters in the Amazon Web Services Systems Manager User Guide.
", + "smithy.api#documentation": "The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For\n parameters shared with you from another account, you must use the full ARNs.
\nTo query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".
The results for GetParameters requests are listed in alphabetical order in\n query responses.
For information about shared parameters, see Working with\n shared parameters in the Amazon Web Services Systems Manager User Guide.
", "smithy.api#required": {} } }, @@ -14921,6 +15035,15 @@ } } }, + "com.amazonaws.ssm#InstanceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, "com.amazonaws.ssm#InstancePatchState": { "type": "structure", "members": { @@ -15190,6 +15313,403 @@ } } }, + "com.amazonaws.ssm#InstanceProperties": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#InstanceProperty", + "traits": { + "smithy.api#xmlName": "InstanceProperty" + } + } + }, + "com.amazonaws.ssm#InstanceProperty": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssm#InstanceName", + "traits": { + "smithy.api#documentation": "The value of the EC2 Name tag associated with the node. If a Name tag hasn't been applied to the node, this value is blank.
The ID of the managed node.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.ssm#InstanceType", + "traits": { + "smithy.api#documentation": "The instance type of the managed node. For example, t3.large.
" + } + }, + "InstanceRole": { + "target": "com.amazonaws.ssm#InstanceRole", + "traits": { + "smithy.api#documentation": "The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.
" + } + }, + "KeyName": { + "target": "com.amazonaws.ssm#KeyName", + "traits": { + "smithy.api#documentation": "The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.
" + } + }, + "InstanceState": { + "target": "com.amazonaws.ssm#InstanceState", + "traits": { + "smithy.api#documentation": "The current state of the node.
" + } + }, + "Architecture": { + "target": "com.amazonaws.ssm#Architecture", + "traits": { + "smithy.api#documentation": "The CPU architecture of the node. For example, x86_64.
" + } + }, + "IPAddress": { + "target": "com.amazonaws.ssm#IPAddress", + "traits": { + "smithy.api#documentation": "The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.
" + } + }, + "LaunchTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp for when the node was launched.
" + } + }, + "PingStatus": { + "target": "com.amazonaws.ssm#PingStatus", + "traits": { + "smithy.api#documentation": "Connection status of the SSM Agent on the managed node.
" + } + }, + "LastPingDateTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The date and time when the SSM Agent last pinged the Systems Manager service.
" + } + }, + "AgentVersion": { + "target": "com.amazonaws.ssm#Version", + "traits": { + "smithy.api#documentation": "The version of SSM Agent running on your managed node.
" + } + }, + "PlatformType": { + "target": "com.amazonaws.ssm#PlatformType", + "traits": { + "smithy.api#documentation": "The operating system platform type of the managed node. For example, Windows.
" + } + }, + "PlatformName": { + "target": "com.amazonaws.ssm#PlatformName", + "traits": { + "smithy.api#documentation": "The name of the operating system platform running on your managed node.
" + } + }, + "PlatformVersion": { + "target": "com.amazonaws.ssm#PlatformVersion", + "traits": { + "smithy.api#documentation": "The version of the OS platform running on your managed node.
" + } + }, + "ActivationId": { + "target": "com.amazonaws.ssm#ActivationId", + "traits": { + "smithy.api#documentation": "The activation ID created by Systems Manager when the server or virtual machine (VM) was registered
" + } + }, + "IamRole": { + "target": "com.amazonaws.ssm#IamRole", + "traits": { + "smithy.api#documentation": "The IAM role used in the hybrid activation to register the node with Systems Manager.
" + } + }, + "RegistrationDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The date the node was registered with Systems Manager.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The type of managed node.
" + } + }, + "ComputerName": { + "target": "com.amazonaws.ssm#ComputerName", + "traits": { + "smithy.api#documentation": "The fully qualified host name of the managed node.
" + } + }, + "AssociationStatus": { + "target": "com.amazonaws.ssm#StatusName", + "traits": { + "smithy.api#documentation": "The status of the State Manager association applied to the managed node.
" + } + }, + "LastAssociationExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The date the association was last run.
" + } + }, + "LastSuccessfulAssociationExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The last date the association was successfully run.
" + } + }, + "AssociationOverview": { + "target": "com.amazonaws.ssm#InstanceAggregatedAssociationOverview" + }, + "SourceId": { + "target": "com.amazonaws.ssm#SourceId", + "traits": { + "smithy.api#documentation": "The ID of the source resource.
" + } + }, + "SourceType": { + "target": "com.amazonaws.ssm#SourceType", + "traits": { + "smithy.api#documentation": "The type of the source resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing various properties of a managed node.
" + } + }, + "com.amazonaws.ssm#InstancePropertyFilter": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.ssm#InstancePropertyFilterKey", + "traits": { + "smithy.api#documentation": "The name of the filter.
", + "smithy.api#required": {} + } + }, + "valueSet": { + "target": "com.amazonaws.ssm#InstancePropertyFilterValueSet", + "traits": { + "smithy.api#documentation": "The filter values.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.
" + } + }, + "com.amazonaws.ssm#InstancePropertyFilterKey": { + "type": "enum", + "members": { + "INSTANCE_IDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceIds" + } + }, + "AGENT_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AgentVersion" + } + }, + "PING_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PingStatus" + } + }, + "PLATFORM_TYPES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PlatformTypes" + } + }, + "DOCUMENT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DocumentName" + } + }, + "ACTIVATION_IDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActivationIds" + } + }, + "IAM_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamRole" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceType" + } + }, + "ASSOCIATION_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociationStatus" + } + } + } + }, + "com.amazonaws.ssm#InstancePropertyFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#InstancePropertyFilter", + "traits": { + "smithy.api#xmlName": "InstancePropertyFilter" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.ssm#InstancePropertyFilterOperator": { + "type": "enum", + "members": { + "EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equal" + } + }, + "NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEqual" + } + }, + "BEGIN_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BeginWith" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + } + } + }, + "com.amazonaws.ssm#InstancePropertyFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#pattern": "^.{1,100000}$" + } + }, + "com.amazonaws.ssm#InstancePropertyFilterValueSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#InstancePropertyFilterValue", + "traits": { + "smithy.api#xmlName": "InstancePropertyFilterValue" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.ssm#InstancePropertyStringFilter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ssm#InstancePropertyStringFilterKey", + "traits": { + "smithy.api#documentation": "The filter key name to describe your managed nodes.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.ssm#InstancePropertyFilterValueSet", + "traits": { + "smithy.api#documentation": "The filter key name to describe your managed nodes.
", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.ssm#InstancePropertyFilterOperator", + "traits": { + "smithy.api#documentation": "The operator used by the filter call.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The filters to describe or get information about your managed nodes.
" + } + }, + "com.amazonaws.ssm#InstancePropertyStringFilterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#pattern": "^.{1,100000}$" + } + }, + "com.amazonaws.ssm#InstancePropertyStringFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#InstancePropertyStringFilter", + "traits": { + "smithy.api#xmlName": "InstancePropertyStringFilter" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.ssm#InstanceRole": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, + "com.amazonaws.ssm#InstanceState": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#InstanceTagName": { "type": "string", "traits": { @@ -15199,6 +15719,15 @@ } } }, + "com.amazonaws.ssm#InstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#InstancesCount": { "type": "integer", "traits": { @@ -15615,6 +16144,22 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#InvalidInstancePropertyFilterValue": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ssm#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidInstancePropertyFilterValue", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The specified filter value isn't valid.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.ssm#InvalidInventoryGroupException": { "type": "structure", "members": { @@ -16766,6 +17311,15 @@ "target": "com.amazonaws.ssm#TagKey" } }, + "com.amazonaws.ssm#KeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, "com.amazonaws.ssm#LabelParameterVersion": { "type": "operation", "input": { @@ -23654,6 +24208,15 @@ } } }, + "com.amazonaws.ssm#PlatformName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#PlatformType": { "type": "enum", "members": { @@ -23686,6 +24249,15 @@ } } }, + "com.amazonaws.ssm#PlatformVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + } + } + }, "com.amazonaws.ssm#PoliciesLimitExceededException": { "type": "structure", "members": { @@ -24496,7 +25068,7 @@ "ServiceRoleArn": { "target": "com.amazonaws.ssm#ServiceRole", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a \n maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's \n service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run \n RegisterTaskWithMaintenanceWindow.
For more information, see Using \n service-linked roles for Systems Manager in the in the Amazon Web Services Systems Manager User Guide:
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for\n Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a\n service role ARN, Systems Manager uses a service-linked role in your account. If no\n appropriate service-linked role for Systems Manager exists in your account, it is created when\n you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom\n policy and custom service role for running your maintenance window tasks. The policy\n can be crafted to provide only the permissions needed for your particular\n maintenance window tasks. For more information, see Setting up maintenance windows in the in the\n Amazon Web Services Systems Manager User Guide.
" } }, "TaskType": { @@ -27708,7 +28280,7 @@ } }, "traits": { - "smithy.api#documentation": "An array of search criteria that targets managed nodes using a key-value pair that you\n specify.
\nOne or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nSupported formats include the following.
\n\n Key=InstanceIds,Values=\n
\n Key=tag:\n
\n Key=tag-key,Values=\n
\n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=\n
\n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=\n
\n Automation targets only:\n Key=ResourceGroup;Values=\n
For example:
\n\n Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE\n
\n Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3\n
\n Key=tag-key,Values=Name,Instance-Type,CostCenter\n
\n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=ProductionResourceGroup\n
This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
\n\n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC\n
This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2)\n instances and VPCs in your maintenance window.
\n\n Automation targets only:\n Key=ResourceGroup,Values=MyResourceGroup\n
\n State Manager association targets only:\n Key=InstanceIds,Values=*\n
This example demonstrates how to target all managed instances in the Amazon Web Services Region where\n the association was created.
\nFor more information about how to send commands that target managed nodes using\n Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.
An array of search criteria that targets managed nodes using a key-value pair that you\n specify.
\nOne or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nSupported formats include the following.
\n\n For all Systems Manager capabilities:\n
\n\n Key=tag-key,Values=tag-value-1,tag-value-2\n
\n For Automation and Change Manager:\n
\n\n Key=tag:tag-key,Values=tag-value\n
\n Key=ResourceGroup,Values=resource-group-name\n
\n Key=ParameterValues,Values=value-1,value-2,value-3\n
To target all instances in the Amazon Web Services Region:
\n\n Key=AWS::EC2::Instance,Values=*\n
\n Key=InstanceIds,Values=*\n
\n For Run Command and Maintenance Windows:\n
\n\n Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3\n
\n Key=tag:tag-key,Values=tag-value-1,tag-value-2\n
\n Key=resource-groups:Name,Values=resource-group-name\n
Additionally, Maintenance Windows support targeting resource types:
\n\n Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2\n
\n For State Manager:\n
\n\n Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3\n
\n Key=tag:tag-key,Values=tag-value-1,tag-value-2\n
To target all instances in the Amazon Web Services Region:
\n\n Key=InstanceIds,Values=*\n
For more information about how to send commands that target managed nodes using\n Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window\n until the specified future date.
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window\n until the specified future date.
When using a rate schedule, if you provide a start date that occurs in the past, the\n current date and time are used as the start date.
\nThe Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a \n maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's \n service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run \n RegisterTaskWithMaintenanceWindow.
For more information, see Using \n service-linked roles for Systems Manager in the in the Amazon Web Services Systems Manager User Guide:
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for\n Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a\n service role ARN, Systems Manager uses a service-linked role in your account. If no\n appropriate service-linked role for Systems Manager exists in your account, it is created when\n you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom\n policy and custom service role for running your maintenance window tasks. The policy\n can be crafted to provide only the permissions needed for your particular\n maintenance window tasks. For more information, see Setting up maintenance windows in the in the\n Amazon Web Services Systems Manager User Guide.
" } }, "TaskParameters": { diff --git a/codegen/sdk-codegen/aws-models/support.2013-04-15.json b/codegen/sdk-codegen/aws-models/support.2013-04-15.json index 1904589ac00..b0f5eb9a8eb 100644 --- a/codegen/sdk-codegen/aws-models/support.2013-04-15.json +++ b/codegen/sdk-codegen/aws-models/support.2013-04-15.json @@ -364,6 +364,57 @@ }, "type": "endpoint" }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://support.us-gov-west-1.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "support", + "signingRegion": "us-gov-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -858,6 +909,28 @@ "UseDualStack": false } }, + { + "documentation": "For region aws-us-gov-global with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "support", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://support.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "aws-us-gov-global", + "UseFIPS": true, + "UseDualStack": false + } + }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { @@ -875,7 +948,16 @@ "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://support-fips.us-gov-east-1.amazonaws.com" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "support", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://support.us-gov-west-1.amazonaws.com" } }, "params": { diff --git a/codegen/sdk-codegen/aws-models/timestream-query.2018-11-01.json b/codegen/sdk-codegen/aws-models/timestream-query.2018-11-01.json index 0b3e199f75d..720ffb35606 100644 --- a/codegen/sdk-codegen/aws-models/timestream-query.2018-11-01.json +++ b/codegen/sdk-codegen/aws-models/timestream-query.2018-11-01.json @@ -401,6 +401,62 @@ "smithy.api#input": {} } }, + "com.amazonaws.timestreamquery#DescribeAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#DescribeAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#DescribeAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.
\nYou're charged only for the duration of compute units used for your workloads.
" + } + }, + "com.amazonaws.timestreamquery#DescribeAccountSettingsRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreamquery#DescribeAccountSettingsResponse": { + "type": "structure", + "members": { + "MaxQueryTCU": { + "target": "com.amazonaws.timestreamquery#MaxQueryCapacity", + "traits": { + "smithy.api#documentation": "The maximum number of Timestream compute units (TCUs) the service will use at any point in time to serve your queries.
" + } + }, + "QueryPricingModel": { + "target": "com.amazonaws.timestreamquery#QueryPricingModel", + "traits": { + "smithy.api#documentation": "The pricing model for queries in your account.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.timestreamquery#DescribeEndpoints": { "type": "operation", "input": { @@ -706,6 +762,13 @@ "smithy.api#documentation": "Bytes metered for a single scheduled query run.
" } }, + "CumulativeBytesScanned": { + "target": "com.amazonaws.timestreamquery#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Bytes scanned for a single scheduled query run.
" + } + }, "RecordsIngested": { "target": "com.amazonaws.timestreamquery#Long", "traits": { @@ -733,7 +796,7 @@ } }, "traits": { - "smithy.api#documentation": "\n Timestream was unable to fully process this request because of an internal\n server error.
", + "smithy.api#documentation": "\n The service was unable to fully process this request because of an internal\n server error.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -919,6 +982,9 @@ "smithy.api#default": 0 } }, + "com.amazonaws.timestreamquery#MaxQueryCapacity": { + "type": "integer" + }, "com.amazonaws.timestreamquery#MaxQueryResults": { "type": "integer", "traits": { @@ -1302,6 +1368,23 @@ "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, + "com.amazonaws.timestreamquery#QueryPricingModel": { + "type": "enum", + "members": { + "BYTES_SCANNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTES_SCANNED" + } + }, + "COMPUTE_UNITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPUTE_UNITS" + } + } + } + }, "com.amazonaws.timestreamquery#QueryRequest": { "type": "structure", "members": { @@ -1861,7 +1944,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + "smithy.api#pattern": "^[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+$" } }, "com.amazonaws.timestreamquery#ScheduledQueryRunStatus": { @@ -2335,6 +2418,9 @@ { "target": "com.amazonaws.timestreamquery#DeleteScheduledQuery" }, + { + "target": "com.amazonaws.timestreamquery#DescribeAccountSettings" + }, { "target": "com.amazonaws.timestreamquery#DescribeEndpoints" }, @@ -2362,6 +2448,9 @@ { "target": "com.amazonaws.timestreamquery#UntagResource" }, + { + "target": "com.amazonaws.timestreamquery#UpdateAccountSettings" + }, { "target": "com.amazonaws.timestreamquery#UpdateScheduledQuery" } @@ -3104,6 +3193,79 @@ "smithy.api#output": {} } }, + "com.amazonaws.timestreamquery#UpdateAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#UpdateAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#UpdateAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective.
After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.
\nThe maximum number of compute units the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on.
\nThe maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for maxQueryTCU, see Default quotas.
The pricing model for queries in an account.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreamquery#UpdateAccountSettingsResponse": { + "type": "structure", + "members": { + "MaxQueryTCU": { + "target": "com.amazonaws.timestreamquery#MaxQueryCapacity", + "traits": { + "smithy.api#documentation": "The configured maximum number of compute units the service will use at any point in time to serve your queries.
" + } + }, + "QueryPricingModel": { + "target": "com.amazonaws.timestreamquery#QueryPricingModel", + "traits": { + "smithy.api#documentation": "The pricing model for an account.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.timestreamquery#UpdateScheduledQuery": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json b/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json index 61361b501d7..9446a7bc143 100644 --- a/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json +++ b/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json @@ -141,6 +141,17 @@ } } }, + "com.amazonaws.transcribe#CallAnalyticsFeature": { + "type": "enum", + "members": { + "GENERATIVE_SUMMARIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATIVE_SUMMARIZATION" + } + } + } + }, "com.amazonaws.transcribe#CallAnalyticsJob": { "type": "structure", "members": { @@ -156,6 +167,12 @@ "smithy.api#documentation": "Provides the status of the specified Call Analytics job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
Provides detailed information about a call analytics job, including information about skipped analytics features.
" + } + }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { @@ -236,6 +253,20 @@ "smithy.api#documentation": "Provides detailed information about a Call Analytics job.
\nTo view the job's status, refer to CallAnalyticsJobStatus. If the status\n is COMPLETED, the job is finished. You can find your completed transcript\n at the URI specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.
If you enabled personally identifiable information (PII) redaction, the redacted\n transcript appears at the location specified in\n RedactedTranscriptFileUri.
If you chose to redact the audio in your media file, you can find your redacted media\n file at the location specified in the RedactedMediaFileUri field of your\n response.
Contains information about any skipped analytics features during the analysis of a call analytics job.
\nThis array lists all the analytics features that were skipped, along with their corresponding reason code and message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a call analytics job, including information about skipped analytics features.
" + } + }, "com.amazonaws.transcribe#CallAnalyticsJobName": { "type": "string", "traits": { @@ -373,6 +404,12 @@ "smithy.api#documentation": "Provides the status of your Call Analytics job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
Provides detailed information about a call analytics job, including information about skipped analytics features.
" + } + }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { @@ -384,6 +421,55 @@ "smithy.api#documentation": "Provides detailed information about a specific Call Analytics job.
" } }, + "com.amazonaws.transcribe#CallAnalyticsSkippedFeature": { + "type": "structure", + "members": { + "Feature": { + "target": "com.amazonaws.transcribe#CallAnalyticsFeature", + "traits": { + "smithy.api#documentation": "Indicates the type of analytics feature that was skipped during the analysis of a call analytics job.
" + } + }, + "ReasonCode": { + "target": "com.amazonaws.transcribe#CallAnalyticsSkippedReasonCode", + "traits": { + "smithy.api#documentation": "Provides a code indicating the reason why a specific analytics feature was skipped during the analysis of a call analytics job.
" + } + }, + "Message": { + "target": "com.amazonaws.transcribe#String", + "traits": { + "smithy.api#documentation": "Contains additional information or a message explaining why a specific analytics feature was skipped during the analysis of a call analytics job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a skipped analytics feature during the analysis of a call analytics job.
\nThe Feature field indicates the type of analytics feature that was skipped.
The Message field contains additional information or a message explaining why the analytics feature was skipped.
The ReasonCode field provides a code indicating the reason why the analytics feature was skipped.
Update one or more exclusion status for a list of recommendation resources
", + "smithy.api#examples": [ + { + "title": "Batch updates the exclusion status for a list of recommendation resources", + "input": { + "recommendationResourceExclusions": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", + "isExcluded": true + } + ] + }, + "output": { + "batchUpdateRecommendationResourceExclusionErrors": [ + { + "arn": "arn:aws:trustedadvisor::000000000000:recommendation-resource/55fa4d2e-bbb7-491a-833b-5773e9589578/18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", + "errorCode": "404", + "errorMessage": "Exception that the requested resource has not been found" + } + ] + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/batch-update-recommendation-resource-exclusion", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [] + } + }, + "com.amazonaws.trustedadvisor#BatchUpdateRecommendationResourceExclusionRequest": { + "type": "structure", + "members": { + "recommendationResourceExclusions": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceExclusionList", + "traits": { + "smithy.api#documentation": "A list of recommendation resource ARNs and exclusion status to update
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.trustedadvisor#BatchUpdateRecommendationResourceExclusionResponse": { + "type": "structure", + "members": { + "batchUpdateRecommendationResourceExclusionErrors": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationResourceExclusionErrorList", + "traits": { + "smithy.api#documentation": "A list of recommendation resource ARNs whose exclusion status failed to update, if any
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.trustedadvisor#CheckArn": { "type": "string", "traits": { @@ -216,6 +304,23 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.trustedadvisor#ExclusionStatus": { + "type": "enum", + "members": { + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + }, + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + } + } + }, "com.amazonaws.trustedadvisor#GetOrganizationRecommendation": { "type": "operation", "input": { @@ -264,13 +369,13 @@ "security" ], "resourcesAggregates": { - "errorCount": 150, - "okCount": 500, - "warningCount": 100 + "errorCount": 0, + "okCount": 0, + "warningCount": 0 }, "source": "ta_check", - "status": "ok", - "type": "standard" + "status": "warning", + "type": "priority" } } } @@ -368,7 +473,7 @@ "security" ], "resourcesAggregates": { - "errorCount": 0, + "errorCount": 1, "okCount": 0, "warningCount": 0 }, @@ -472,7 +577,15 @@ ], "description": "Checks security groups for rules that allow unrestricted access to a resource. Unrestricted access increases opportunities for malicious activity (hacking, denial-of-service attacks, loss of data).\nThe exclusion status of the resource
", + "smithy.api#httpQuery": "exclusionStatus" + } + }, "regionCode": { "target": "smithy.api#String", "traits": { @@ -1009,13 +1135,13 @@ "security" ], "resourcesAggregates": { - "errorCount": 150, - "okCount": 500, - "warningCount": 100 + "errorCount": 0, + "okCount": 0, + "warningCount": 0 }, "source": "ta_check", - "status": "ok", - "type": "standard" + "status": "warning", + "type": "priority" }, { "arn": "arn:aws:trustedadvisor:::organization-recommendation/4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", @@ -1030,23 +1156,23 @@ "security" ], "resourcesAggregates": { - "errorCount": 150, - "okCount": 500, - "warningCount": 100 + "errorCount": 0, + "okCount": 0, + "warningCount": 0 }, "source": "ta_check", - "status": "ok", - "type": "standard" + "status": "warning", + "type": "priority" } ], - "nextToken": "AAMA-EFRSURBSGhRVGVBCmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBSEwveUo0WGtzUERDZUEweDdjVXNJUkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVA1Q0tvVHlvaVBMMXBheFJBZ0VRZ0R0M3NSQXhJNVNoNVJGdFpXN2tjc3JRenlDSDFqaHRkbXp6VTYxZkw0V2lKbkhWeTFqZllaY2prNERPd1hUM2lZVjdZdnJpblRjRFNIVHExZz09wONgOWmSmHcQa82lL7tfrIIiz5kwiP348ZRHDFnNtRRBmuyjwEy8nWAjw_ldisYaifLWtlT31JCln5EAe7tt9c5D_pn2gh-m6EIakcQKX61DY-wuxYIKfeu1ibferY2wq_dTEbqXY6OVN-0N84GKe2azBRV9N80PLouIpG-bt9VjsqdTviEFs3eQnEDJnxRGQmgXrJQFTZIqSLDSsC2-niOVkY7HNvWtLT3fHvXUfFDfD5XlMeWL3DBbnD9beij553VbvnbuKj50BcoV2zWqgc8_eFM4xM0Gsc16OajX0Xio6ZdmwOM=" + "nextToken": "The exclusion status of the resource
", + "smithy.api#httpQuery": "exclusionStatus" + } + }, "regionCode": { "target": "smithy.api#String", "traits": { @@ -1473,7 +1609,7 @@ "security" ], "resourcesAggregates": { - "errorCount": 0, + "errorCount": 1, "okCount": 0, "warningCount": 0 }, @@ -1501,22 +1637,22 @@ ], "resourcesAggregates": { "errorCount": 0, - "okCount": 0, - "warningCount": 0 + "okCount": 3, + "warningCount": 6 }, "source": "ta_check", - "status": "ok", + "status": "warning", "type": "standard" } ], - "nextToken": "AAMA-EFRSURBSGhRVGVBMmRTaGNReVg2WmJuREtyc2QxUDBYdktFVDg3dXVCMkM2UHVseVBBR3RUWW1ma3MwY0plS0llWENTZHV0SkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUVSUDNkclhLblpkd3h4MW5BZ0VRZ0RzTFBpOTlzZmppYXJxMjJoMHlRWDV6bkFuRGZna3FOZEpKaWtuUGloUWpFRzFrSnR6eWV2UGVjWFZudEw1RHQ0dkdvQ1RXL2hGeERFNG44QT09NZONpU850LXJxneOHiAMVmAkpDmCUH5-ob34VBXNqkq9y3s54mW4se3VGv6Ds85WwEaW9uEAM3HpLWMLJjw6u3rLFdwzvNsmicgmGvBd_kZVXJ_bo3Oqgo9koXDg5ltCZt8nxhp-6FnU8dyBDdSENAlQ3ldIb6QIyyRCH5185coh7UYIjbtd7Ne-TMgHk2HsLongKnbz1Lq6dfOm3mqHyJHAmrU8Qnbm10X2Ph9ZsolloEw4HiGMdEKL5-DnGRgXp3gZLuOTrAuukHwqpd1-cRZYHxmjaIUFiSuVuSC4QlWDeeiqlPo=" + "nextToken": "The exclusion status of the Recommendation Resource
" + } + }, "accountId": { "target": "com.amazonaws.trustedadvisor#AccountId", "traits": { @@ -2437,6 +2580,41 @@ "smithy.api#pattern": "^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation-resource\\/[\\w-]+\\/[\\w-]+$" } }, + "com.amazonaws.trustedadvisor#RecommendationResourceExclusion": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Recommendation Resource
", + "smithy.api#required": {} + } + }, + "isExcluded": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The exclusion status
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN and corresponding exclusion status
" + } + }, + "com.amazonaws.trustedadvisor#RecommendationResourceExclusionList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceExclusion" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.trustedadvisor#RecommendationResourceSummary": { "type": "structure", "members": { @@ -2490,6 +2668,13 @@ "smithy.api#timestampFormat": "date-time" } }, + "exclusionStatus": { + "target": "com.amazonaws.trustedadvisor#ExclusionStatus", + "traits": { + "smithy.api#default": "included", + "smithy.api#documentation": "The exclusion status of the Recommendation Resource
" + } + }, "recommendationArn": { "target": "com.amazonaws.trustedadvisor#AccountRecommendationArn", "traits": { @@ -2850,6 +3035,9 @@ "type": "service", "version": "2022-09-15", "operations": [ + { + "target": "com.amazonaws.trustedadvisor#BatchUpdateRecommendationResourceExclusion" + }, { "target": "com.amazonaws.trustedadvisor#GetOrganizationRecommendation" }, @@ -3624,7 +3812,7 @@ } ], "traits": { - "smithy.api#documentation": "Update the lifecyle of a Recommendation within an Organization. This API only supports prioritized\n recommendations.\n
", + "smithy.api#documentation": "Update the lifecycle of a Recommendation within an Organization. This API only supports prioritized\n recommendations.\n
", "smithy.api#examples": [ { "title": "Update the lifecycle stage of an AWS Organization's Recommendation that is managed by AWS Trusted Advisor Priority", @@ -3843,6 +4031,38 @@ } } }, + "com.amazonaws.trustedadvisor#UpdateRecommendationResourceExclusionError": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.trustedadvisor#RecommendationResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Recommendation Resource
" + } + }, + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error code
" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message
" + } + } + }, + "traits": { + "smithy.api#documentation": "The error entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN, error code and error message
" + } + }, + "com.amazonaws.trustedadvisor#UpdateRecommendationResourceExclusionErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.trustedadvisor#UpdateRecommendationResourceExclusionError" + } + }, "com.amazonaws.trustedadvisor#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/workspaces-web.2020-07-08.json b/codegen/sdk-codegen/aws-models/workspaces-web.2020-07-08.json index 84cac0f3bc0..15865eb8b10 100644 --- a/codegen/sdk-codegen/aws-models/workspaces-web.2020-07-08.json +++ b/codegen/sdk-codegen/aws-models/workspaces-web.2020-07-08.json @@ -1296,6 +1296,18 @@ "traits": { "smithy.api#documentation": "A JSON string containing Chrome Enterprise policies that will be applied to all\n streaming sessions.
" } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the browser settings.
" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "The additional encryption context of the browser settings.
" + } } }, "traits": { @@ -1551,7 +1563,8 @@ "min": 0, "max": 253 }, - "smithy.api#pattern": "^(\\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$" + "smithy.api#pattern": "^(\\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#CookieName": { @@ -1560,7 +1573,8 @@ "smithy.api#length": { "min": 0, "max": 4096 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#CookiePath": { @@ -1570,7 +1584,8 @@ "min": 0, "max": 2000 }, - "smithy.api#pattern": "^/(\\S)*$" + "smithy.api#pattern": "^/(\\S)*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#CookieSpecification": { @@ -1706,7 +1721,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } } @@ -1797,14 +1812,14 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n token_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n attributes_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n jwks_uri\n if not available from discovery URL specified by\n oidc_issuer key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) \n optional\n
The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n token_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n attributes_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n jwks_uri\n if not available from discovery URL specified by\n oidc_issuer key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) \n optional\n
\n IDPInit (boolean) optional\n
\n RequestSigningAlgorithm (string) optional\n - Only accepts rsa-sha256\n
\n EncryptedResponses (boolean) optional\n
A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -1909,7 +1924,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -2004,7 +2019,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -2099,14 +2114,26 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } }, "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.
The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.
The type and resources of the underlying instance.
" + } + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent sessions for the portal.
" } } }, @@ -2193,7 +2220,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -2274,7 +2301,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -2397,7 +2424,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } }, @@ -4023,7 +4050,7 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n token_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n attributes_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n jwks_uri\n if not available from discovery URL specified by oidc_issuer\n key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout\n optional\n
The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n token_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n attributes_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n jwks_uri\n if not available from discovery URL specified by oidc_issuer\n key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) optional\n
\n IDPInit (boolean) optional\n
\n RequestSigningAlgorithm (string) optional\n - Only accepts rsa-sha256\n
\n EncryptedResponses (boolean) optional\n
The creation date timestamp of the IP access settings.
" } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the IP access settings.
" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "The additional encryption context of the IP access settings.
" + } } }, "traits": { @@ -5205,6 +5263,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspacesweb#MaxConcurrentSessions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5000 + } + } + }, "com.amazonaws.workspacesweb#MaxResults": { "type": "integer", "traits": { @@ -5429,7 +5496,7 @@ "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.
The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.
The ARN of the IP access settings.
" } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the portal.
" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "The additional encryption context of the portal.
" + } + }, + "instanceType": { + "target": "com.amazonaws.workspacesweb#InstanceType", + "traits": { + "smithy.api#documentation": "The type and resources of the underlying instance.
" + } + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent sessions for the portal.
" + } } }, "traits": { @@ -5520,6 +5611,12 @@ }, "additionalEncryptionContext": { "target": "com.amazonaws.workspacesweb#EncryptionContextMap" + }, + "instanceType": { + "target": "com.amazonaws.workspacesweb#InstanceType" + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions" } }, "create": { @@ -5700,7 +5797,7 @@ "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.
The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.
The ARN of the IP access settings.
" } + }, + "instanceType": { + "target": "com.amazonaws.workspacesweb#InstanceType", + "traits": { + "smithy.api#documentation": "The type and resources of the underlying instance.
" + } + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent sessions for the portal.
" + } } }, "traits": { @@ -6008,7 +6117,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -6309,7 +6418,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -6394,13 +6503,13 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "The details of the identity provider. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n token_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n attributes_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n jwks_uri\n if not available from discovery URL specified by\n oidc_issuer key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) \n optional\n
The details of the identity provider. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n token_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n attributes_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n jwks_uri\n if not available from discovery URL specified by\n oidc_issuer key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout (boolean) optional\n
\n IDPInit (boolean) optional\n
\n RequestSigningAlgorithm (string) optional\n - Only accepts rsa-sha256\n
\n EncryptedResponses (boolean) optional\n
A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -6491,7 +6600,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -6582,7 +6691,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -6628,6 +6737,9 @@ { "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.workspacesweb#ThrottlingException" }, @@ -6665,7 +6777,19 @@ "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.
The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.
The type and resources of the underlying instance.
" + } + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent sessions for the portal.
" } } }, @@ -6753,7 +6877,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -6831,7 +6955,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } } @@ -6948,7 +7072,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.
", "smithy.api#idempotencyToken": {} } }, @@ -7147,6 +7271,18 @@ "traits": { "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the user settings.
" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "The additional encryption context of the user settings.
" + } } }, "traits": {