Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
" }, + "CreateDataset":{ + "name":"CreateDataset", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDatasetRequest"}, + "output":{"shape":"CreateDatasetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceInUseException"}, + {"shape":"TooManyTagsException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
" + }, "CreateDocumentClassifier":{ "name":"CreateDocumentClassifier", "http":{ @@ -204,7 +223,29 @@ {"shape":"KmsKeyValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.
A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.
When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.
To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.
To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
" }, "DeleteDocumentClassifier":{ "name":"DeleteDocumentClassifier", @@ -259,6 +300,24 @@ ], "documentation":"Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
" }, + "DeleteFlywheel":{ + "name":"DeleteFlywheel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFlywheelRequest"}, + "output":{"shape":"DeleteFlywheelResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
" + }, "DeleteResourcePolicy":{ "name":"DeleteResourcePolicy", "http":{ @@ -274,6 +333,22 @@ ], "documentation":"Deletes a resource-based policy that is attached to a custom model.
" }, + "DescribeDataset":{ + "name":"DescribeDataset", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDatasetRequest"}, + "output":{"shape":"DescribeDatasetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
" + }, "DescribeDocumentClassificationJob":{ "name":"DescribeDocumentClassificationJob", "http":{ @@ -386,6 +461,38 @@ ], "documentation":"Gets the status and details of an events detection job.
" }, + "DescribeFlywheel":{ + "name":"DescribeFlywheel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFlywheelRequest"}, + "output":{"shape":"DescribeFlywheelResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
" + }, + "DescribeFlywheelIteration":{ + "name":"DescribeFlywheelIteration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFlywheelIterationRequest"}, + "output":{"shape":"DescribeFlywheelIterationResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
" + }, "DescribeKeyPhrasesDetectionJob":{ "name":"DescribeKeyPhrasesDetectionJob", "http":{ @@ -614,6 +721,23 @@ ], "documentation":"Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one.
If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
" }, + "ListDatasets":{ + "name":"ListDatasets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDatasetsRequest"}, + "output":{"shape":"ListDatasetsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"List the datasets that you have configured in this region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
" + }, "ListDocumentClassificationJobs":{ "name":"ListDocumentClassificationJobs", "http":{ @@ -755,6 +879,39 @@ ], "documentation":"Gets a list of the events detection jobs that you have submitted.
" }, + "ListFlywheelIterationHistory":{ + "name":"ListFlywheelIterationHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFlywheelIterationHistoryRequest"}, + "output":{"shape":"ListFlywheelIterationHistoryResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
" + }, + "ListFlywheels":{ + "name":"ListFlywheels", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFlywheelsRequest"}, + "output":{"shape":"ListFlywheelsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets a list of the flywheels that you have created.
" + }, "ListKeyPhrasesDetectionJobs":{ "name":"ListKeyPhrasesDetectionJobs", "http":{ @@ -882,7 +1039,7 @@ {"shape":"TooManyTagsException"}, {"shape":"InternalServerException"} ], - "documentation":"Starts an asynchronous document classification job. Use the operation to track the progress of the job.
" + "documentation":"Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob operation to track the progress of the job.
Starts an asynchronous event detection job for a collection of documents.
" }, + "StartFlywheelIteration":{ + "name":"StartFlywheelIteration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartFlywheelIterationRequest"}, + "output":{"shape":"StartFlywheelIterationResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
" + }, "StartKeyPhrasesDetectionJob":{ "name":"StartKeyPhrasesDetectionJob", "http":{ @@ -1003,7 +1177,7 @@ {"shape":"TooManyTagsException"}, {"shape":"InternalServerException"} ], - "documentation":"Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.
" + "documentation":"Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
" + }, + "UpdateFlywheel":{ + "name":"UpdateFlywheel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFlywheelRequest"}, + "output":{"shape":"UpdateFlywheelResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Update the configuration information for an existing flywheel.
" } }, "shapes":{ @@ -1804,13 +1995,18 @@ "ComprehendArn":{ "type":"string", "max":256, - "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?" + "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?" }, "ComprehendArnName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" }, + "ComprehendDatasetArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, "ComprehendEndpointArn":{ "type":"string", "max":256, @@ -1821,6 +2017,11 @@ "max":40, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" }, + "ComprehendFlywheelArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, "ComprehendModelArn":{ "type":"string", "max":256, @@ -1860,6 +2061,54 @@ } } }, + "CreateDatasetRequest":{ + "type":"structure", + "required":[ + "FlywheelArn", + "DatasetName", + "InputDataConfig" + ], + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.
" + }, + "DatasetName":{ + "shape":"ComprehendArnName", + "documentation":"Name of the dataset.
" + }, + "DatasetType":{ + "shape":"DatasetType", + "documentation":"The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.
" + }, + "Description":{ + "shape":"Description", + "documentation":"Description of the dataset.
" + }, + "InputDataConfig":{ + "shape":"DatasetInputDataConfig", + "documentation":"Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"Tags for the dataset.
" + } + } + }, + "CreateDatasetResponse":{ + "type":"structure", + "members":{ + "DatasetArn":{ + "shape":"ComprehendDatasetArn", + "documentation":"The ARN of the dataset.
" + } + } + }, "CreateDocumentClassifierRequest":{ "type":"structure", "required":[ @@ -1879,11 +2128,11 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" }, "InputDataConfig":{ "shape":"DocumentClassifierInputDataConfig", @@ -1900,7 +2149,7 @@ }, "LanguageCode":{ "shape":"LanguageCode", - "documentation":"The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.
" + "documentation":"The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -1937,7 +2186,6 @@ "type":"structure", "required":[ "EndpointName", - "ModelArn", "DesiredInferenceUnits" ], "members":{ @@ -1960,11 +2208,15 @@ }, "Tags":{ "shape":"TagList", - "documentation":"Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an endpoint to indicate its use by the sales department.
" + "documentation":"Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an endpoint to indicate its use by the sales department.
" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
" + }, + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
" } } }, @@ -1974,6 +2226,10 @@ "EndpointArn":{ "shape":"ComprehendEndpointArn", "documentation":"The Amazon Resource Number (ARN) of the endpoint being created.
" + }, + "ModelArn":{ + "shape":"ComprehendModelArn", + "documentation":"The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
" } } }, @@ -1996,11 +2252,11 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the entity recognizer. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" }, "InputDataConfig":{ "shape":"EntityRecognizerInputDataConfig", @@ -2025,7 +2281,7 @@ }, "ModelKmsKeyId":{ "shape":"KmsKeyId", - "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Name for the flywheel.
" + }, + "ActiveModelArn":{ + "shape":"ComprehendModelArn", + "documentation":"To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.
" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
" + }, + "TaskConfig":{ + "shape":"TaskConfig", + "documentation":"Configuration about the custom classifier associated with the flywheel.
" + }, + "ModelType":{ + "shape":"ModelType", + "documentation":"The model type.
" + }, + "DataLakeS3Uri":{ + "shape":"FlywheelS3Uri", + "documentation":"Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.
" + }, + "DataSecurityConfig":{ + "shape":"DataSecurityConfig", + "documentation":"Data security configurations.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags to associate with this flywheel.
" + } + } + }, + "CreateFlywheelResponse":{ + "type":"structure", + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel.
" + }, + "ActiveModelArn":{ + "shape":"ComprehendModelArn", + "documentation":"The Amazon Resource Number (ARN) of the active model version.
" + } + } + }, "CustomerInputString":{ "type":"string", "min":1, @@ -2053,44 +2369,284 @@ "min":1, "sensitive":true }, - "DeleteDocumentClassifierRequest":{ - "type":"structure", - "required":["DocumentClassifierArn"], - "members":{ - "DocumentClassifierArn":{ - "shape":"DocumentClassifierArn", - "documentation":"The Amazon Resource Name (ARN) that identifies the document classifier.
" - } - } - }, - "DeleteDocumentClassifierResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteEndpointRequest":{ + "DataSecurityConfig":{ "type":"structure", - "required":["EndpointArn"], "members":{ - "EndpointArn":{ - "shape":"ComprehendEndpointArn", - "documentation":"The Amazon Resource Number (ARN) of the endpoint being deleted.
" - } - } + "ModelKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
" + }, + "DataLakeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
" + }, + "VpcConfig":{"shape":"VpcConfig"} + }, + "documentation":"Data security configuration.
" }, - "DeleteEndpointResponse":{ - "type":"structure", - "members":{ - } + "DatasetAugmentedManifestsList":{ + "type":"list", + "member":{"shape":"DatasetAugmentedManifestsListItem"} }, - "DeleteEntityRecognizerRequest":{ + "DatasetAugmentedManifestsListItem":{ "type":"structure", - "required":["EntityRecognizerArn"], + "required":[ + "AttributeNames", + "S3Uri" + ], "members":{ - "EntityRecognizerArn":{ - "shape":"EntityRecognizerArn", - "documentation":"The Amazon Resource Name (ARN) that identifies the entity recognizer.
" - } + "AttributeNames":{ + "shape":"AttributeNamesList", + "documentation":"The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
" + }, + "S3Uri":{ + "shape":"S3Uri", + "documentation":"The Amazon S3 location of the augmented manifest file.
" + }, + "AnnotationDataS3Uri":{ + "shape":"S3Uri", + "documentation":"The S3 prefix to the annotation files that are referred in the augmented manifest file.
" + }, + "SourceDocumentsS3Uri":{ + "shape":"S3Uri", + "documentation":"The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
" + }, + "DocumentType":{ + "shape":"AugmentedManifestsDocumentTypeFormat", + "documentation":"The type of augmented manifest. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
" + }, + "DatasetDataFormat":{ + "type":"string", + "enum":[ + "COMPREHEND_CSV", + "AUGMENTED_MANIFEST" + ] + }, + "DatasetDocumentClassifierInputDataConfig":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
" + } + }, + "documentation":"Describes the dataset input data configuration for a document classifier model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
" + }, + "DatasetEntityRecognizerAnnotations":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
" + } + }, + "documentation":"Describes the annotations associated with a entity recognizer.
" + }, + "DatasetEntityRecognizerDocuments":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"Specifies the Amazon S3 location where the documents for the dataset are located.
" + }, + "InputFormat":{ + "shape":"InputFormat", + "documentation":"Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
" + } + }, + "documentation":"Describes the documents submitted with a dataset for an entity recognizer model.
" + }, + "DatasetEntityRecognizerEntityList":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"Specifies the Amazon S3 location where the entity list is located.
" + } + }, + "documentation":"Describes the dataset entity list for an entity recognizer model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
" + }, + "DatasetEntityRecognizerInputDataConfig":{ + "type":"structure", + "required":["Documents"], + "members":{ + "Annotations":{ + "shape":"DatasetEntityRecognizerAnnotations", + "documentation":"The S3 location of the annotation documents for your custom entity recognizer.
" + }, + "Documents":{ + "shape":"DatasetEntityRecognizerDocuments", + "documentation":"The format and location of the training documents for your custom entity recognizer.
" + }, + "EntityList":{ + "shape":"DatasetEntityRecognizerEntityList", + "documentation":"The S3 location of the entity list for your custom entity recognizer.
" + } + }, + "documentation":"Specifies the format and location of the input data. You must provide either the Annotations parameter or the EntityList parameter.
Filter the datasets based on the dataset status.
" + }, + "DatasetType":{ + "shape":"DatasetType", + "documentation":"Filter the datasets based on the dataset type.
" + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"Filter the datasets to include datasets created after the specified time.
" + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"Filter the datasets to include datasets created before the specified time.
" + } + }, + "documentation":"Filter the datasets based on creation time or dataset status.
" + }, + "DatasetInputDataConfig":{ + "type":"structure", + "members":{ + "AugmentedManifests":{ + "shape":"DatasetAugmentedManifestsList", + "documentation":"A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
" + }, + "DataFormat":{ + "shape":"DatasetDataFormat", + "documentation":" COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.
AUGMENTED_MANIFEST: The data format
The input properties for training a document classifier model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
" + }, + "EntityRecognizerInputDataConfig":{ + "shape":"DatasetEntityRecognizerInputDataConfig", + "documentation":"The input properties for training an entity recognizer model.
" + } + }, + "documentation":"Specifies the format and location of the input data for the dataset.
" + }, + "DatasetProperties":{ + "type":"structure", + "members":{ + "DatasetArn":{ + "shape":"ComprehendDatasetArn", + "documentation":"The ARN of the dataset.
" + }, + "DatasetName":{ + "shape":"ComprehendArnName", + "documentation":"The name of the dataset.
" + }, + "DatasetType":{ + "shape":"DatasetType", + "documentation":"The dataset type (training data or test data).
" + }, + "DatasetS3Uri":{ + "shape":"S3Uri", + "documentation":"The S3 URI where the dataset is stored.
" + }, + "Description":{ + "shape":"Description", + "documentation":"Description of the dataset.
" + }, + "Status":{ + "shape":"DatasetStatus", + "documentation":"The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
A description of the status of the dataset.
" + }, + "NumberOfDocuments":{ + "shape":"NumberOfDocuments", + "documentation":"The number of documents in the dataset.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"Creation time of the dataset.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"Time when the data from the dataset becomes available in the data lake.
" + } + }, + "documentation":"Properties associated with the dataset.
" + }, + "DatasetPropertiesList":{ + "type":"list", + "member":{"shape":"DatasetProperties"} + }, + "DatasetStatus":{ + "type":"string", + "enum":[ + "CREATING", + "COMPLETED", + "FAILED" + ] + }, + "DatasetType":{ + "type":"string", + "enum":[ + "TRAIN", + "TEST" + ] + }, + "DeleteDocumentClassifierRequest":{ + "type":"structure", + "required":["DocumentClassifierArn"], + "members":{ + "DocumentClassifierArn":{ + "shape":"DocumentClassifierArn", + "documentation":"The Amazon Resource Name (ARN) that identifies the document classifier.
" + } + } + }, + "DeleteDocumentClassifierResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteEndpointRequest":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"ComprehendEndpointArn", + "documentation":"The Amazon Resource Number (ARN) of the endpoint being deleted.
" + } + } + }, + "DeleteEndpointResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteEntityRecognizerRequest":{ + "type":"structure", + "required":["EntityRecognizerArn"], + "members":{ + "EntityRecognizerArn":{ + "shape":"EntityRecognizerArn", + "documentation":"The Amazon Resource Name (ARN) that identifies the entity recognizer.
" + } } }, "DeleteEntityRecognizerResponse":{ @@ -2098,6 +2654,21 @@ "members":{ } }, + "DeleteFlywheelRequest":{ + "type":"structure", + "required":["FlywheelArn"], + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel to delete.
" + } + } + }, + "DeleteFlywheelResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteResourcePolicyRequest":{ "type":"structure", "required":["ResourceArn"], @@ -2117,13 +2688,32 @@ "members":{ } }, + "DescribeDatasetRequest":{ + "type":"structure", + "required":["DatasetArn"], + "members":{ + "DatasetArn":{ + "shape":"ComprehendDatasetArn", + "documentation":"The ARN of the dataset.
" + } + } + }, + "DescribeDatasetResponse":{ + "type":"structure", + "members":{ + "DatasetProperties":{ + "shape":"DatasetProperties", + "documentation":"The dataset properties.
" + } + } + }, "DescribeDocumentClassificationJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", - "documentation":"The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
" + "documentation":"The identifier that Amazon Comprehend generated for the job. The StartDocumentClassificationJob operation returns this identifier in its response.
The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.
" + "documentation":"The Amazon Resource Name (ARN) that identifies the document classifier. The CreateDocumentClassifier operation returns this identifier in its response.
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
" + "documentation":"The identifier that Amazon Comprehend generated for the job. The StartDominantLanguageDetectionJob operation returns this identifier in its response.
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
" + "documentation":"The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob operation returns this identifier in its response.
The configuration properties of a flywheel iteration.
" + } + } + }, + "DescribeFlywheelRequest":{ + "type":"structure", + "required":["FlywheelArn"], + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel.
" + } + } + }, + "DescribeFlywheelResponse":{ + "type":"structure", + "members":{ + "FlywheelProperties":{ + "shape":"FlywheelProperties", + "documentation":"The flywheel properties.
" + } + } + }, "DescribeKeyPhrasesDetectionJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", - "documentation":"The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
" + "documentation":"The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob operation returns this identifier in its response.
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
" + "documentation":"The identifier that Amazon Comprehend generated for the job. The StartTargetedSentimentDetectionJob operation returns this identifier in its response.
Specifies the class that categorizes the document being analyzed
" }, + "DocumentClassificationConfig":{ + "type":"structure", + "required":["Mode"], + "members":{ + "Mode":{ + "shape":"DocumentClassifierMode", + "documentation":"Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
One or more labels to associate with the custom classifier.
" + } + }, + "documentation":"Configuration required for a custom classification model.
" + }, "DocumentClassificationJobFilter":{ "type":"structure", "members":{ @@ -2667,7 +3322,7 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -2676,6 +3331,10 @@ "VpcConfig":{ "shape":"VpcConfig", "documentation":"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
" + }, + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel
" } }, "documentation":"Provides information about a document classification job.
" @@ -2725,7 +3384,7 @@ "documentation":"Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.
" } }, - "documentation":"Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.
" + "documentation":"Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the ListDocumentClassifiers operation.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
KMS Key Alias: \"alias/ExampleAlias\"
ARN of a KMS Key Alias: \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
The Amazon S3 prefix for the data lake location of the flywheel statistics.
" } }, "documentation":"Provides output results configuration parameters for custom classifier jobs.
" @@ -2823,7 +3486,7 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -2848,6 +3511,10 @@ "SourceModelArn":{ "shape":"DocumentClassifierArn", "documentation":"The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.
" + }, + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel
" } }, "documentation":"Provides information about a document classifier.
" @@ -3062,7 +3729,7 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -3143,11 +3810,15 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
" }, "DesiredDataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"Data access role ARN to use in case the new model is encrypted with a customer KMS key.
" + }, + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel
" } }, "documentation":"Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.
" @@ -3237,7 +3908,7 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -3298,6 +3969,17 @@ }, "documentation":"Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.
" }, + "EntityRecognitionConfig":{ + "type":"structure", + "required":["EntityTypes"], + "members":{ + "EntityTypes":{ + "shape":"EntityTypesList", + "documentation":"Up to 25 entity types that the model is trained to recognize.
" + } + }, + "documentation":"Configuration required for an entity recognition model.
" + }, "EntityRecognizerAnnotations":{ "type":"structure", "required":["S3Uri"], @@ -3362,7 +4044,7 @@ "documentation":"Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.
" } }, - "documentation":"Describes the entity recognizer submitted with an entity recognizer.
" + "documentation":"Describes the entity list submitted with an entity recognizer.
" }, "EntityRecognizerEvaluationMetrics":{ "type":"structure", @@ -3402,7 +4084,7 @@ "documentation":"Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
" } }, - "documentation":"Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>
" + "documentation":"Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the ListEntityRecognizers operation./>
Individual item from the list of entity types in the metadata of an entity recognizer.
" }, + "EntityRecognizerOutputDataConfig":{ + "type":"structure", + "members":{ + "FlywheelStatsS3Prefix":{ + "shape":"S3Uri", + "documentation":"The Amazon S3 prefix for the data lake location of the flywheel statistics.
" + } + }, + "documentation":"Output data configuration.
" + }, "EntityRecognizerProperties":{ "type":"structure", "members":{ @@ -3525,7 +4217,7 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -3537,7 +4229,7 @@ }, "ModelKmsKeyId":{ "shape":"KmsKeyId", - "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.
" + }, + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel
" + }, + "OutputDataConfig":{ + "shape":"EntityRecognizerOutputDataConfig", + "documentation":"Output data configuration.
" } }, "documentation":"Describes information about an entity recognizer.
" @@ -3660,101 +4360,337 @@ "min":1, "pattern":"[A-Z_]*" }, - "EventsDetectionJobFilter":{ + "EventsDetectionJobFilter":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"Filters on the name of the events detection job.
" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"Filters the list of jobs based on job status. Returns only jobs with the specified status.
" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
" + } + }, + "documentation":"Provides information for filtering a list of event detection jobs.
" + }, + "EventsDetectionJobProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"The identifier assigned to the events detection job.
" + }, + "JobArn":{ + "shape":"ComprehendArn", + "documentation":"The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
The name you assigned the events detection job.
" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"The current status of the events detection job.
" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"A description of the status of the events detection job.
" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"The time that the events detection job was submitted for processing.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The time that the events detection job completed.
" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"The input data configuration that you supplied when you created the events detection job.
" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"The output data configuration that you supplied when you created the events detection job.
" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"The language code of the input documents.
" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" + }, + "TargetEventTypes":{ + "shape":"TargetEventTypes", + "documentation":"The types of events that are detected by the job.
" + } + }, + "documentation":"Provides information about an events detection job.
" + }, + "EventsDetectionJobPropertiesList":{ + "type":"list", + "member":{"shape":"EventsDetectionJobProperties"} + }, + "ExtractedCharactersListItem":{ + "type":"structure", + "members":{ + "Page":{ + "shape":"Integer", + "documentation":"Page number.
" + }, + "Count":{ + "shape":"Integer", + "documentation":"Number of characters extracted from each page.
" + } + }, + "documentation":"Array of the number of characters extracted from each page.
" + }, + "Float":{"type":"float"}, + "FlywheelFilter":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"FlywheelStatus", + "documentation":"Filter the flywheels based on the flywheel status.
" + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"Filter the flywheels to include flywheels created after the specified time.
" + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"Filter the flywheels to include flywheels created before the specified time.
" + } + }, + "documentation":"Filter the flywheels based on creation time or flywheel status.
" + }, + "FlywheelIterationFilter":{ + "type":"structure", + "members":{ + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"Filter the flywheel iterations to include iterations created after the specified time.
" + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"Filter the flywheel iterations to include iterations created before the specified time.
" + } + }, + "documentation":"Filter the flywheel iterations based on creation time.
" + }, + "FlywheelIterationId":{ + "type":"string", + "max":63, + "pattern":"[0-9]{8}T[0-9]{6}Z" + }, + "FlywheelIterationProperties":{ + "type":"structure", + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"" + }, + "FlywheelIterationId":{ + "shape":"FlywheelIterationId", + "documentation":"" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The creation start time of the flywheel iteration.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The completion time of this flywheel iteration.
" + }, + "Status":{ + "shape":"FlywheelIterationStatus", + "documentation":"The status of the flywheel iteration.
" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"A description of the status of the flywheel iteration.
" + }, + "EvaluatedModelArn":{ + "shape":"ComprehendModelArn", + "documentation":"The ARN of the evaluated model associated with this flywheel iteration.
" + }, + "EvaluatedModelMetrics":{"shape":"FlywheelModelEvaluationMetrics"}, + "TrainedModelArn":{ + "shape":"ComprehendModelArn", + "documentation":"The ARN of the trained model associated with this flywheel iteration.
" + }, + "TrainedModelMetrics":{ + "shape":"FlywheelModelEvaluationMetrics", + "documentation":"The metrics associated with the trained model.
" + }, + "EvaluationManifestS3Prefix":{ + "shape":"S3Uri", + "documentation":"" + } + }, + "documentation":"The configuration properties of a flywheel iteration.
" + }, + "FlywheelIterationPropertiesList":{ + "type":"list", + "member":{"shape":"FlywheelIterationProperties"} + }, + "FlywheelIterationStatus":{ + "type":"string", + "enum":[ + "TRAINING", + "EVALUATING", + "COMPLETED", + "FAILED", + "STOP_REQUESTED", + "STOPPED" + ] + }, + "FlywheelModelEvaluationMetrics":{ "type":"structure", "members":{ - "JobName":{ - "shape":"JobName", - "documentation":"Filters on the name of the events detection job.
" + "AverageF1Score":{ + "shape":"Double", + "documentation":"The average F1 score from the evaluation metrics.
" }, - "JobStatus":{ - "shape":"JobStatus", - "documentation":"Filters the list of jobs based on job status. Returns only jobs with the specified status.
" + "AveragePrecision":{ + "shape":"Double", + "documentation":"Average precision metric for the model.
" }, - "SubmitTimeBefore":{ - "shape":"Timestamp", - "documentation":"Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
" + "AverageRecall":{ + "shape":"Double", + "documentation":"Average recall metric for the model.
" }, - "SubmitTimeAfter":{ - "shape":"Timestamp", - "documentation":"Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
" + "AverageAccuracy":{ + "shape":"Double", + "documentation":"Average accuracy metric for the model.
" } }, - "documentation":"Provides information for filtering a list of event detection jobs.
" + "documentation":"The evaluation metrics associated with the evaluated model.
" }, - "EventsDetectionJobProperties":{ + "FlywheelProperties":{ "type":"structure", "members":{ - "JobId":{ - "shape":"JobId", - "documentation":"The identifier assigned to the events detection job.
" + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel.
" }, - "JobArn":{ - "shape":"ComprehendArn", - "documentation":"The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
The Amazon Resource Number (ARN) of the active model version.
" }, - "JobName":{ - "shape":"JobName", - "documentation":"The name you assigned the events detection job.
" + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend permission to access the flywheel data.
" }, - "JobStatus":{ - "shape":"JobStatus", - "documentation":"The current status of the events detection job.
" + "TaskConfig":{ + "shape":"TaskConfig", + "documentation":"Configuration about the custom classifier associated with the flywheel.
" }, - "Message":{ - "shape":"AnyLengthString", - "documentation":"A description of the status of the events detection job.
" + "DataLakeS3Uri":{ + "shape":"S3Uri", + "documentation":"Amazon S3 URI of the data lake location.
" }, - "SubmitTime":{ - "shape":"Timestamp", - "documentation":"The time that the events detection job was submitted for processing.
" + "DataSecurityConfig":{ + "shape":"DataSecurityConfig", + "documentation":"Data security configuration.
" }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"The time that the events detection job completed.
" + "Status":{ + "shape":"FlywheelStatus", + "documentation":"The status of the flywheel.
" }, - "InputDataConfig":{ - "shape":"InputDataConfig", - "documentation":"The input data configuration that you supplied when you created the events detection job.
" + "ModelType":{ + "shape":"ModelType", + "documentation":"Model type of the flywheel's model.
" }, - "OutputDataConfig":{ - "shape":"OutputDataConfig", - "documentation":"The output data configuration that you supplied when you created the events detection job.
" + "Message":{ + "shape":"AnyLengthString", + "documentation":"A description of the status of the flywheel.
" }, - "LanguageCode":{ - "shape":"LanguageCode", - "documentation":"The language code of the input documents.
" + "CreationTime":{ + "shape":"Timestamp", + "documentation":"Creation time of the flywheel.
" }, - "DataAccessRoleArn":{ - "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"Last modified time for the flywheel.
" }, - "TargetEventTypes":{ - "shape":"TargetEventTypes", - "documentation":"The types of events that are detected by the job.
" + "LatestFlywheelIteration":{ + "shape":"FlywheelIterationId", + "documentation":"The most recent flywheel iteration.
" } }, - "documentation":"Provides information about an events detection job.
" + "documentation":"The flywheel properties.
" }, - "EventsDetectionJobPropertiesList":{ - "type":"list", - "member":{"shape":"EventsDetectionJobProperties"} + "FlywheelS3Uri":{ + "type":"string", + "max":512, + "pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" }, - "ExtractedCharactersListItem":{ + "FlywheelStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "FAILED" + ] + }, + "FlywheelSummary":{ "type":"structure", "members":{ - "Page":{ - "shape":"Integer", - "documentation":"Page number.
" + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel
" }, - "Count":{ - "shape":"Integer", - "documentation":"Number of characters extracted from each page.
" + "ActiveModelArn":{ + "shape":"ComprehendModelArn", + "documentation":"ARN of the active model version for the flywheel.
" + }, + "DataLakeS3Uri":{ + "shape":"S3Uri", + "documentation":"Amazon S3 URI of the data lake location.
" + }, + "Status":{ + "shape":"FlywheelStatus", + "documentation":"The status of the flywheel.
" + }, + "ModelType":{ + "shape":"ModelType", + "documentation":"Model type of the flywheel's model.
" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"A description of the status of the flywheel.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"Creation time of the flywheel.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"Last modified time for the flywheel.
" + }, + "LatestFlywheelIteration":{ + "shape":"FlywheelIterationId", + "documentation":"The most recent flywheel iteration.
" } }, - "documentation":"Array of the number of characters extracted from each page.
" + "documentation":"Flywheel summary information.
" + }, + "FlywheelSummaryList":{ + "type":"list", + "member":{"shape":"FlywheelSummary"} }, - "Float":{"type":"float"}, "Geometry":{ "type":"structure", "members":{ @@ -3797,11 +4733,11 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
" }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" } } }, @@ -4015,7 +4951,7 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -4051,6 +4987,16 @@ "min":1, "pattern":"^[ ~!@#$%^*\\-_+=|\\\\:;\\t>?/]$" }, + "LabelListItem":{ + "type":"string", + "max":5000, + "pattern":"^\\P{C}*$" + }, + "LabelsList":{ + "type":"list", + "member":{"shape":"LabelListItem"}, + "max":1000 + }, "LanguageCode":{ "type":"string", "enum":[ @@ -4068,6 +5014,40 @@ "zh-TW" ] }, + "ListDatasetsRequest":{ + "type":"structure", + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel.
" + }, + "Filter":{ + "shape":"DatasetFilter", + "documentation":"Filters the datasets to be returned in the response.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Identifies the next page of results to return.
" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"Maximum number of results to return in a response. The default is 100.
" + } + } + }, + "ListDatasetsResponse":{ + "type":"structure", + "members":{ + "DatasetPropertiesList":{ + "shape":"DatasetPropertiesList", + "documentation":"The dataset properties list.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Identifies the next page of results to return.
" + } + } + }, "ListDocumentClassificationJobsRequest":{ "type":"structure", "members":{ @@ -4266,7 +5246,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"The list entity recognizer summaries.
" + "documentation":"Identifies the next page of results to return.
" } } }, @@ -4330,6 +5310,71 @@ } } }, + "ListFlywheelIterationHistoryRequest":{ + "type":"structure", + "required":["FlywheelArn"], + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The ARN of the flywheel.
" + }, + "Filter":{ + "shape":"FlywheelIterationFilter", + "documentation":"Filter the flywheel iteration history based on creation time.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Next token
" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"Maximum number of iteration history results to return
" + } + } + }, + "ListFlywheelIterationHistoryResponse":{ + "type":"structure", + "members":{ + "FlywheelIterationPropertiesList":{ + "shape":"FlywheelIterationPropertiesList", + "documentation":"List of flywheel iteration properties
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Next token
" + } + } + }, + "ListFlywheelsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"FlywheelFilter", + "documentation":"Filters the flywheels that are returned. You can filter flywheels on their status, or the date and time that they were submitted. You can only set one filter at a time.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Identifies the next page of results to return.
" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"Maximum number of results to return in a response. The default is 100.
" + } + } + }, + "ListFlywheelsResponse":{ + "type":"structure", + "members":{ + "FlywheelSummaryList":{ + "shape":"FlywheelSummaryList", + "documentation":"A list of flywheel properties retrieved by the service in response to the request.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Identifies the next page of results to return.
" + } + } + }, "ListKeyPhrasesDetectionJobsRequest":{ "type":"structure", "members":{ @@ -4643,6 +5688,14 @@ "TRAINED" ] }, + "ModelType":{ + "type":"string", + "enum":[ + "DOCUMENT_CLASSIFIER", + "ENTITY_RECOGNIZER" + ] + }, + "NumberOfDocuments":{"type":"long"}, "NumberOfTopicsInteger":{ "type":"integer", "max":100, @@ -4781,7 +5834,7 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "Mode":{ "shape":"PiiEntitiesDetectionMode", @@ -5102,7 +6155,7 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -5160,7 +6213,6 @@ "StartDocumentClassificationJobRequest":{ "type":"structure", "required":[ - "DocumentClassifierArn", "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn" @@ -5201,7 +6253,11 @@ }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + }, + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
" } } }, @@ -5210,7 +6266,7 @@ "members":{ "JobId":{ "shape":"JobId", - "documentation":"The identifier generated for the job. To get the status of the job, use this identifier with the operation.
" + "documentation":"The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.
The status of the job:
SUBMITTED - The job has been received and queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. For details, use the operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.
The status of the job:
SUBMITTED - The job has been received and queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.
The ARN of the custom classification model.
" } } }, @@ -5261,7 +6321,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the dominant language detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the dominant language detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" } } }, @@ -5330,7 +6390,11 @@ }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + }, + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
" } } }, @@ -5348,6 +6412,10 @@ "JobStatus":{ "shape":"JobStatus", "documentation":"The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.
The ARN of the custom entity recognition model.
" } } }, @@ -5392,7 +6460,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" } } }, @@ -5413,6 +6481,33 @@ } } }, + "StartFlywheelIterationRequest":{ + "type":"structure", + "required":["FlywheelArn"], + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The ARN of the flywheel.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
" + } + } + }, + "StartFlywheelIterationResponse":{ + "type":"structure", + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"" + }, + "FlywheelIterationId":{ + "shape":"FlywheelIterationId", + "documentation":"" + } + } + }, "StartKeyPhrasesDetectionJobRequest":{ "type":"structure", "required":[ @@ -5457,7 +6552,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the key phrases detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the key phrases detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" } } }, @@ -5523,7 +6618,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" } } }, @@ -5588,7 +6683,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" } } }, @@ -5647,7 +6742,7 @@ "VpcConfig":{"shape":"VpcConfig"}, "Tags":{ "shape":"TagList", - "documentation":"Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" } } }, @@ -5656,7 +6751,7 @@ "members":{ "JobId":{ "shape":"JobId", - "documentation":"The identifier generated for the job. To get the status of a job, use this identifier with the operation.
" + "documentation":"The identifier generated for the job. To get the status of a job, use this identifier with the DescribeTargetedSentimentDetectionJob operation.
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the DescribeTargetedSentimentDetectionJob operation.
Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + "documentation":"Tags to associate with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" } } }, @@ -6060,7 +7155,7 @@ "documentation":"Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
" } }, - "documentation":"Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
" + "documentation":"Provides information for filtering a list of dominant language detection jobs. For more information, see the ListTargetedSentimentDetectionJobs operation.
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", - "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.
For more information about targeted sentiment, see Targeted sentiment.
" }, + "TaskConfig":{ + "type":"structure", + "required":["LanguageCode"], + "members":{ + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"Language code for the language that the model supports.
" + }, + "DocumentClassificationConfig":{ + "shape":"DocumentClassificationConfig", + "documentation":"Configuration required for a classification model.
" + }, + "EntityRecognitionConfig":{ + "shape":"EntityRecognitionConfig", + "documentation":"Configuration required for an entity recognition model.
" + } + }, + "documentation":"Configuration about the custom classifier associated with the flywheel.
" + }, "TextSizeLimitExceededException":{ "type":"structure", "members":{ @@ -6285,7 +7399,7 @@ }, "DataAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your job data.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -6332,6 +7446,21 @@ "members":{ } }, + "UpdateDataSecurityConfig":{ + "type":"structure", + "members":{ + "ModelKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
" + }, + "VpcConfig":{"shape":"VpcConfig"} + }, + "documentation":"Data security configuration.
" + }, "UpdateEndpointRequest":{ "type":"structure", "required":["EndpointArn"], @@ -6351,12 +7480,51 @@ "DesiredDataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"Data access role ARN to use in case the new model is encrypted with a customer CMK.
" + }, + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel
" } } }, "UpdateEndpointResponse":{ "type":"structure", "members":{ + "DesiredModelArn":{ + "shape":"ComprehendModelArn", + "documentation":"The Amazon Resource Number (ARN) of the new model.
" + } + } + }, + "UpdateFlywheelRequest":{ + "type":"structure", + "required":["FlywheelArn"], + "members":{ + "FlywheelArn":{ + "shape":"ComprehendFlywheelArn", + "documentation":"The Amazon Resource Number (ARN) of the flywheel to update.
" + }, + "ActiveModelArn":{ + "shape":"ComprehendModelArn", + "documentation":"The Amazon Resource Number (ARN) of the active model version.
" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend permission to access the flywheel data.
" + }, + "DataSecurityConfig":{ + "shape":"UpdateDataSecurityConfig", + "documentation":"Flywheel data security configuration.
" + } + } + }, + "UpdateFlywheelResponse":{ + "type":"structure", + "members":{ + "FlywheelProperties":{ + "shape":"FlywheelProperties", + "documentation":"The flywheel properties.
" + } } }, "VersionName":{ diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 8b24ab7b77..3c7e06427a 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -496,7 +496,7 @@ }, "input":{"shape":"CancelSpotFleetRequestsRequest"}, "output":{"shape":"CancelSpotFleetRequestsResponse"}, - "documentation":"Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
" + "documentation":"Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
" }, "DeleteFlowLogs":{ "name":"DeleteFlowLogs", @@ -3162,7 +3162,7 @@ }, "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, "output":{"shape":"DescribeSpotInstanceRequestsResult"}, - "documentation":"Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
" + "documentation":"Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of items returned. This paginates the output, which makes the list more manageable and returns the items faster. If the list of items exceeds your MaxResults value, then that number of items is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining items.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", @@ -4504,7 +4504,7 @@ }, "input":{"shape":"ImportImageRequest"}, "output":{"shape":"ImportImageResult"}, - "documentation":"Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
" + "documentation":"To import your virtual machines (VMs) with a console-based experience, you can use the Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more information, see the Migration Hub Orchestrator User Guide .
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
" }, "ImportInstance":{ "name":"ImportInstance", @@ -4691,7 +4691,7 @@ "requestUri":"/" }, "input":{"shape":"ModifyImageAttributeRequest"}, - "documentation":"Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
" + "documentation":"Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
To specify the attribute, you can use the Attribute parameter, or one of the following parameters: Description, ImdsSupport, or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
" }, "ModifyInstanceAttribute":{ "name":"ModifyInstanceAttribute", @@ -5145,7 +5145,7 @@ }, "input":{"shape":"ModifyVpcPeeringConnectionOptionsRequest"}, "output":{"shape":"ModifyVpcPeeringConnectionOptionsResult"}, - "documentation":"We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
" + "documentation":"We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
" }, "ModifyVpcTenancy":{ "name":"ModifyVpcTenancy", @@ -6780,7 +6780,7 @@ }, "HostMaintenance":{ "shape":"HostMaintenance", - "documentation":"Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
Default: on
Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
" } } }, @@ -7471,7 +7471,7 @@ "documentation":"The ID of the instance. The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.
" }, "PublicIp":{ - "shape":"String", + "shape":"EipAllocationPublicIp", "documentation":"[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.
" }, "AllowReassociation":{ @@ -9431,7 +9431,7 @@ }, "TerminateInstances":{ "shape":"Boolean", - "documentation":"Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
", + "documentation":"Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. The default is to terminate the instances.
To let the instances continue to run after the Spot Fleet request is canceled, specify no-terminate-instances.
Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
Indicates whether to terminate the associated instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify no-terminate-instances. Supported only for fleets of type maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
The CIDR you want to deprovision from the pool.
" + "documentation":"The CIDR you want to deprovision from the pool. Enter the CIDR you want to deprovision with a netmask of /32. You must rerun this command for each IP address in the CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of the 256 IP addresses in the /24 CIDR.
The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. If this parameter is not specified, then all results are returned.
" + "documentation":"The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" }, "NextToken":{ "shape":"NextToken", - "documentation":"The token for the next set of results.
" + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "DryRun":{ "shape":"Boolean", @@ -18926,7 +18926,7 @@ }, "NextToken":{ "shape":"NextToken", - "documentation":"The token to use for the next set of results. This value is null when there are no more results to return.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of parallel instances that are launched for creating resources.
", + "documentation":"The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.
", "locationName":"maxParallelLaunches" }, "OwnerId":{ @@ -19142,11 +19142,11 @@ }, "MaxResults":{ "shape":"Integer", - "documentation":"The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
" + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "FleetId":{ "shape":"FleetId", @@ -19168,12 +19168,12 @@ }, "LastEvaluatedTime":{ "shape":"DateTime", - "documentation":"The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more items, this value is not present.
The token for the next set of results.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
" + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "FleetId":{ "shape":"FleetId", @@ -19225,7 +19225,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
" + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "FleetIds":{ "shape":"FleetIdSet", @@ -19312,7 +19312,7 @@ "members":{ "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next page of results.
" + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, @@ -19734,7 +19734,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. For more information, see Pagination.
" + "documentation":"The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same call.
" }, "NextToken":{ "shape":"String", @@ -19969,7 +19969,7 @@ }, "MaxResults":{ "shape":"Integer", - "documentation":"The maximum number of items to return for this request. To retrieve the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. For more information, see Pagination.
" + "documentation":"The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
" }, "NextToken":{ "shape":"String", @@ -20105,7 +20105,7 @@ }, "MaxResults":{ "shape":"Integer", - "documentation":"The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same request. For more information, see Pagination.
", + "documentation":"The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
", "locationName":"maxResults" }, "NextToken":{ @@ -22253,12 +22253,12 @@ }, "MaxResults":{ "shape":"DescribeSpotFleetInstancesMaxResults", - "documentation":"The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "locationName":"maxResults" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token required to retrieve the next set of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "locationName":"maxResults" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more items, this value is not present.
The token required to retrieve the next set of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "locationName":"maxResults" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token required to retrieve the next set of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token to request the next set of results. This value is null when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults":{ "shape":"Integer", - "documentation":"The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "documentation":"Contains the parameters for DescribeSpotInstanceRequests.
" @@ -22447,7 +22447,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"The token to use to retrieve the next set of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "locationName":"maxResults" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
", + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName":"nextToken" }, "ProductDescriptions":{ @@ -22509,7 +22509,7 @@ "members":{ "NextToken":{ "shape":"String", - "documentation":"The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token for the next page of results.
" + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults":{ "shape":"DescribeStoreImageTasksRequestMaxResults", - "documentation":"The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the ImageIDs parameter in the same call.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of parallel instances to launch for creating resources.
", + "documentation":"The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.
", "locationName":"maxParallelLaunches" }, "OwnerId":{ @@ -25058,7 +25058,7 @@ "documentation":"[EC2-VPC] The association ID. Required for EC2-VPC.
" }, "PublicIp":{ - "shape":"String", + "shape":"EipAllocationPublicIp", "documentation":"[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
" }, "DryRun":{ @@ -25924,6 +25924,7 @@ "locationName":"item" } }, + "EipAllocationPublicIp":{"type":"string"}, "EipAssociationIdList":{ "type":"list", "member":{ @@ -26285,7 +26286,7 @@ }, "MaxParallelLaunches":{ "shape":"Integer", - "documentation":"The maximum number of parallel instances to launch for creating resources. Value must be 6 or greater.
The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching. Value must be 6 or greater.
The configuration settings that were defined for creating and managing the pre-provisioned snapshots for faster launching of the Windows AMI. This property is returned when the associated resourceType is snapshot.
Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster launches from the Windows AMI. This property is returned when the associated resourceType is snapshot.
The maximum number of parallel instances to launch for creating resources.
", + "documentation":"The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.
", "locationName":"maxParallelLaunches" }, "OwnerId":{ @@ -27983,7 +27984,7 @@ "members":{ "InstanceType":{ "shape":"InstanceType", - "documentation":"The instance type.
If you specify InstanceType, you can't specify InstanceRequirements.
The instance type.
mac1.metal is not supported as a launch template override.
If you specify InstanceType, you can't specify InstanceRequirements.
The instance type.
If you specify InstanceType, you can't specify InstanceRequirements.
The instance type.
mac1.metal is not supported as a launch template override.
If you specify InstanceType, you can't specify InstanceRequirements.
The maximum number of results to return in a single call. Specify a value between 1 and
1000. The default value is 1000. To retrieve the remaining results, make another call with
the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
" + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, @@ -29105,7 +29106,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The maximum number of results to return in a single call. Specify a value between 1 and
1000. The default value is 1000. To retrieve the remaining results, make another call with
the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
" + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, @@ -29806,7 +29807,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"The token for the next set of results.
", + "documentation":"The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The Base64-encoded user data for the instance.
", + "documentation":"The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
", "locationName":"userData" }, "SecurityGroups":{ @@ -37929,11 +37930,11 @@ }, "NextToken":{ "shape":"String", - "documentation":"The token for the next page of results.
" + "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults":{ "shape":"ListImagesInRecycleBinMaxResults", - "documentation":"The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If you do not specify a value for MaxResults, the request returns 1,000 items per page by default. For more information, see Pagination.
" + "documentation":"The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" }, "DryRun":{ "shape":"Boolean", @@ -37951,7 +37952,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The name of the attribute to modify.
Valid values: description | launchPermission
The name of the attribute to modify.
Valid values: description | imdsSupport | launchPermission
The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description.
The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.
The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.
Contains the parameters for ModifyImageAttribute.
" @@ -46326,7 +46331,7 @@ }, "UserData":{ "shape":"SensitiveUserData", - "documentation":"The Base64-encoded user data for the instance. User data is limited to 16 KB.
", + "documentation":"The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
", "locationName":"userData" } }, @@ -50144,7 +50149,7 @@ }, "UserData":{ "shape":"SensitiveUserData", - "documentation":"The Base64-encoded user data that instances use when starting up.
", + "documentation":"The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
", "locationName":"userData" }, "WeightedCapacity":{ diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 2c143f81dc..d4a94f1e37 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -1666,6 +1666,9 @@ "apprunner" : { "endpoints" : { "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, "eu-west-1" : { }, "fips-us-east-1" : { "credentialScope" : { diff --git a/botocore/data/kms/2014-11-01/endpoint-rule-set-1.json b/botocore/data/kms/2014-11-01/endpoint-rule-set-1.json index 7e3838f633..64b8c61c24 100644 --- a/botocore/data/kms/2014-11-01/endpoint-rule-set-1.json +++ b/botocore/data/kms/2014-11-01/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,14 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -62,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -131,90 +111,215 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] }, - "supportsFIPS" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kms-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] }, { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsDualStack" + true ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kms-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://kms-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsFIPS" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kms.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -222,7 +327,7 @@ { "conditions": [], "endpoint": { - "url": "https://kms-fips.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://kms.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -231,74 +336,13 @@ ] } ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://kms.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://kms.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/botocore/data/kms/2014-11-01/service-2.json b/botocore/data/kms/2014-11-01/service-2.json index 36cbf7bfe4..7b429732b6 100644 --- a/botocore/data/kms/2014-11-01/service-2.json +++ b/botocore/data/kms/2014-11-01/service-2.json @@ -159,7 +159,7 @@ {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], - "documentation":"Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:
You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.
If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend.
Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:Decrypt (key policy)
Related operations:
" + "documentation":"Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:
You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.
If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend.
Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using &IAM; policies. Otherwise, you might create an &IAM; policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. If you use the KeyId parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias ARN of the KMS key.
Required permissions: kms:Decrypt (key policy)
Related operations:
" }, "DeleteAlias":{ "name":"DeleteAlias", @@ -362,7 +362,7 @@ {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], - "documentation":"Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.
To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the DescribeKey operation.
You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.
To generate an SM4 data key (China Regions only), specify a KeySpec value of AES_128 or NumberOfBytes value of 128. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of KMS:
Use the GenerateDataKey operation to get a data key.
Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory.
Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data.
To decrypt data outside of KMS:
Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext data key from memory.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:GenerateDataKey (key policy)
Related operations:
Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.
To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the DescribeKey operation.
You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.
To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec value of AES_128 or a NumberOfBytes value of 16. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of KMS:
Use the GenerateDataKey operation to get a data key.
Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory.
Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data.
To decrypt data outside of KMS:
Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext data key from memory.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:GenerateDataKey (key policy)
Related operations:
Verifies a digital signature that was generated by the Sign operation.
Verification confirms that an authorized user signed the message with the specified KMS key and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception.
A digital signature is generated by using the private key in an asymmetric KMS key. The signature is verified by using the public key in the same asymmetric KMS key. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
To verify a digital signature, you can use the Verify operation. Specify the same asymmetric KMS key, message, and signing algorithm that were used to produce the signature.
You can also verify the digital signature by using the public key of the KMS key outside of KMS. Use the GetPublicKey operation to download the public key in the asymmetric KMS key and then use the public key to verify the signature outside of KMS. The advantage of using the Verify operation is that it is performed within KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the KMS key to verify signatures.
To verify a signature outside of KMS with an SM2 public key (China Regions only), you must specify the distinguishing ID. By default, KMS uses 1234567812345678 as the distinguishing ID. For more information, see Offline verification with SM2 key pairs.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:Verify (key policy)
Related operations: Sign
" + "documentation":"Verifies a digital signature that was generated by the Sign operation.
Verification confirms that an authorized user signed the message with the specified KMS key and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception.
A digital signature is generated by using the private key in an asymmetric KMS key. The signature is verified by using the public key in the same asymmetric KMS key. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
To use the Verify operation, specify the same asymmetric KMS key, message, and signing algorithm that were used to produce the signature. The message type does not need to be the same as the one used for signing, but it must indicate whether the value of the Message parameter should be hashed as part of the verification process.
You can also verify the digital signature by using the public key of the KMS key outside of KMS. Use the GetPublicKey operation to download the public key in the asymmetric KMS key and then use the public key to verify the signature outside of KMS. The advantage of using the Verify operation is that it is performed within KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the KMS key to verify signatures.
To verify a signature outside of KMS with an SM2 public key (China Regions only), you must specify the distinguishing ID. By default, KMS uses 1234567812345678 as the distinguishing ID. For more information, see Offline verification with SM2 key pairs.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:Verify (key policy)
Related operations: Sign
" }, "VerifyMac":{ "name":"VerifyMac", @@ -1211,11 +1211,11 @@ }, "GranteePrincipal":{ "shape":"PrincipalIdType", - "documentation":"The identity that gets the permissions specified in the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
" + "documentation":"The identity that gets the permissions specified in the grant.
To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
" }, "RetiringPrincipal":{ "shape":"PrincipalIdType", - "documentation":"The principal that has permission to use the RetireGrant operation to retire the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.
" + "documentation":"The principal that has permission to use the RetireGrant operation to retire the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.
" }, "Operations":{ "shape":"GrantOperationList", @@ -1253,7 +1253,7 @@ "members":{ "Policy":{ "shape":"PolicyType", - "documentation":"The key policy to attach to the KMS key.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default Key Policy in the Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
" + "documentation":"The key policy to attach to the KMS key.
If you provide a key policy, it must meet the following criteria:
The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
" }, "Description":{ "shape":"DescriptionType", @@ -1283,7 +1283,7 @@ }, "BypassPolicyLockoutSafetyCheck":{ "shape":"BooleanType", - "documentation":"A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
The default value is false.
" + "documentation":"Skips (\"bypasses\") the key policy lockout safety check. The default value is false.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, see Default key policy in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
" }, "Tags":{ "shape":"TagList", @@ -2044,7 +2044,7 @@ }, "WrappingAlgorithm":{ "shape":"AlgorithmSpec", - "documentation":"The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
" + "documentation":"The algorithm you will use to encrypt the key material before using the ImportKeyMaterial operation to import it. For more information, see Encrypt the key material in the Key Management Service Developer Guide.
The RSAES_PKCS1_V1_5 wrapping algorithm is deprecated. We recommend that you begin using a different wrapping algorithm immediately. KMS will end support for RSAES_PKCS1_V1_5 by October 1, 2023 pursuant to cryptographic key management guidance from the National Institute of Standards and Technology (NIST).
The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
" + "documentation":"The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
" } } }, @@ -2938,11 +2938,11 @@ }, "Policy":{ "shape":"PolicyType", - "documentation":"The key policy to attach to the KMS key.
The key policy must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide.
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
A key policy document can include only the following characters:
Printable ASCII characters from the space character (\\u0020) through the end of the ASCII character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF).
The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
" + "documentation":"The key policy to attach to the KMS key.
The key policy must meet the following criteria:
The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
A key policy document can include only the following characters:
Printable ASCII characters from the space character (\\u0020) through the end of the ASCII character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF).
The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
" }, "BypassPolicyLockoutSafetyCheck":{ "shape":"BooleanType", - "documentation":"A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
The default value is false.
" + "documentation":"Skips (\"bypasses\") the key policy lockout safety check. The default value is false.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, see Default key policy in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
" } } }, @@ -3035,11 +3035,11 @@ }, "Policy":{ "shape":"PolicyType", - "documentation":"The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
A key policy document can include only the following characters:
Printable ASCII characters from the space character (\\u0020) through the end of the ASCII character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF).
The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
" + "documentation":"The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
If you provide a key policy, it must meet the following criteria:
The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
A key policy document can include only the following characters:
Printable ASCII characters from the space character (\\u0020) through the end of the ASCII character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF).
The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
" }, "BypassPolicyLockoutSafetyCheck":{ "shape":"BooleanType", - "documentation":"A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
The default value is false.
" + "documentation":"Skips (\"bypasses\") the key policy lockout safety check. The default value is false.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, see Default key policy in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
" }, "Description":{ "shape":"DescriptionType", @@ -3151,11 +3151,11 @@ }, "Message":{ "shape":"PlaintextType", - "documentation":"Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.
If you provide a message, KMS generates a hash digest of the message and then signs it.
" + "documentation":"Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide a message digest.
If you provide a message digest, use the DIGEST value of MessageType to prevent the digest from being hashed again while signing.
Tells KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.
When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.
Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the signing operation can be compromised.
When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.
You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, this can cause verification failures when verifying with a system that assumes a single hash.
The hashing algorithm in that Sign uses is based on the SigningAlgorithm value.
Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
" + "documentation":"Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for compatibility with existing applications.
" } } }, @@ -3459,7 +3459,7 @@ }, "MessageType":{ "shape":"MessageType", - "documentation":"Tells KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with a raw message, the security of the verification operation can be compromised.
Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.
When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.
Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the verification operation can be compromised.
When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.
You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.
The hashing algorithm in that Verify uses is based on the SigningAlgorithm value.
Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS operations that you can call programmatically. For general information about KMS, see the Key Management Service Developer Guide .
KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to KMS and other Amazon Web Services services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.
If you need to use FIPS 140-2 validated cryptographic modules when communicating with Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.
All KMS API calls must be signed and be transmitted using Transport Layer Security (TLS). KMS recommends you always use the latest supported TLS version. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your Amazon Web Services account (root) access key ID and secret access key for everyday work with KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary security credentials that you can use to sign requests.
All KMS operations require Signature Version 4.
Logging API Requests
KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
Amazon Web Services Security Credentials - This topic provides general information about the types of credentials used to access Amazon Web Services.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used API Operations
Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.
" + "documentation":"Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS operations that you can call programmatically. For general information about KMS, see the Key Management Service Developer Guide .
KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to KMS and other Amazon Web Services services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.
If you need to use FIPS 140-2 validated cryptographic modules when communicating with Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.
All KMS API calls must be signed and be transmitted using Transport Layer Security (TLS). KMS recommends you always use the latest supported TLS version. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your Amazon Web Services account root access key ID and secret access key for everyday work. You can use the access key ID and secret access key for an IAM user or you can use the Security Token Service (STS) to generate temporary security credentials and use those to sign requests.
All KMS requests must be signed with Signature Version 4.
Logging API Requests
KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
Amazon Web Services Security Credentials - This topic provides general information about the types of credentials used to access Amazon Web Services.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used API Operations
Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.
" } diff --git a/botocore/data/lightsail/2016-11-28/endpoint-rule-set-1.json b/botocore/data/lightsail/2016-11-28/endpoint-rule-set-1.json index ee08de5421..9428d1992f 100644 --- a/botocore/data/lightsail/2016-11-28/endpoint-rule-set-1.json +++ b/botocore/data/lightsail/2016-11-28/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,14 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -62,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -131,154 +111,215 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -286,7 +327,7 @@ { "conditions": [], "endpoint": { - "url": "https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://lightsail.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -295,28 +336,13 @@ ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lightsail.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/botocore/data/lightsail/2016-11-28/service-2.json b/botocore/data/lightsail/2016-11-28/service-2.json index 6df1a42f2f..fba5ddf088 100644 --- a/botocore/data/lightsail/2016-11-28/service-2.json +++ b/botocore/data/lightsail/2016-11-28/service-2.json @@ -414,6 +414,23 @@ ], "documentation":"Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.
Use StartGUISession to open the session.
Returns information about one or more of your Amazon Lightsail container services.
" }, + "GetCostEstimate":{ + "name":"GetCostEstimate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCostEstimateRequest"}, + "output":{"shape":"GetCostEstimateResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
" + }, "GetDisk":{ "name":"GetDisk", "http":{ @@ -2539,6 +2573,23 @@ ], "documentation":"Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.
" }, + "StartGUISession":{ + "name":"StartGUISession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartGUISessionRequest"}, + "output":{"shape":"StartGUISessionResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.
" + }, "StartInstance":{ "name":"StartInstance", "http":{ @@ -2577,6 +2628,23 @@ ], "documentation":"Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.
The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.
" + }, "StopInstance":{ "name":"StopInstance", "http":{ @@ -3025,6 +3093,14 @@ "nextSnapshotTimeOfDay":{ "shape":"TimeOfDay", "documentation":"The next daily time an automatic snapshot will be created.
The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
The snapshot is automatically created between the time shown and up to 45 minutes after.
" + }, + "threshold":{ + "shape":"string", + "documentation":"The trigger threshold of the action.
This add-on only applies to Lightsail for Research resources.
The amount of idle time in minutes after which your virtual computer will automatically stop.
This add-on only applies to Lightsail for Research resources.
Describes an add-on that is enabled for an Amazon Lightsail resource.
" @@ -3044,6 +3120,10 @@ "autoSnapshotAddOnRequest":{ "shape":"AutoSnapshotAddOnRequest", "documentation":"An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
" + }, + "stopInstanceOnIdleRequest":{ + "shape":"StopInstanceOnIdleRequest", + "documentation":"An object that represents additional parameters when enabling or modifying the StopInstanceOnIdle add-on.
This object only applies to Lightsail for Research resources.
Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.
An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.
The disk path to expose to the instance (e.g., /dev/xvdf).
A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is False.
This value only applies to Lightsail for Research resources.
The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
" + }, + "appCategory":{ + "shape":"AppCategory", + "documentation":"Virtual computer blueprints that are supported by Lightsail for Research.
This parameter only applies to Lightsail for Research resources.
Describes a blueprint (a virtual private server image).
" @@ -3686,6 +3794,10 @@ "supportedPlatforms":{ "shape":"InstancePlatformList", "documentation":"The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle.
Virtual computer blueprints that are supported by a Lightsail for Research bundle.
This parameter only applies to Lightsail for Research resources.
Describes a bundle, which is a set of specs describing your virtual private server (or instance).
" @@ -4584,6 +4696,24 @@ } } }, + "CostEstimate":{ + "type":"structure", + "members":{ + "usageType":{ + "shape":"NonEmptyString", + "documentation":"The types of usage that are included in the estimate, such as costs, usage, or data transfer.
" + }, + "resultsByTime":{ + "shape":"EstimatesByTime", + "documentation":"The cost estimate result that's associated with a time period.
" + } + }, + "documentation":"Describes the estimated cost for resources in your Lightsail for Research account.
" + }, + "CostEstimates":{ + "type":"list", + "member":{"shape":"CostEstimate"} + }, "CreateBucketAccessKeyRequest":{ "type":"structure", "required":["bucketName"], @@ -5046,6 +5176,41 @@ } } }, + "CreateGUISessionAccessDetailsRequest":{ + "type":"structure", + "required":["resourceName"], + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"The resource name.
" + } + } + }, + "CreateGUISessionAccessDetailsResult":{ + "type":"structure", + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"The resource name.
" + }, + "status":{ + "shape":"Status", + "documentation":"The status of the operation.
" + }, + "percentageComplete":{ + "shape":"integer", + "documentation":"The percentage of completion for the operation.
" + }, + "failureReason":{ + "shape":"string", + "documentation":"The reason the operation failed.
" + }, + "sessions":{ + "shape":"Sessions", + "documentation":"Returns information about the specified NICE DCV GUI session.
" + } + } + }, "CreateInstanceSnapshotRequest":{ "type":"structure", "required":[ @@ -5482,6 +5647,10 @@ } } }, + "Currency":{ + "type":"string", + "enum":["USD"] + }, "DeleteAlarmRequest":{ "type":"structure", "required":["alarmName"], @@ -6130,6 +6299,10 @@ "shape":"integer", "documentation":"(Deprecated) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
Describes a block storage disk.
" @@ -6543,6 +6716,36 @@ "key":{"shape":"string"}, "value":{"shape":"string"} }, + "EstimateByTime":{ + "type":"structure", + "members":{ + "usageCost":{ + "shape":"double", + "documentation":"The amount of cost or usage that's measured for the cost estimate.
" + }, + "pricingUnit":{ + "shape":"PricingUnit", + "documentation":"The unit of measurement that's used for the cost estimate.
" + }, + "unit":{ + "shape":"double", + "documentation":"The number of pricing units used to calculate the total number of hours. For example, 1 unit equals 1 hour.
" + }, + "currency":{ + "shape":"Currency", + "documentation":"The currency of the estimate in USD.
" + }, + "timePeriod":{ + "shape":"TimePeriod", + "documentation":"The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date.
" + } + }, + "documentation":"An estimate that's associated with a time period.
" + }, + "EstimatesByTime":{ + "type":"list", + "member":{"shape":"EstimateByTime"} + }, "ExportSnapshotRecord":{ "type":"structure", "members":{ @@ -6746,6 +6949,10 @@ "pageToken":{ "shape":"string", "documentation":"The token to advance to the next page of results from your request.
To get a page token, perform an initial GetBlueprints request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
Returns a list of blueprints that are specific to Lightsail for Research.
You must use this parameter to view Lightsail for Research blueprints.
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
Returns a list of bundles that are specific to Lightsail for Research.
You must use this parameter to view Lightsail for Research bundles.
The resource name.
" + }, + "startTime":{ + "shape":"IsoDate", + "documentation":"The cost estimate start time.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
" + }, + "endTime":{ + "shape":"IsoDate", + "documentation":"The cost estimate end time.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
" + } + } + }, + "GetCostEstimateResult":{ + "type":"structure", + "members":{ + "resourcesBudgetEstimate":{ + "shape":"ResourcesBudgetEstimate", + "documentation":"Returns the estimate's forecasted cost or usage.
" + } + } + }, "GetDiskRequest":{ "type":"structure", "required":["diskName"], @@ -9960,7 +10202,9 @@ "UpdateBucketBundle", "UpdateBucket", "SetResourceAccessForBucket", - "UpdateInstanceMetadataOptions" + "UpdateInstanceMetadataOptions", + "StartGUISession", + "StopGUISession" ] }, "Origin":{ @@ -10136,6 +10380,16 @@ "closed" ] }, + "PricingUnit":{ + "type":"string", + "enum":[ + "GB", + "Hrs", + "GB-Mo", + "Bundles", + "Queries" + ] + }, "PrivateRegistryAccess":{ "type":"structure", "members":{ @@ -10906,6 +11160,32 @@ "deny" ] }, + "ResourceBudgetEstimate":{ + "type":"structure", + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"The resource name.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"The type of resource the budget will track.
" + }, + "costEstimates":{ + "shape":"CostEstimates", + "documentation":"The cost estimate for the specified budget.
" + }, + "startTime":{ + "shape":"IsoDate", + "documentation":"The estimate start time.
" + }, + "endTime":{ + "shape":"IsoDate", + "documentation":"The estimate end time.
" + } + }, + "documentation":"Describes the estimated cost or usage that a budget tracks.
" + }, "ResourceLocation":{ "type":"structure", "members":{ @@ -10985,6 +11265,10 @@ "Bucket" ] }, + "ResourcesBudgetEstimate":{ + "type":"list", + "member":{"shape":"ResourceBudgetEstimate"} + }, "RevocationReason":{"type":"string"}, "SendContactMethodVerificationRequest":{ "type":"structure", @@ -11005,6 +11289,11 @@ } } }, + "SensitiveNonEmptyString":{ + "type":"string", + "pattern":".*\\S.*", + "sensitive":true + }, "SensitiveString":{ "type":"string", "sensitive":true @@ -11022,6 +11311,28 @@ "exception":true, "fault":true }, + "Session":{ + "type":"structure", + "members":{ + "name":{ + "shape":"NonEmptyString", + "documentation":"The session name.
" + }, + "url":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The session URL.
" + }, + "isPrimary":{ + "shape":"boolean", + "documentation":"When true, this Boolean value indicates the primary session for the specified resource.
" + } + }, + "documentation":"Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual computer’s operating system or application.
" + }, + "Sessions":{ + "type":"list", + "member":{"shape":"Session"} + }, "SetIpAddressTypeRequest":{ "type":"structure", "required":[ @@ -11084,6 +11395,25 @@ } } }, + "StartGUISessionRequest":{ + "type":"structure", + "required":["resourceName"], + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"The resource name.
" + } + } + }, + "StartGUISessionResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"The available API operations.
" + } + } + }, "StartInstanceRequest":{ "type":"structure", "required":["instanceName"], @@ -11168,6 +11498,21 @@ "type":"list", "member":{"shape":"StaticIp"} }, + "Status":{ + "type":"string", + "enum":[ + "startExpired", + "notStarted", + "started", + "starting", + "stopped", + "stopping", + "settingUpInstance", + "failedInstanceCreation", + "failedStartingGUISession", + "failedStoppingGUISession" + ] + }, "StatusType":{ "type":"string", "enum":[ @@ -11175,6 +11520,39 @@ "Inactive" ] }, + "StopGUISessionRequest":{ + "type":"structure", + "required":["resourceName"], + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"The resource name.
" + } + } + }, + "StopGUISessionResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"The available API operations.
" + } + } + }, + "StopInstanceOnIdleRequest":{ + "type":"structure", + "members":{ + "threshold":{ + "shape":"string", + "documentation":"The value to compare with the duration.
" + }, + "duration":{ + "shape":"string", + "documentation":"The amount of idle time in minutes after which your virtual computer will automatically stop.
" + } + }, + "documentation":"Describes a request to create or edit the StopInstanceOnIdle add-on.
This add-on only applies to Lightsail for Research resources.
The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Lightsail for Research retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.
The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01.
Sets the start date and end date for retrieving a cost estimate. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor object is a container that has the information required for token based access to your Ethereum nodes.
" + "documentation":"Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor contains information required for token based access to your Ethereum nodes.
" }, "CreateMember":{ "name":"CreateMember", @@ -126,7 +127,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceErrorException"} ], - "documentation":"The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).
Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).
The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
Returns detailed information about an accessor. An accessor object is a container that has the information required for token based access to your Ethereum nodes.
" + "documentation":"Returns detailed information about an accessor. An accessor object is a container that has the information required for token based access to your Ethereum nodes.
" }, "GetMember":{ "name":"GetMember", @@ -263,7 +264,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceErrorException"} ], - "documentation":"The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
Returns a list of the accessors and their properties. Accessor objects are containers that have the information required for token based access to your Ethereum nodes.
" + "documentation":"Returns a list of the accessors and their properties. Accessor objects are containers that have the information required for token based access to your Ethereum nodes.
" }, "ListInvitations":{ "name":"ListInvitations", @@ -520,9 +521,13 @@ "Arn":{ "shape":"ArnString", "documentation":"The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" + }, + "Tags":{ + "shape":"OutputTagMap", + "documentation":"The tags assigned to the Accessor.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" } }, - "documentation":"The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
The properties of the Accessor.
" + "documentation":"The properties of the Accessor.
" }, "AccessorBillingTokenString":{ "type":"string", @@ -567,7 +572,7 @@ "documentation":"The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, - "documentation":"The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
A summary of accessor properties.
" + "documentation":"A summary of accessor properties.
" }, "AccessorSummaryList":{ "type":"list", @@ -622,6 +627,10 @@ "AccessorType":{ "shape":"AccessorType", "documentation":"The type of accessor.
Currently accessor type is restricted to BILLING_TOKEN.
Tags to assign to the Accessor.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" } } }, @@ -723,7 +732,7 @@ }, "Tags":{ "shape":"InputTagMap", - "documentation":"Tags to assign to the network. Each tag consists of a key and optional value.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" + "documentation":"Tags to assign to the network.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" } } }, @@ -769,7 +778,7 @@ }, "Tags":{ "shape":"InputTagMap", - "documentation":"Tags to assign to the node. Each tag consists of a key and optional value.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" + "documentation":"Tags to assign to the node.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" } } }, @@ -816,7 +825,7 @@ }, "Tags":{ "shape":"InputTagMap", - "documentation":"Tags to assign to the proposal. Each tag consists of a key and optional value.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" + "documentation":"Tags to assign to the proposal.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" } } }, @@ -1537,7 +1546,7 @@ }, "Tags":{ "shape":"OutputTagMap", - "documentation":"Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" + "documentation":"Tags assigned to the member. Tags consist of a key and optional value.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" }, "Arn":{ "shape":"ArnString", @@ -1575,7 +1584,7 @@ }, "Tags":{ "shape":"InputTagMap", - "documentation":"Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.
" + "documentation":"Tags assigned to the member. Tags consist of a key and optional value.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" }, "KmsKeyArn":{ "shape":"ArnString", diff --git a/botocore/data/omics/2022-11-28/endpoint-rule-set-1.json b/botocore/data/omics/2022-11-28/endpoint-rule-set-1.json index 8c1b3668fb..76599609af 100644 --- a/botocore/data/omics/2022-11-28/endpoint-rule-set-1.json +++ b/botocore/data/omics/2022-11-28/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,23 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -71,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -140,168 +111,238 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] }, - "supportsDualStack" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://omics-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://omics-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], - "endpoint": { - "url": "https://omics.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://omics.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/botocore/data/omics/2022-11-28/service-2.json b/botocore/data/omics/2022-11-28/service-2.json index 1718af1efc..a785ddfa34 100644 --- a/botocore/data/omics/2022-11-28/service-2.json +++ b/botocore/data/omics/2022-11-28/service-2.json @@ -1143,7 +1143,7 @@ {"shape":"AccessDeniedException"}, {"shape":"RequestTimeoutException"} ], - "documentation":"Starts a read set activation job.
", + "documentation":"Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.
", "endpoint":{"hostPrefix":"control-storage-"} }, "StartReadSetExportJob":{ @@ -1164,7 +1164,7 @@ {"shape":"AccessDeniedException"}, {"shape":"RequestTimeoutException"} ], - "documentation":"Starts a read set export job.
", + "documentation":"Exports a read set to Amazon S3.
", "endpoint":{"hostPrefix":"control-storage-"} }, "StartReadSetImportJob":{ @@ -1515,7 +1515,6 @@ "AnnotationImportItemSources":{ "type":"list", "member":{"shape":"AnnotationImportItemSource"}, - "max":1, "min":1 }, "AnnotationImportJobItem":{ @@ -1826,7 +1825,7 @@ }, "reference":{ "shape":"ReferenceItem", - "documentation":"The store's genome reference.
" + "documentation":"The store's genome reference. Required for all stores except TSV format with generic annotations.
" }, "status":{ "shape":"StoreStatus", @@ -1912,7 +1911,7 @@ }, "maxDuration":{ "shape":"CreateRunGroupRequestMaxDurationInteger", - "documentation":"A max duration for the group.
" + "documentation":"A maximum run time for the group in minutes.
" }, "maxRuns":{ "shape":"CreateRunGroupRequestMaxRunsInteger", @@ -1924,7 +1923,7 @@ }, "requestId":{ "shape":"RunGroupRequestId", - "documentation":"A request ID for the group.
", + "documentation":"To ensure that requests don't run multiple times, specify a unique ID for each request.
", "idempotencyToken":true }, "tags":{ @@ -2123,12 +2122,12 @@ }, "requestId":{ "shape":"WorkflowRequestId", - "documentation":"A request ID for the workflow.
", + "documentation":"To ensure that requests don't run multiple times, specify a unique ID for each request.
", "idempotencyToken":true }, "storageCapacity":{ "shape":"CreateWorkflowRequestStorageCapacityInteger", - "documentation":"A storage capacity for the workflow.
" + "documentation":"A storage capacity for the workflow in gigabytes.
" }, "tags":{ "shape":"TagMap", @@ -2728,7 +2727,7 @@ }, "sources":{ "shape":"ActivateReadSetSourceList", - "documentation":"The job's sources.
" + "documentation":"The job's source files.
" }, "status":{ "shape":"ReadSetActivationJobStatus", @@ -2859,7 +2858,7 @@ }, "sources":{ "shape":"ImportReadSetSourceList", - "documentation":"The job's sources.
" + "documentation":"The job's source files.
" }, "status":{ "shape":"ReadSetImportJobStatus", @@ -3061,7 +3060,7 @@ }, "sources":{ "shape":"ImportReferenceSourceList", - "documentation":"The job's sources.
" + "documentation":"The job's source files.
" }, "status":{ "shape":"ReferenceImportJobStatus", @@ -3282,7 +3281,7 @@ }, "maxDuration":{ "shape":"GetRunGroupResponseMaxDurationInteger", - "documentation":"The group's maximum run duration.
" + "documentation":"The group's maximum run time in minutes.
" }, "maxRuns":{ "shape":"GetRunGroupResponseMaxRunsInteger", @@ -3415,7 +3414,7 @@ }, "storageCapacity":{ "shape":"GetRunResponseStorageCapacityInteger", - "documentation":"The run's storage capacity.
" + "documentation":"The run's storage capacity in gigabytes.
" }, "tags":{ "shape":"TagMap", @@ -3481,7 +3480,7 @@ }, "memory":{ "shape":"GetRunTaskResponseMemoryInteger", - "documentation":"The task's memory setting.
" + "documentation":"The task's memory use in gigabytes.
" }, "name":{ "shape":"TaskName", @@ -3789,7 +3788,7 @@ }, "storageCapacity":{ "shape":"GetWorkflowResponseStorageCapacityInteger", - "documentation":"The workflow's storage capacity.
" + "documentation":"The workflow's storage capacity in gigabytes.
" }, "tags":{ "shape":"TagMap", @@ -4047,7 +4046,8 @@ "IN_PROGRESS", "CANCELLED", "COMPLETED", - "FAILED" + "FAILED", + "COMPLETED_WITH_FAILURES" ] }, "JobStatusMessage":{ @@ -5581,7 +5581,7 @@ }, "maxDuration":{ "shape":"RunGroupListItemMaxDurationInteger", - "documentation":"The group's maximum duration setting.
" + "documentation":"The group's maximum duration setting in minutes.
" }, "maxRuns":{ "shape":"RunGroupListItemMaxRunsInteger", @@ -5811,11 +5811,15 @@ }, "SchemaItem":{ "type":"map", - "key":{"shape":"String"}, + "key":{"shape":"SchemaItemKeyString"}, "value":{"shape":"SchemaValueType"}, "max":1, "min":1 }, + "SchemaItemKeyString":{ + "type":"string", + "pattern":"^[a-z0-9_]{1,255}$" + }, "SchemaValueType":{ "type":"string", "enum":[ @@ -6043,7 +6047,7 @@ }, "sources":{ "shape":"StartReadSetActivationJobRequestSourcesList", - "documentation":"The job's sources.
" + "documentation":"The job's source files.
" } } }, @@ -6120,7 +6124,7 @@ }, "sources":{ "shape":"StartReadSetExportJobRequestSourcesList", - "documentation":"Sources for the job.
" + "documentation":"The job's source files.
" } } }, @@ -6186,7 +6190,7 @@ }, "sources":{ "shape":"StartReadSetImportJobRequestSourcesList", - "documentation":"Source files to import.
" + "documentation":"The job's source files.
" } } }, @@ -6301,7 +6305,7 @@ }, "sources":{ "shape":"StartReferenceImportJobRequestSourcesList", - "documentation":"Sources for the job.
" + "documentation":"The job's source files.
" } } }, @@ -6398,7 +6402,7 @@ }, "requestId":{ "shape":"RunRequestId", - "documentation":"A request ID for the run.
", + "documentation":"To ensure that requests don't run multiple times, specify a unique ID for each request.
", "idempotencyToken":true }, "roleArn":{ @@ -6415,7 +6419,7 @@ }, "storageCapacity":{ "shape":"StartRunRequestStorageCapacityInteger", - "documentation":"A storage capacity for the run.
" + "documentation":"A storage capacity for the run in gigabytes.
" }, "tags":{ "shape":"TagMap", @@ -6637,7 +6641,7 @@ }, "memory":{ "shape":"TaskListItemMemoryInteger", - "documentation":"The task's memory.
" + "documentation":"The task's memory use in gigabyes.
" }, "name":{ "shape":"TaskName", @@ -6865,7 +6869,7 @@ }, "maxDuration":{ "shape":"UpdateRunGroupRequestMaxDurationInteger", - "documentation":"The maximum amount of time to run.
" + "documentation":"A maximum run time for the group in minutes.
" }, "maxRuns":{ "shape":"UpdateRunGroupRequestMaxRunsInteger", @@ -7004,6 +7008,10 @@ "source":{ "shape":"S3Uri", "documentation":"The source file's location in Amazon S3.
" + }, + "statusMessage":{ + "shape":"JobStatusMsg", + "documentation":"A message that provides additional context about a job
" } }, "documentation":"Details about an imported variant item.
" @@ -7011,7 +7019,6 @@ "VariantImportItemDetails":{ "type":"list", "member":{"shape":"VariantImportItemDetail"}, - "max":1, "min":1 }, "VariantImportItemSource":{ @@ -7028,7 +7035,6 @@ "VariantImportItemSources":{ "type":"list", "member":{"shape":"VariantImportItemSource"}, - "max":1, "min":1 }, "VariantImportJobItem":{ @@ -7314,7 +7320,8 @@ "ACTIVE", "UPDATING", "DELETED", - "FAILED" + "FAILED", + "INACTIVE" ], "max":64, "min":1 @@ -7329,7 +7336,10 @@ }, "WorkflowType":{ "type":"string", - "enum":["PRIVATE"], + "enum":[ + "PRIVATE", + "SERVICE" + ], "max":64, "min":1 } diff --git a/docs/source/conf.py b/docs/source/conf.py index 4651fde9c3..97ae9facc7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ # The short X.Y version. version = '1.29.' # The full version, including alpha/beta/rc tags. -release = '1.29.80' +release = '1.29.81' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/tests/functional/endpoint-rules/comprehend/endpoint-tests-1.json b/tests/functional/endpoint-rules/comprehend/endpoint-tests-1.json index 7d2411ad28..e75ad3540f 100644 --- a/tests/functional/endpoint-rules/comprehend/endpoint-tests-1.json +++ b/tests/functional/endpoint-rules/comprehend/endpoint-tests-1.json @@ -1,42 +1,29 @@ { "testCases": [ { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.ap-south-1.amazonaws.com" + "url": "https://comprehend.ap-northeast-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.ap-south-1.api.aws" + "url": "https://comprehend.ap-northeast-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "ap-northeast-2", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": false } }, { @@ -47,48 +34,35 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ca-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ca-central-1" + "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.ca-central-1.amazonaws.com" + "url": "https://comprehend.ap-southeast-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.ca-central-1.api.aws" + "url": "https://comprehend.ap-southeast-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "ap-southeast-2", "UseFIPS": false, - "Region": "ca-central-1" + "UseDualStack": false } }, { @@ -99,48 +73,9 @@ } }, "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, + "Region": "ca-central-1", "UseFIPS": false, - "Region": "eu-central-1" + "UseDualStack": false } }, { @@ -151,100 +86,87 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-west-1" + "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.us-west-1.amazonaws.com" + "url": "https://comprehend.eu-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-1" + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.us-west-1.api.aws" + "url": "https://comprehend.eu-west-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "eu-west-2", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.us-west-1.amazonaws.com" + "url": "https://comprehend.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.us-west-2.api.aws" + "url": "https://comprehend-fips.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-west-2" + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.us-west-2.amazonaws.com" + "url": "https://comprehend.us-east-2.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.us-west-2.api.aws" + "url": "https://comprehend-fips.us-east-2.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false } }, { @@ -255,978 +177,280 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": false } }, { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.af-south-1.api.aws" + "url": "https://comprehend-fips.us-west-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "us-west-2", "UseFIPS": true, - "Region": "af-south-1" + "UseDualStack": false } }, { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.af-south-1.amazonaws.com" + "url": "https://comprehend-fips.us-east-1.api.aws" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.af-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "af-south-1" + "UseDualStack": true } }, { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend.af-south-1.amazonaws.com" + "url": "https://comprehend.us-east-1.api.aws" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "af-south-1" + "UseDualStack": true } }, { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-north-1.api.aws" + "url": "https://comprehend-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "eu-north-1" + "UseDualStack": true } }, { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-north-1.amazonaws.com" + "url": "https://comprehend-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "eu-north-1" + "UseDualStack": false } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-north-1.api.aws" + "url": "https://comprehend.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": true } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-north-1.amazonaws.com" + "url": "https://comprehend.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-3.api.aws" + "url": "https://comprehend.us-gov-west-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-3" + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-3.amazonaws.com" + "url": "https://comprehend-fips.us-gov-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.eu-west-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-3" + "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-3.amazonaws.com" + "url": "https://comprehend-fips.us-gov-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-3" + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-2.api.aws" + "url": "https://comprehend-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "eu-west-2" + "UseDualStack": false } }, { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-2.amazonaws.com" + "url": "https://comprehend.us-gov-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-2" + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-2.api.aws" + "url": "https://comprehend.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-2.amazonaws.com" + "url": "https://comprehend.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-1.api.aws" + "url": "https://comprehend-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "eu-west-1" + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-1.amazonaws.com" + "url": "https://comprehend-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "eu-west-1" + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-1.api.aws" + "url": "https://comprehend.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-1.amazonaws.com" + "url": "https://example.com" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-2" + "Endpoint": "https://example.com" } }, { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://comprehend.ap-northeast-2.api.aws" + "url": "https://example.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-northeast-2.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" + "Endpoint": "https://example.com" } }, { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-northeast-1.api.aws" - } + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-northeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-1" + "Endpoint": "https://example.com" } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { - "endpoint": { - "url": "https://comprehend.ap-northeast-1.amazonaws.com" - } + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.me-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.me-south-1.api.aws" - } - }, - "params": { "UseDualStack": true, - "UseFIPS": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.me-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.sa-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.sa-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-gov-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-2" - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-2" - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-2" - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-2" - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } } diff --git a/tests/functional/endpoint-rules/ec2/endpoint-tests-1.json b/tests/functional/endpoint-rules/ec2/endpoint-tests-1.json index 106bd24fd7..f438a23ab8 100644 --- a/tests/functional/endpoint-rules/ec2/endpoint-tests-1.json +++ b/tests/functional/endpoint-rules/ec2/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "af-south-1", "UseFIPS": false, - "Region": "af-south-1" + "UseDualStack": false } }, { @@ -21,9 +21,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-east-1", "UseFIPS": false, - "Region": "ap-east-1" + "UseDualStack": false } }, { @@ -34,9 +34,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-1", "UseFIPS": false, - "Region": "ap-northeast-1" + "UseDualStack": false } }, { @@ -47,9 +47,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-2", "UseFIPS": false, - "Region": "ap-northeast-2" + "UseDualStack": false } }, { @@ -60,9 +60,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-3", "UseFIPS": false, - "Region": "ap-northeast-3" + "UseDualStack": false } }, { @@ -73,9 +73,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": false } }, { @@ -86,9 +86,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": true } }, { @@ -99,9 +99,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-1", "UseFIPS": false, - "Region": "ap-southeast-1" + "UseDualStack": false } }, { @@ -112,9 +112,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": false, - "Region": "ap-southeast-2" + "UseDualStack": false } }, { @@ -125,9 +125,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-3", "UseFIPS": false, - "Region": "ap-southeast-3" + "UseDualStack": false } }, { @@ -138,9 +138,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": false, - "Region": "ca-central-1" + "UseDualStack": false } }, { @@ -151,9 +151,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": true, - "Region": "ca-central-1" + "UseDualStack": false } }, { @@ -164,9 +164,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false, - "Region": "eu-central-1" + "UseDualStack": false } }, { @@ -177,9 +177,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": false } }, { @@ -190,9 +190,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-south-1", "UseFIPS": false, - "Region": "eu-south-1" + "UseDualStack": false } }, { @@ -203,9 +203,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-1", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": false } }, { @@ -216,9 +216,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "eu-west-1", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": true } }, { @@ -229,9 +229,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false } }, { @@ -242,9 +242,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-3", "UseFIPS": false, - "Region": "eu-west-3" + "UseDualStack": false } }, { @@ -255,9 +255,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "me-south-1", "UseFIPS": false, - "Region": "me-south-1" + "UseDualStack": false } }, { @@ -268,9 +268,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "sa-east-1", "UseFIPS": false, - "Region": "sa-east-1" + "UseDualStack": false } }, { @@ -281,9 +281,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "sa-east-1", "UseFIPS": false, - "Region": "sa-east-1" + "UseDualStack": true } }, { @@ -294,9 +294,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -307,9 +307,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -320,9 +320,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -333,9 +333,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": false } }, { @@ -346,9 +346,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": true, - "Region": "us-east-2" + "UseDualStack": false } }, { @@ -359,9 +359,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-2", "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": true } }, { @@ -372,9 +372,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -385,9 +385,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": true, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -398,9 +398,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -411,9 +411,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": true, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -424,9 +424,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": true } }, { @@ -437,9 +437,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -450,9 +450,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -463,9 +463,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-northwest-1", "UseFIPS": false, - "Region": "cn-northwest-1" + "UseDualStack": false } }, { @@ -476,9 +476,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -489,9 +489,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -502,9 +502,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -515,9 +515,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -528,9 +528,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": false, - "Region": "us-gov-west-1" + "UseDualStack": false } }, { @@ -541,9 +541,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -554,9 +554,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -567,9 +567,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -580,9 +580,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -593,9 +593,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-west-1", "UseFIPS": false, - "Region": "us-iso-west-1" + "UseDualStack": false } }, { @@ -606,9 +606,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -619,9 +619,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -632,9 +632,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -645,9 +645,9 @@ } }, "params": { - "UseDualStack": false, - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -659,8 +659,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -670,9 +670,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -682,9 +682,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/tests/functional/endpoint-rules/kms/endpoint-tests-1.json b/tests/functional/endpoint-rules/kms/endpoint-tests-1.json index f45c01f0c1..48ad4fc1be 100644 --- a/tests/functional/endpoint-rules/kms/endpoint-tests-1.json +++ b/tests/functional/endpoint-rules/kms/endpoint-tests-1.json @@ -1,1721 +1,808 @@ { "testCases": [ { - "documentation": "For region ap-south-2 with FIPS enabled and DualStack enabled", + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-south-2.api.aws" + "url": "https://kms.af-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-south-2" + "UseDualStack": false, + "UseFIPS": false, + "Region": "af-south-1" } }, { - "documentation": "For region ap-south-2 with FIPS enabled and DualStack disabled", + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-south-2.amazonaws.com" + "url": "https://kms-fips.af-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ap-south-2" + "UseFIPS": true, + "Region": "af-south-1" } }, { - "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-south-2.api.aws" + "url": "https://kms.ap-east-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-south-2" + "Region": "ap-east-1" } }, { - "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-south-2.amazonaws.com" + "url": "https://kms-fips.ap-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-south-2" + "UseFIPS": true, + "Region": "ap-east-1" } }, { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-south-1.api.aws" + "url": "https://kms.ap-northeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-south-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-1" } }, { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-south-1.amazonaws.com" + "url": "https://kms-fips.ap-northeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ap-south-1" + "UseFIPS": true, + "Region": "ap-northeast-1" } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-south-1.api.aws" + "url": "https://kms.ap-northeast-2.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-south-1" + "Region": "ap-northeast-2" } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-south-1.amazonaws.com" + "url": "https://kms-fips.ap-northeast-2.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-south-1" + "UseFIPS": true, + "Region": "ap-northeast-2" } }, { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-south-1.api.aws" + "url": "https://kms.ap-northeast-3.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-south-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-3" } }, { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-south-1.amazonaws.com" + "url": "https://kms-fips.ap-northeast-3.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "eu-south-1" + "UseFIPS": true, + "Region": "ap-northeast-3" } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-south-1.api.aws" + "url": "https://kms.ap-south-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-south-1" + "Region": "ap-south-1" } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-south-1.amazonaws.com" + "url": "https://kms-fips.ap-south-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "eu-south-1" + "UseFIPS": true, + "Region": "ap-south-1" } }, { - "documentation": "For region eu-south-2 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-south-2.api.aws" + "url": "https://kms.ap-southeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-south-2" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" } }, { - "documentation": "For region eu-south-2 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-south-2.amazonaws.com" + "url": "https://kms-fips.ap-southeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "eu-south-2" + "UseFIPS": true, + "Region": "ap-southeast-1" } }, { - "documentation": "For region eu-south-2 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-south-2.api.aws" + "url": "https://kms.ap-southeast-2.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-south-2" + "Region": "ap-southeast-2" } }, { - "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-south-2.amazonaws.com" + "url": "https://kms-fips.ap-southeast-2.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "eu-south-2" + "UseFIPS": true, + "Region": "ap-southeast-2" } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-gov-east-1.api.aws" + "url": "https://kms.ap-southeast-3.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-east-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-3" } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-gov-east-1.amazonaws.com" + "url": "https://kms-fips.ap-southeast-3.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-gov-east-1" + "UseFIPS": true, + "Region": "ap-southeast-3" } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-gov-east-1.api.aws" + "url": "https://kms.ca-central-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "ca-central-1" } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-gov-east-1.amazonaws.com" + "url": "https://kms-fips.ca-central-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-gov-east-1" + "UseFIPS": true, + "Region": "ca-central-1" } }, { - "documentation": "For region me-central-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.me-central-1.api.aws" + "url": "https://kms.eu-central-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "me-central-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" } }, { - "documentation": "For region me-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.me-central-1.amazonaws.com" + "url": "https://kms-fips.eu-central-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "me-central-1" + "UseFIPS": true, + "Region": "eu-central-1" } }, { - "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.me-central-1.api.aws" + "url": "https://kms.eu-north-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "me-central-1" + "Region": "eu-north-1" } }, { - "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.me-central-1.amazonaws.com" + "url": "https://kms-fips.eu-north-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "me-central-1" + "UseFIPS": true, + "Region": "eu-north-1" } }, { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ca-central-1.api.aws" + "url": "https://kms.eu-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ca-central-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-south-1" } }, { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ca-central-1.amazonaws.com" + "url": "https://kms-fips.eu-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ca-central-1" + "UseFIPS": true, + "Region": "eu-south-1" } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ca-central-1.api.aws" + "url": "https://kms.eu-west-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ca-central-1" + "Region": "eu-west-1" } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ca-central-1.amazonaws.com" + "url": "https://kms-fips.eu-west-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ca-central-1" + "UseFIPS": true, + "Region": "eu-west-1" } }, { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-central-1.api.aws" + "url": "https://kms.eu-west-2.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-central-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-2" } }, { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-central-1.amazonaws.com" + "url": "https://kms-fips.eu-west-2.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "eu-central-1" + "UseFIPS": true, + "Region": "eu-west-2" } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-central-1.api.aws" + "url": "https://kms.eu-west-3.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-central-1" + "Region": "eu-west-3" } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-central-1.amazonaws.com" + "url": "https://kms-fips.eu-west-3.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "eu-central-1" + "UseFIPS": true, + "Region": "eu-west-3" } }, { - "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://kms.me-south-1.amazonaws.com" + } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-west-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "me-south-1" } }, { - "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-iso-west-1.c2s.ic.gov" + "url": "https://kms-fips.me-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-iso-west-1" + "UseFIPS": true, + "Region": "me-south-1" } }, { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://kms.sa-east-1.amazonaws.com" + } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-west-1" + "Region": "sa-east-1" } }, { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-iso-west-1.c2s.ic.gov" + "url": "https://kms-fips.sa-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-iso-west-1" + "UseFIPS": true, + "Region": "sa-east-1" } }, { - "documentation": "For region eu-central-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-central-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region eu-central-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-central-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-central-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-central-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.us-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.us-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.af-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.af-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.af-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.af-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "af-south-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-north-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-north-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-3.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-3.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-3.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-3.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.me-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.me-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.me-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.sa-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.sa-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.us-gov-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-southeast-1.api.aws" + "url": "https://kms.us-east-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-1" + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-1.amazonaws.com" + "url": "https://kms-fips.us-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-1" + "UseFIPS": true, + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-2.api.aws" + "url": "https://kms.us-east-2.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-2" + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-2" } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-2.amazonaws.com" + "url": "https://kms-fips.us-east-2.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ap-southeast-2" + "UseFIPS": true, + "Region": "us-east-2" } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-2.api.aws" + "url": "https://kms.us-west-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-2" + "Region": "us-west-1" } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-2.amazonaws.com" + "url": "https://kms-fips.us-west-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-west-1" } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://kms.us-west-2.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-west-2" } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-iso-east-1.c2s.ic.gov" + "url": "https://kms-fips.us-west-2.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-iso-east-1" + "UseFIPS": true, + "Region": "us-west-2" } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-3.api.aws" + "url": "https://kms-fips.us-east-1.api.aws" } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "ap-southeast-3" + "UseFIPS": true, + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-3.amazonaws.com" + "url": "https://kms.us-east-1.api.aws" } }, "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-southeast-3" + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-3.api.aws" + "url": "https://kms.cn-north-1.amazonaws.com.cn" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-3" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-3.amazonaws.com" + "url": "https://kms.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-3" + "UseFIPS": false, + "Region": "cn-northwest-1" } }, { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-4.api.aws" + "url": "https://kms-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "ap-southeast-4" + "UseFIPS": true, + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-4.amazonaws.com" + "url": "https://kms-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ap-southeast-4" + "UseFIPS": true, + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-4.api.aws" + "url": "https://kms.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "ap-southeast-4" + "UseFIPS": false, + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-4.amazonaws.com" + "url": "https://kms.us-gov-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-4" + "UseFIPS": false, + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-east-1.api.aws" + "url": "https://kms-fips.us-gov-east-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-east-1.amazonaws.com" + "url": "https://kms.us-gov-west-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.us-east-1.api.aws" - } - }, - "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-gov-west-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-east-1.amazonaws.com" + "url": "https://kms-fips.us-gov-west-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-east-2.api.aws" - } - }, - "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-2" + "Region": "us-gov-west-1" } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-east-2.amazonaws.com" + "url": "https://kms-fips.us-gov-east-1.api.aws" } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-2" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms.us-east-2.api.aws" + "url": "https://kms.us-gov-east-1.api.aws" } }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "us-east-2" + "UseFIPS": false, + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-east-2.amazonaws.com" + "url": "https://kms.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-2" + "UseFIPS": false, + "Region": "us-iso-east-1" } }, { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.cn-northwest-1.api.amazonwebservices.com.cn" + "url": "https://kms-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-northwest-1" + "Region": "us-iso-east-1" } }, { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.cn-northwest-1.amazonaws.com.cn" + "url": "https://kms.us-iso-west-1.c2s.ic.gov" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "cn-northwest-1" + "UseFIPS": false, + "Region": "us-iso-west-1" } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.cn-northwest-1.api.amazonwebservices.com.cn" + "url": "https://kms-fips.us-iso-west-1.c2s.ic.gov" } }, "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-northwest-1" + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-west-1" } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.cn-northwest-1.amazonaws.com.cn" + "url": "https://kms.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, + "UseFIPS": false, "Region": "us-isob-east-1" } }, @@ -1727,46 +814,35 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-isob-east-1" } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://kms.us-isob-east-1.sc2s.sgov.gov" + "url": "https://example.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-isob-east-1" + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -1776,8 +852,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -1788,8 +864,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, "UseDualStack": true, + "UseFIPS": false, "Region": "us-east-1", "Endpoint": "https://example.com" } diff --git a/tests/functional/endpoint-rules/lightsail/endpoint-tests-1.json b/tests/functional/endpoint-rules/lightsail/endpoint-tests-1.json index 26e14e9d4e..ef08304645 100644 --- a/tests/functional/endpoint-rules/lightsail/endpoint-tests-1.json +++ b/tests/functional/endpoint-rules/lightsail/endpoint-tests-1.json @@ -9,8 +9,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -22,8 +22,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -35,8 +35,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -48,8 +48,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -61,8 +61,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -74,8 +74,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -87,8 +87,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -100,8 +100,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -113,8 +113,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -126,8 +126,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -139,8 +139,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -152,8 +152,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -165,8 +165,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -178,8 +178,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -191,8 +191,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -204,8 +204,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -217,8 +217,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -230,8 +230,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -243,8 +243,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -256,8 +256,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -269,8 +269,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -282,8 +282,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -295,8 +295,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -308,8 +308,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -321,8 +321,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -334,8 +334,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -347,8 +347,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -360,8 +360,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -373,12 +373,12 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -386,8 +386,21 @@ }, "params": { "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -398,8 +411,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -410,8 +423,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/tests/functional/endpoint-rules/managedblockchain/endpoint-tests-1.json b/tests/functional/endpoint-rules/managedblockchain/endpoint-tests-1.json index bd1d94336c..b9af713af6 100644 --- a/tests/functional/endpoint-rules/managedblockchain/endpoint-tests-1.json +++ b/tests/functional/endpoint-rules/managedblockchain/endpoint-tests-1.json @@ -1,371 +1,294 @@ { "testCases": [ { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.eu-west-2.amazonaws.com" + "url": "https://managedblockchain.ap-northeast-1.amazonaws.com" } }, "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "ap-northeast-1" } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.eu-west-2.amazonaws.com" + "url": "https://managedblockchain.ap-northeast-2.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "ap-northeast-2" } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.eu-west-1.api.aws" + "url": "https://managedblockchain.ap-southeast-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.eu-west-1.amazonaws.com" + "url": "https://managedblockchain.eu-west-1.amazonaws.com" } }, "params": { "UseDualStack": false, - "UseFIPS": true, + "UseFIPS": false, "Region": "eu-west-1" } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.eu-west-1.api.aws" + "url": "https://managedblockchain.eu-west-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-2" } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.eu-west-1.amazonaws.com" + "url": "https://managedblockchain.us-east-1.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "us-east-1" } }, { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-northeast-2.api.aws" + "url": "https://managedblockchain-fips.us-east-1.api.aws" } }, "params": { "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "us-east-1" } }, { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-northeast-2.amazonaws.com" + "url": "https://managedblockchain-fips.us-east-1.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "us-east-1" } }, { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain.ap-northeast-2.api.aws" + "url": "https://managedblockchain.us-east-1.api.aws" } }, "params": { "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "us-east-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-northeast-1.api.aws" + "url": "https://managedblockchain-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-northeast-1.amazonaws.com" + "url": "https://managedblockchain-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain.ap-northeast-1.api.aws" + "url": "https://managedblockchain.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.ap-northeast-1.amazonaws.com" + "url": "https://managedblockchain.cn-north-1.amazonaws.com.cn" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.us-gov-west-1.api.aws" + "url": "https://managedblockchain-fips.us-gov-east-1.api.aws" } }, "params": { "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.us-gov-west-1.amazonaws.com" + "url": "https://managedblockchain-fips.us-gov-east-1.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain.us-gov-west-1.api.aws" + "url": "https://managedblockchain.us-gov-east-1.api.aws" } }, "params": { "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.us-gov-west-1.amazonaws.com" + "url": "https://managedblockchain.us-gov-east-1.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-fips.ap-southeast-1.amazonaws.com" + "url": "https://managedblockchain-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "us-iso-east-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.ap-southeast-1.amazonaws.com" + "url": "https://managedblockchain.us-iso-east-1.c2s.ic.gov" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "us-iso-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-fips.us-east-1.amazonaws.com" + "url": "https://managedblockchain-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-isob-east-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.us-east-1.api.aws" + "url": "https://managedblockchain.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-isob-east-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.us-east-1.amazonaws.com" + "url": "https://example.com" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -374,7 +297,6 @@ "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, diff --git a/tests/functional/endpoint-rules/omics/endpoint-tests-1.json b/tests/functional/endpoint-rules/omics/endpoint-tests-1.json index 485293e391..4770b5497f 100644 --- a/tests/functional/endpoint-rules/omics/endpoint-tests-1.json +++ b/tests/functional/endpoint-rules/omics/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -21,9 +21,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -34,9 +34,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -47,9 +47,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -60,9 +60,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -73,9 +73,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -86,9 +86,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -99,9 +99,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -110,9 +110,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -123,9 +123,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -134,9 +134,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -147,9 +147,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -160,9 +160,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -173,9 +173,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -186,9 +186,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -199,9 +199,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -210,9 +210,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -223,9 +223,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -234,9 +234,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -247,9 +247,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -260,9 +260,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -272,9 +272,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -284,9 +284,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } }