diff --git a/codegen/sdk-codegen/aws-models/frauddetector.json b/codegen/sdk-codegen/aws-models/frauddetector.json index 2343d1eeb6d..0b6adcd8d40 100644 --- a/codegen/sdk-codegen/aws-models/frauddetector.json +++ b/codegen/sdk-codegen/aws-models/frauddetector.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -103,24 +103,6 @@ }, "com.amazonaws.frauddetector#AWSHawksNestServiceFacade": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "FraudDetector", - "arnNamespace": "frauddetector", - "cloudFormationName": "FraudDetector", - "cloudTrailEventSource": "frauddetector.amazonaws.com", - "endpointPrefix": "frauddetector" - }, - "aws.auth#sigv4": { - "name": "frauddetector" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "
This is the Amazon Fraud Detector API Reference. This guide is for developers who need\n detailed information about Amazon Fraud Detector API actions, data types, and errors. For\n more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.
\n \nWe provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.
\nThe Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action
. AWS SDK provides libraries, \n sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over \n HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and \n handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see Tools to build on AWS.\n
This is the Amazon Fraud Detector API Reference. This guide is for developers who need\n detailed information about Amazon Fraud Detector API actions, data types, and errors. For\n more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.
\n \nWe provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.
\nThe Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action
. AWS SDK provides libraries, \n sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over \n HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and \n handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see Tools to build on AWS.\n
The error code.
" } }, @@ -563,6 +1244,7 @@ "code": { "target": "com.amazonaws.frauddetector#Integer2", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The error code.
" } }, @@ -809,10 +1491,7 @@ } }, "com.amazonaws.frauddetector#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.frauddetector#CancelBatchImportJob": { "type": "operation", @@ -983,7 +1662,7 @@ "iamRoleArn": { "target": "com.amazonaws.frauddetector#iamRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role created for Amazon S3 bucket that holds your data file. \n The IAM role must have read and write permissions to both input and output S3 buckets.
", + "smithy.api#documentation": "The ARN of the IAM role created for Amazon S3 bucket that holds your data file.
\nThe IAM role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket.\n For more information about bucket permissions, see User policy examples in the \n Amazon S3 User Guide.
", "smithy.api#required": {} } }, @@ -1075,7 +1754,7 @@ "iamRoleArn": { "target": "com.amazonaws.frauddetector#iamRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role to use for this job request.
", + "smithy.api#documentation": "The ARN of the IAM role to use for this job request.
\nThe IAM Role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket.\n For more information about bucket permissions, see User policy examples in the \n Amazon S3 User Guide.
", "smithy.api#required": {} } }, @@ -1549,45 +2228,55 @@ } }, "com.amazonaws.frauddetector#DataSource": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EVENT", - "name": "EVENT" - }, - { - "value": "MODEL_SCORE", - "name": "MODEL_SCORE" - }, - { - "value": "EXTERNAL_MODEL_SCORE", - "name": "EXTERNAL_MODEL_SCORE" + "type": "enum", + "members": { + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + }, + "MODEL_SCORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_SCORE" + } + }, + "EXTERNAL_MODEL_SCORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL_MODEL_SCORE" } - ] + } } }, "com.amazonaws.frauddetector#DataType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STRING", - "name": "STRING" - }, - { - "value": "INTEGER", - "name": "INTEGER" - }, - { - "value": "FLOAT", - "name": "FLOAT" - }, - { - "value": "BOOLEAN", - "name": "BOOLEAN" + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGER" + } + }, + "FLOAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOAT" } - ] + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + } } }, "com.amazonaws.frauddetector#DataValidationMetrics": { @@ -1611,10 +2300,7 @@ } }, "com.amazonaws.frauddetector#DeleteAuditHistory": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.frauddetector#DeleteBatchImportJob": { "type": "operation", @@ -2559,7 +3245,6 @@ "com.amazonaws.frauddetector#DetectorVersionMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1000, "max": 2500 @@ -2567,22 +3252,26 @@ } }, "com.amazonaws.frauddetector#DetectorVersionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DRAFT", - "name": "DRAFT" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "INACTIVE", - "name": "INACTIVE" + "type": "enum", + "members": { + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" } - ] + } } }, "com.amazonaws.frauddetector#DetectorVersionSummary": { @@ -2626,7 +3315,6 @@ "com.amazonaws.frauddetector#DetectorsMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 5, "max": 10 @@ -2874,18 +3562,20 @@ } }, "com.amazonaws.frauddetector#EventIngestion": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } - ] + } } }, "com.amazonaws.frauddetector#EventPredictionSummary": { @@ -2935,7 +3625,6 @@ "com.amazonaws.frauddetector#EventPredictionsMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 50, "max": 100 @@ -3205,7 +3894,6 @@ "com.amazonaws.frauddetector#ExternalModelsMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 5, "max": 10 @@ -4867,14 +5555,14 @@ } }, "com.amazonaws.frauddetector#Integer": { + "type": "integer" + }, + "com.amazonaws.frauddetector#Integer2": { "type": "integer", "traits": { - "smithy.api#box": {} + "smithy.api#default": 0 } }, - "com.amazonaws.frauddetector#Integer2": { - "type": "integer" - }, "com.amazonaws.frauddetector#InternalServerException": { "type": "structure", "members": { @@ -4983,14 +5671,14 @@ } }, "com.amazonaws.frauddetector#Language": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DETECTORPL", - "name": "DETECTORPL" + "type": "enum", + "members": { + "DETECTORPL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETECTORPL" } - ] + } } }, "com.amazonaws.frauddetector#ListEventPredictions": { @@ -5268,10 +5956,7 @@ } }, "com.amazonaws.frauddetector#Long": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.frauddetector#MapOfStrings": { "type": "map", @@ -5388,18 +6073,20 @@ } }, "com.amazonaws.frauddetector#ModelEndpointStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASSOCIATED", - "name": "ASSOCIATED" - }, - { - "value": "DISSOCIATED", - "name": "DISSOCIATED" + "type": "enum", + "members": { + "ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED" } - ] + }, + "DISSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISSOCIATED" + } + } } }, "com.amazonaws.frauddetector#ModelInputConfiguration": { @@ -5442,18 +6129,20 @@ } }, "com.amazonaws.frauddetector#ModelInputDataFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TEXT_CSV", - "name": "CSV" - }, - { - "value": "APPLICATION_JSON", - "name": "JSON" + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_CSV" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION_JSON" } - ] + } } }, "com.amazonaws.frauddetector#ModelOutputConfiguration": { @@ -5484,18 +6173,20 @@ } }, "com.amazonaws.frauddetector#ModelOutputDataFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TEXT_CSV", - "name": "CSV" - }, - { - "value": "APPLICATION_JSONLINES", - "name": "JSONLINES" + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_CSV" } - ] + }, + "JSONLINES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION_JSONLINES" + } + } } }, "com.amazonaws.frauddetector#ModelPredictionMap": { @@ -5528,33 +6219,37 @@ } }, "com.amazonaws.frauddetector#ModelSource": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SAGEMAKER", - "name": "SAGEMAKER" + "type": "enum", + "members": { + "SAGEMAKER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAGEMAKER" } - ] + } } }, "com.amazonaws.frauddetector#ModelTypeEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ONLINE_FRAUD_INSIGHTS", - "name": "ONLINE_FRAUD_INSIGHTS" - }, - { - "value": "TRANSACTION_FRAUD_INSIGHTS", - "name": "TRANSACTION_FRAUD_INSIGHTS" - }, - { - "value": "ACCOUNT_TAKEOVER_INSIGHTS", - "name": "ACCOUNT_TAKEOVER_INSIGHTS" + "type": "enum", + "members": { + "ONLINE_FRAUD_INSIGHTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONLINE_FRAUD_INSIGHTS" + } + }, + "TRANSACTION_FRAUD_INSIGHTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSACTION_FRAUD_INSIGHTS" + } + }, + "ACCOUNT_TAKEOVER_INSIGHTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_TAKEOVER_INSIGHTS" } - ] + } } }, "com.amazonaws.frauddetector#ModelVersion": { @@ -5705,22 +6400,26 @@ } }, "com.amazonaws.frauddetector#ModelVersionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "INACTIVE", - "name": "INACTIVE" - }, - { - "value": "TRAINING_CANCELLED", - "name": "TRAINING_CANCELLED" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" } - ] + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "TRAINING_CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING_CANCELLED" + } + } } }, "com.amazonaws.frauddetector#NameList": { @@ -5865,7 +6564,6 @@ "com.amazonaws.frauddetector#OutcomesMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 50, "max": 100 @@ -6242,7 +6940,7 @@ "kmsEncryptionKeyArn": { "target": "com.amazonaws.frauddetector#KmsEncryptionKeyArn", "traits": { - "smithy.api#documentation": "The KMS encryption key ARN.
", + "smithy.api#documentation": "The KMS encryption key ARN.
\nThe KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.
", "smithy.api#required": {} } } @@ -6499,18 +7197,20 @@ } }, "com.amazonaws.frauddetector#RuleExecutionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALL_MATCHED", - "name": "ALL_MATCHED" - }, - { - "value": "FIRST_MATCHED", - "name": "FIRST_MATCHED" + "type": "enum", + "members": { + "ALL_MATCHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_MATCHED" + } + }, + "FIRST_MATCHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRST_MATCHED" } - ] + } } }, "com.amazonaws.frauddetector#RuleList": { @@ -6542,7 +7242,6 @@ "com.amazonaws.frauddetector#RulesMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 50, "max": 100 @@ -6783,7 +7482,6 @@ "com.amazonaws.frauddetector#TagsMaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 50, "max": 50 @@ -6825,18 +7523,20 @@ } }, "com.amazonaws.frauddetector#TrainingDataSourceEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EXTERNAL_EVENTS", - "name": "EXTERNAL_EVENTS" - }, - { - "value": "INGESTED_EVENTS", - "name": "INGESTED_EVENTS" + "type": "enum", + "members": { + "EXTERNAL_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL_EVENTS" } - ] + }, + "INGESTED_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTED_EVENTS" + } + } } }, "com.amazonaws.frauddetector#TrainingMetrics": { @@ -6938,22 +7638,26 @@ } }, "com.amazonaws.frauddetector#UnlabeledEventsTreatment": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IGNORE", - "name": "IGNORE" - }, - { - "value": "FRAUD", - "name": "FRAUD" - }, - { - "value": "LEGIT", - "name": "LEGIT" + "type": "enum", + "members": { + "IGNORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE" + } + }, + "FRAUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRAUD" + } + }, + "LEGIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGIT" } - ] + } } }, "com.amazonaws.frauddetector#UntagResource": { @@ -7203,7 +7907,7 @@ "status": { "target": "com.amazonaws.frauddetector#DetectorVersionStatus", "traits": { - "smithy.api#documentation": "The new status.
", + "smithy.api#documentation": "The new status.
\nThe only supported values are ACTIVE
and INACTIVE
\n
The Amazon S3 location being used to capture the data.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the batch transform job.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
\n
Flag that indicates whether to append inference id to the output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration to control how SageMaker captures inference data for batch transform jobs.
" + } + }, "com.amazonaws.sagemaker#BatchDescribeModelPackage": { "type": "operation", "input": { @@ -3118,6 +3146,83 @@ } } }, + "com.amazonaws.sagemaker#BatchTransformInput": { + "type": "structure", + "members": { + "DataCapturedDestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 location being used to capture the data.
", + "smithy.api#required": {} + } + }, + "DatasetFormat": { + "target": "com.amazonaws.sagemaker#MonitoringDatasetFormat", + "traits": { + "smithy.api#documentation": "The dataset format for your batch transform job.
", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#documentation": "Path to the filesystem where the batch transform data is available to the container.
", + "smithy.api#required": {} + } + }, + "S3InputMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", + "traits": { + "smithy.api#documentation": "Whether the Pipe
or File
is used as the input mode for\n transferring data for the monitoring job. Pipe
mode is recommended for large\n datasets. File
mode is useful for small files that fit in memory. Defaults to\n File
.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.\n Defaults to FullyReplicated
\n
The attributes of the input data that are the input features.
" + } + }, + "InferenceAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The attribute of the input data that represents the ground truth label.
" + } + }, + "ProbabilityAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "In a classification problem, the attribute that represents the class probability.
" + } + }, + "ProbabilityThresholdAttribute": { + "target": "com.amazonaws.sagemaker#ProbabilityThresholdAttribute", + "traits": { + "smithy.api#documentation": "The threshold for the class probability to be evaluated as a positive result.
" + } + }, + "StartTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "If specified, monitoring jobs substract this time from the start time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + } + }, + "EndTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "If specified, monitoring jobs substract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input object for the batch transform job.
" + } + }, "com.amazonaws.sagemaker#Bias": { "type": "structure", "members": { @@ -9008,6 +9113,12 @@ "smithy.api#required": {} } }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig", + "traits": { + "smithy.api#documentation": "Configuration to control how SageMaker captures inference data.
" + } + }, "TransformResources": { "target": "com.amazonaws.sagemaker#TransformResources", "traits": { @@ -9769,9 +9880,12 @@ "type": "structure", "members": { "EndpointInput": { - "target": "com.amazonaws.sagemaker#EndpointInput", + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "Input object for the batch transform job.
" } } }, @@ -16930,6 +17044,12 @@ "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.
" } }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig", + "traits": { + "smithy.api#documentation": "Configuration to control how SageMaker captures inference data.
" + } + }, "TransformResources": { "target": "com.amazonaws.sagemaker#TransformResources", "traits": { @@ -30754,9 +30874,12 @@ "type": "structure", "members": { "EndpointInput": { - "target": "com.amazonaws.sagemaker#EndpointInput", + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "Input object for the batch transform job.
" } }, "GroundTruthS3Input": { @@ -30946,9 +31069,12 @@ "type": "structure", "members": { "EndpointInput": { - "target": "com.amazonaws.sagemaker#EndpointInput", + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "Input object for the batch transform job.
" } } }, @@ -31982,9 +32108,12 @@ "type": "structure", "members": { "EndpointInput": { - "target": "com.amazonaws.sagemaker#EndpointInput", + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "Input object for the batch transform job.
" } }, "GroundTruthS3Input": { @@ -32191,6 +32320,47 @@ } } }, + "com.amazonaws.sagemaker#MonitoringCsvDatasetFormat": { + "type": "structure", + "members": { + "Header": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates if the CSV data has a header.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the CSV dataset format used when running a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringDatasetFormat": { + "type": "structure", + "members": { + "Csv": { + "target": "com.amazonaws.sagemaker#MonitoringCsvDatasetFormat", + "traits": { + "smithy.api#documentation": "The CSV dataset used in the monitoring job.
" + } + }, + "Json": { + "target": "com.amazonaws.sagemaker#MonitoringJsonDatasetFormat", + "traits": { + "smithy.api#documentation": "The JSON dataset used in the monitoring job
" + } + }, + "Parquet": { + "target": "com.amazonaws.sagemaker#MonitoringParquetDatasetFormat", + "traits": { + "smithy.api#documentation": "The Parquet dataset used in the monitoring job
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the dataset format used when running a monitoring job.
" + } + }, "com.amazonaws.sagemaker#MonitoringEnvironmentMap": { "type": "map", "key": { @@ -32328,8 +32498,13 @@ "EndpointInput": { "target": "com.amazonaws.sagemaker#EndpointInput", "traits": { - "smithy.api#documentation": "The endpoint for a monitoring job.
", - "smithy.api#required": {} + "smithy.api#documentation": "The endpoint for a monitoring job.
" + } + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "Input object for the batch transform job.
" } } }, @@ -32495,6 +32670,21 @@ "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummary" } }, + "com.amazonaws.sagemaker#MonitoringJsonDatasetFormat": { + "type": "structure", + "members": { + "Line": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates if the file should be read as a json object per line.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the JSON dataset format used when running a monitoring job.
" + } + }, "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds": { "type": "integer", "traits": { @@ -32578,6 +32768,13 @@ } } }, + "com.amazonaws.sagemaker#MonitoringParquetDatasetFormat": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Represents the Parquet dataset format used when running a monitoring job.
" + } + }, "com.amazonaws.sagemaker#MonitoringProblemType": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/servicediscovery.json b/codegen/sdk-codegen/aws-models/servicediscovery.json index e30f6882b10..2f36df0fea5 100644 --- a/codegen/sdk-codegen/aws-models/servicediscovery.json +++ b/codegen/sdk-codegen/aws-models/servicediscovery.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -105,7 +105,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a\n DiscoverInstances
request but can't be discovered using DNS.
For the current quota on the number of namespaces that you can create using the same account,\n see Cloud Map quotas in the\n Cloud Map Developer Guide.
" + "smithy.api#documentation": "Creates an HTTP namespace. Service instances registered using an HTTP namespace can be\n discovered using a DiscoverInstances
request but can't be discovered using\n DNS.
For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.
" } }, "com.amazonaws.servicediscovery#CreateHttpNamespaceRequest": { @@ -121,7 +121,7 @@ "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that identifies the request and that allows failed CreateHttpNamespace
requests to\n be retried without the risk of running the operation twice. CreatorRequestId
can be any unique string\n (for example, a date/time stamp).
A unique string that identifies the request and that allows failed\n CreateHttpNamespace
requests to be retried without the risk of running the\n operation twice. CreatorRequestId
can be any unique string (for example, a date/time\n stamp).
The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" + "smithy.api#documentation": "The tags to add to the namespace. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" } } } @@ -176,7 +176,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace\n defines your service naming scheme. For example, if you name your namespace example.com
and name your\n service backend
, the resulting DNS name for the service is backend.example.com
. Service\n instances that are registered using a private DNS namespace can be discovered using either a\n DiscoverInstances
request or using DNS. For the current quota on the number of namespaces that you can\n create using the same account, see Cloud Map quotas in the\n Cloud Map Developer Guide.
Creates a private namespace based on DNS, which is visible only inside a specified Amazon\n VPC. The namespace defines your service naming scheme. For example, if you name your namespace\n example.com
and name your service backend
, the resulting DNS name for\n the service is backend.example.com
. Service instances that are registered using a\n private DNS namespace can be discovered using either a DiscoverInstances
request or\n using DNS. For the current quota on the number of namespaces that you can create using the same\n Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.
The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map\n automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.
", + "smithy.api#documentation": "The name that you want to assign to this namespace. When you create a private DNS namespace,\n Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the\n namespace.
", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace
\n requests to be retried without the risk of running the operation twice. CreatorRequestId
can be any\n unique string (for example, a date/timestamp).
A unique string that identifies the request and that allows failed\n CreatePrivateDnsNamespace
requests to be retried without the risk of running the\n operation twice. CreatorRequestId
can be any unique string (for example, a\n date/timestamp).
The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" + "smithy.api#documentation": "The tags to add to the namespace. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties", "traits": { - "smithy.api#documentation": "Properties for the private DNS\n namespace.
" + "smithy.api#documentation": "Properties for the\n private DNS namespace.
" } } } @@ -260,7 +260,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service\n naming scheme. For example, if you name your namespace example.com
and name your service\n backend
, the resulting DNS name for the service is backend.example.com
. You can discover\n instances that were registered with a public DNS namespace by using either a DiscoverInstances
request\n or using DNS. For the current quota on the number of namespaces that you can create using the same account, see Cloud Map\n quotas in the Cloud Map Developer Guide.
Creates a public namespace based on DNS, which is visible on the internet. The namespace\n defines your service naming scheme. For example, if you name your namespace\n example.com
and name your service backend
, the resulting DNS name for\n the service is backend.example.com
. You can discover instances that were registered\n with a public DNS namespace by using either a DiscoverInstances
request or using\n DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.
The CreatePublicDnsNamespace
API operation is not supported in the Amazon Web Services GovCloud (US) Regions.
The name that you want to assign to this namespace.
", + "smithy.api#documentation": "The name that you want to assign to this namespace.
\n \nDo not include sensitive information in the name. The name is publicly available using DNS queries.
\nA unique string that identifies the request and that allows failed CreatePublicDnsNamespace
\n requests to be retried without the risk of running the operation twice. CreatorRequestId
can be any\n unique string (for example, a date/timestamp).
A unique string that identifies the request and that allows failed\n CreatePublicDnsNamespace
requests to be retried without the risk of running the\n operation twice. CreatorRequestId
can be any unique string (for example, a\n date/timestamp).
The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" + "smithy.api#documentation": "The tags to add to the namespace. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties", "traits": { - "smithy.api#documentation": "Properties for the public DNS\n namespace.
" + "smithy.api#documentation": "Properties for the\n public DNS namespace.
" } } } @@ -306,7 +306,7 @@ "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.
" + "smithy.api#documentation": "A value that you can use to determine whether the request completed successfully. To get the\n status of the operation, see GetOperation.
" } } } @@ -337,7 +337,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a service. This action defines the configuration for the following entities:
\nFor public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
\n\n A
\n
\n AAAA
\n
\n A
and AAAA
\n
\n SRV
\n
\n CNAME
\n
Optionally, a health check
\nAfter you create the service, you can submit a RegisterInstance request, and Cloud Map uses the\n values in the configuration to create the specified entities.
\nFor the current quota on the number of instances that you can register using the same namespace and using the\n same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.
" + "smithy.api#documentation": "Creates a service. This action defines the configuration for the following entities:
\nFor public and private DNS namespaces, one of the following combinations of DNS records in\n Amazon Route 53:
\n\n A
\n
\n AAAA
\n
\n A
and AAAA
\n
\n SRV
\n
\n CNAME
\n
Optionally, a health check
\nAfter you create the service, you can submit a RegisterInstance request, and\n Cloud Map uses the values in the configuration to create the specified entities.
\nFor the current quota on the number of instances that you can register using the same\n namespace and using the same service, see Cloud Map quotas in the\n Cloud Map Developer Guide.
" } }, "com.amazonaws.servicediscovery#CreateServiceRequest": { @@ -346,20 +346,20 @@ "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { - "smithy.api#documentation": "The name that you want to assign to the service.
\nIf you want Cloud Map to create an SRV
record when you register an instance and you're using a\n system that requires a specific SRV
format, such as HAProxy, specify the following for Name
:
Start the name with an underscore (_), such as _exampleservice
.
End the name with ._protocol, such as ._tcp
.
When you register an instance, Cloud Map creates an SRV
record and assigns a name to the record by\n concatenating the service name and the namespace name (for example,
\n _exampleservice._tcp.example.com
).
For services that are accessible by DNS queries, you can't create multiple services with names that differ only\n by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished.\n However, if you use a namespace that's only accessible by API calls, then you can create services that with names\n that differ only by case.
\nThe name that you want to assign to the service.
\n \nDo not include sensitive information in the name if the namespace is discoverable by public DNS queries.
\nIf you want Cloud Map to create an SRV
record when you register an instance and you're using a\n system that requires a specific SRV
format, such as HAProxy, specify the following for Name
:
Start the name with an underscore (_), such as _exampleservice
.
End the name with ._protocol, such as ._tcp
.
When you register an instance, Cloud Map creates an SRV
record and assigns a\n name to the record by concatenating the service name and the namespace name (for example,
\n _exampleservice._tcp.example.com
).
For services that are accessible by DNS queries, you can't create multiple services with\n names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the\n same DNS name and can't be distinguished. However, if you use a namespace that's only accessible\n by API calls, then you can create services that with names that differ only by case.
\nThe ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it\n can be specified either here or in the DnsConfig
object.
The ID of the namespace that you want to use to create the service. The namespace ID must be\n specified, but it can be specified either here or in the DnsConfig
object.
A unique string that identifies the request and that allows failed CreateService
requests to be\n retried without the risk of running the operation twice. CreatorRequestId
can be any unique string (for\n example, a date/timestamp).
A unique string that identifies the request and that allows failed\n CreateService
requests to be retried without the risk of running the operation\n twice. CreatorRequestId
can be any unique string (for example, a\n date/timestamp).
A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you\n register an instance.
" + "smithy.api#documentation": "A complex type that contains information about the Amazon Route 53 records that you want\n Cloud Map to create when you register an instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the\n Route 53 DNS records that you specify in DnsConfig
.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or\n HealthCheckConfig
but not both.
For information about the charges for health checks, see Cloud Map Pricing.
" + "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains\n settings for an optional Route 53 health check. If you specify settings for a health check,\n Cloud Map associates the health check with all the Route 53 DNS records that you specify in\n DnsConfig
.
If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig
or HealthCheckConfig
but not both.
For information about the charges for health checks, see Cloud Map Pricing.
" } }, "HealthCheckCustomConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { - "smithy.api#documentation": "A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig
or\n HealthCheckConfig
but not both.
You can't add, update, or delete a HealthCheckCustomConfig
configuration from an existing\n service.
A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either\n HealthCheckCustomConfig
or HealthCheckConfig
but not both.
You can't add, update, or delete a HealthCheckCustomConfig
configuration from\n an existing service.
The tags to add to the service. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" + "smithy.api#documentation": "The tags to add to the service. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.
" } }, "Type": { "target": "com.amazonaws.servicediscovery#ServiceTypeOption", "traits": { - "smithy.api#documentation": "If present, specifies that the service instances are only discoverable using the DiscoverInstances
\n API operation. No DNS records is registered for the service instances. The only valid value is\n HTTP
.
If present, specifies that the service instances are only discoverable using the\n DiscoverInstances
API operation. No DNS records is registered for the service\n instances. The only valid value is HTTP
.
The health check for the instance that's specified by ServiceId
and InstanceId
isn't a\n custom health check.
The health check for the instance that's specified by ServiceId
and\n InstanceId
isn't a custom health check.
Deletes a namespace from the current account. If the namespace still contains one or more services, the request\n fails.
" + "smithy.api#documentation": "Deletes a namespace from the current account. If the namespace still contains one or more\n services, the request fails.
" } }, "com.amazonaws.servicediscovery#DeleteNamespaceRequest": { @@ -509,7 +511,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified service. If the service still contains one or more registered instances, the request\n fails.
" + "smithy.api#documentation": "Deletes a specified service. If the service still contains one or more registered instances,\n the request fails.
" } }, "com.amazonaws.servicediscovery#DeleteServiceRequest": { @@ -554,7 +556,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified\n instance.
" + "smithy.api#documentation": "Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the\n specified instance.
" } }, "com.amazonaws.servicediscovery#DeregisterInstanceRequest": { @@ -610,7 +612,7 @@ } ], "traits": { - "smithy.api#documentation": "Discovers registered instances for a specified namespace and service. You can use DiscoverInstances
\n to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries\n to discover instances.
Discovers registered instances for a specified namespace and service. You can use\n DiscoverInstances
to discover instances for any type of namespace. For public and\n private DNS namespaces, you can also use DNS queries to discover instances.
The HttpName
name of the namespace. It's found in the HttpProperties
member of the\n Properties
member of the namespace.
The HttpName
name of the namespace. It's found in the\n HttpProperties
member of the Properties
member of the\n namespace.
The maximum number of instances that you want Cloud Map to return in the response to a\n DiscoverInstances
request. If you don't specify a value for MaxResults
, Cloud Map returns up\n to 100 instances.
The maximum number of instances that you want Cloud Map to return in the response to a\n DiscoverInstances
request. If you don't specify a value for\n MaxResults
, Cloud Map returns up to 100 instances.
Filters to scope the results based on custom attributes for the instance (for example, {version=v1,\n az=1a}
). Only instances that match all the specified key-value pairs are returned.
Filters to scope the results based on custom attributes for the instance (for example,\n {version=v1, az=1a}
). Only instances that match all the specified key-value pairs\n are returned.
Opportunistic filters to scope the results based on custom attributes. If there are instances that match both\n the filters specified in both the QueryParameters
parameter and this parameter, all of these instances\n are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the\n QueryParameters
parameter are returned.
Opportunistic filters to scope the results based on custom attributes. If there are\n instances that match both the filters specified in both the QueryParameters
\n parameter and this parameter, all of these instances are returned. Otherwise, the filters are\n ignored, and only instances that match the filters that are specified in the\n QueryParameters
parameter are returned.
The health status of the instances that you want to discover. This parameter is ignored for services that don't\n have a health check configured, and\n all\n instances are returned.
\nReturns healthy instances.
\nReturns unhealthy instances.
\nReturns all instances.
\nReturns healthy instances, unless none are reporting a healthy state. In that case, return all instances.\n This is also called failing open.
\nThe health status of the instances that you want to discover. This parameter is ignored for\n services that don't have a health check configured, and\n all\n instances are returned.
\nReturns healthy instances.
\nReturns unhealthy instances.
\nReturns all instances.
\nReturns healthy instances, unless none are reporting a healthy state. In that case,\n return all instances. This is also called failing open.
\nA complex type that contains one HttpInstanceSummary
for each registered instance.
A complex type that contains one HttpInstanceSummary
for each registered\n instance.
The ID of the namespace to use for DNS configuration.
" + "smithy.api#documentation": "\n Use\n NamespaceId in Service instead.\n
\nThe ID of the namespace to use for DNS configuration.
" } }, "RoutingPolicy": { "target": "com.amazonaws.servicediscovery#RoutingPolicy", "traits": { - "smithy.api#documentation": "The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an\n instance and specify this service.
\nIf you want to use this service to register instances that create alias records, specify WEIGHTED
\n for the routing policy.
You can specify the following values:
\nIf you define a health check for the service and the health check is healthy, Route 53 returns the applicable\n value for up to eight instances.
\nFor example, suppose that the service includes configurations for one A
record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to\n eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP\n addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns\n the values for up to eight instances.
\nFor more information about the multivalue routing policy, see Multivalue Answer\n Routing in the Route 53 Developer Guide.
\nRoute 53 returns the applicable value from one randomly selected instance from among the instances that you\n registered using the same service. Currently, all records have the same weight, so you can't route more or less\n traffic to any instances.
\nFor example, suppose that the service includes configurations for one A
record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one\n randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS\n queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns\n the applicable value for one randomly selected instance.
\nFor more information about the weighted routing policy, see Weighted Routing in the\n Route 53 Developer Guide.
\nThe routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates\n when you register an instance and specify this service.
\nIf you want to use this service to register instances that create alias records, specify\n WEIGHTED
for the routing policy.
You can specify the following values:
\nIf you define a health check for the service and the health check is healthy, Route 53\n returns the applicable value for up to eight instances.
\nFor example, suppose that the service includes configurations for one A
\n record and a health check. You use the service to register 10 instances. Route 53 responds to DNS\n queries with IP addresses for up to eight healthy instances. If fewer than eight instances are\n healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy\n instances.
If you don't define a health check for the service, Route 53 assumes that all instances are\n healthy and returns the values for up to eight instances.
\nFor more information about the multivalue routing policy, see Multivalue\n Answer Routing in the Route 53 Developer Guide.
\nRoute 53 returns the applicable value from one randomly selected instance from among the\n instances that you registered using the same service. Currently, all records have the same\n weight, so you can't route more or less traffic to any instances.
\nFor example, suppose that the service includes configurations for one A
\n record and a health check. You use the service to register 10 instances. Route 53 responds to DNS\n queries with the IP address for one randomly selected instance from among the healthy\n instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the\n instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are\n healthy and returns the applicable value for one randomly selected instance.
\nFor more information about the weighted routing policy, see Weighted\n Routing in the Route 53 Developer Guide.
\nAn array that contains one DnsRecord
object for each Route 53 DNS record that you want Cloud Map to\n create when you register an instance.
An array that contains one DnsRecord
object for each Route 53 DNS record that you\n want Cloud Map to create when you register an instance.
A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create when\n you register an instance.
" + "smithy.api#documentation": "A complex type that contains information about the Amazon Route 53 DNS records that you want\n Cloud Map to create when you register an instance.
\nThe record types of a service can only be changed by deleting the service and recreating it\n with a new Dnsconfig
.
An array that contains one DnsRecord
object for each Route 53 record that you want Cloud Map to\n create when you register an instance.
An array that contains one DnsRecord
object for each Route 53 record that you want\n Cloud Map to create when you register an instance.
A complex type that contains information about changes to the Route 53 DNS records that Cloud Map creates when you\n register an instance.
" + "smithy.api#documentation": "A complex type that contains information about changes to the Route 53 DNS records that\n Cloud Map creates when you register an instance.
" } }, "com.amazonaws.servicediscovery#DnsProperties": { @@ -731,7 +732,7 @@ "HostedZoneId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
" + "smithy.api#documentation": "The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
" } }, "SOA": { @@ -742,7 +743,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a\n namespace.
" + "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when\n you create a namespace.
" } }, "com.amazonaws.servicediscovery#DnsRecord": { @@ -751,20 +752,20 @@ "Type": { "target": "com.amazonaws.servicediscovery#RecordType", "traits": { - "smithy.api#documentation": "The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You\n can specify values for Type
in the following combinations:
\n \n A
\n \n
\n \n AAAA
\n \n
\n \n A
\n and \n AAAA
\n \n
\n \n SRV
\n \n
\n \n CNAME
\n \n
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A
or\n AAAA
for Type
.
You specify other settings, such as the IP address for A
and AAAA
records, when you\n register an instance. For more information, see RegisterInstance.
The following values are supported:
\nRoute 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
\nRoute 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.
\nRoute 53 returns the domain name of the resource, such as www.example.com. Note the following:
\nYou specify the domain name that you want to route traffic to when you register an instance. For more\n information, see Attributes in the topic RegisterInstance.
\nYou must specify WEIGHTED
for the value of RoutingPolicy
.
You can't specify both CNAME
for Type
and settings for\n HealthCheckConfig
. If you do, the request will fail with an InvalidInput
\n error.
Route 53 returns the value for an SRV
record. The value for an SRV
record uses the\n following values:
\n priority weight port service-hostname
\n
Note the following about the values:
\nThe values of priority
and weight
are both set to 1
and can't be\n changed.
The value of port
comes from the value that you specify for the AWS_INSTANCE_PORT
\n attribute when you submit a RegisterInstance request.
The value of service-hostname
is a concatenation of the following values:
The value that you specify for InstanceId
when you register an instance.
The name of the service.
\nThe name of the namespace.
\nFor example, if the value of InstanceId
is test
, the name of the service is\n backend
, and the name of the namespace is example.com
, the value of\n service-hostname
is the following:
\n test.backend.example.com
\n
If you specify settings for an SRV
record, note the following:
If you specify values for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both in the\n RegisterInstance
request, Cloud Map automatically creates A
and/or AAAA
\n records that have the same name as the value of service-hostname
in the SRV
record.\n You can ignore these records.
If you're using a system that requires a specific SRV
format, such as HAProxy, see the Name element in the documentation about CreateService
for information about how to\n specify the correct name format.
The type of the resource, which indicates the type of value that Route 53 returns in response\n to DNS queries. You can specify values for Type
in the following\n combinations:
\n \n A
\n \n
\n \n AAAA
\n \n
\n \n A
\n and \n AAAA
\n \n
\n \n SRV
\n \n
\n \n CNAME
\n \n
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify\n A
or AAAA
for Type
.
You specify other settings, such as the IP address for A
and AAAA
\n records, when you register an instance. For more information, see RegisterInstance.
The following values are supported:
\nRoute 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
\nRoute 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.
\nRoute 53 returns the domain name of the resource, such as www.example.com. Note the\n following:
\nYou specify the domain name that you want to route traffic to when you register an\n instance. For more information, see Attributes in the topic RegisterInstance.
\nYou must specify WEIGHTED
for the value of\n RoutingPolicy
.
You can't specify both CNAME
for Type
and settings for\n HealthCheckConfig
. If you do, the request will fail with an\n InvalidInput
error.
Route 53 returns the value for an SRV
record. The value for an SRV
\n record uses the following values:
\n priority weight port service-hostname
\n
Note the following about the values:
\nThe values of priority
and weight
are both set to\n 1
and can't be changed.
The value of port
comes from the value that you specify for the\n AWS_INSTANCE_PORT
attribute when you submit a RegisterInstance\n request.
The value of service-hostname
is a concatenation of the following\n values:
The value that you specify for InstanceId
when you register an\n instance.
The name of the service.
\nThe name of the namespace.
\nFor example, if the value of InstanceId
is test
, the name of\n the service is backend
, and the name of the namespace is\n example.com
, the value of service-hostname
is the\n following:
\n test.backend.example.com
\n
If you specify settings for an SRV
record, note the following:
If you specify values for AWS_INSTANCE_IPV4
,\n AWS_INSTANCE_IPV6
, or both in the RegisterInstance
request,\n Cloud Map automatically creates A
and/or AAAA
records that have\n the same name as the value of service-hostname
in the SRV
record.\n You can ignore these records.
If you're using a system that requires a specific SRV
format, such as\n HAProxy, see the Name element in the documentation about CreateService
for information\n about how to specify the correct name format.
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
\nAlias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an alias record routes\n traffic to. If you include the AWS_ALIAS_DNS_NAME
attribute when you submit a RegisterInstance request, the\n TTL
value is ignored. Always specify a TTL for the service; you can use a service to register\n instances that create either alias or non-alias records.
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this\n record.
\nAlias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an\n alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME
attribute\n when you submit a RegisterInstance request, the\n TTL
value is ignored. Always specify a TTL for the service; you can use a service\n to register instances that create either alias or non-alias records.
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you\n register an instance.
" + "smithy.api#documentation": "A complex type that contains information about the Route 53 DNS records that you want\n Cloud Map to create when you register an instance.
" } }, "com.amazonaws.servicediscovery#DnsRecordList": { @@ -798,7 +799,6 @@ "com.amazonaws.servicediscovery#FailureThreshold": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 @@ -806,22 +806,32 @@ } }, "com.amazonaws.servicediscovery#FilterCondition": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQ", - "name": "EQ" - }, - { - "value": "IN", - "name": "IN" - }, - { - "value": "BETWEEN", - "name": "BETWEEN" + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" } - ] + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "BETWEEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BETWEEN" + } + }, + "BEGINS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEGINS_WITH" + } + } } }, "com.amazonaws.servicediscovery#FilterValue": { @@ -915,7 +925,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the current health status (Healthy
, Unhealthy
, or Unknown
) of one or\n more instances that are associated with a specified service.
There's a brief delay between when you register an instance and when the health status for the instance is\n available.
\nGets the current health status (Healthy
, Unhealthy
, or\n Unknown
) of one or more instances that are associated with a specified\n service.
There's a brief delay between when you register an instance and when the health status for\n the instance is available.
\nAn array that contains the IDs of all the instances that you want to get the health status for.
\nIf you omit Instances
, Cloud Map returns the health status for all the instances that are\n associated with the specified service.
To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
\nAn array that contains the IDs of all the instances that you want to get the health status\n for.
\nIf you omit Instances
, Cloud Map returns the health status for all the\n instances that are associated with the specified service.
To get the IDs for the instances that you've registered by using a specified service,\n submit a ListInstances request.
\nThe maximum number of instances that you want Cloud Map to return in the response to a\n GetInstancesHealthStatus
request. If you don't specify a value for MaxResults
, Cloud Map\n returns up to 100 instances.
The maximum number of instances that you want Cloud Map to return in the response to a\n GetInstancesHealthStatus
request. If you don't specify a value for\n MaxResults
, Cloud Map returns up to 100 instances.
For the first GetInstancesHealthStatus
request, omit this value.
If more than MaxResults
instances match the specified criteria, you can submit another\n GetInstancesHealthStatus
request to get the next group of results. Specify the value of\n NextToken
from the previous response in the next request.
For the first GetInstancesHealthStatus
request, omit this value.
If more than MaxResults
instances match the specified criteria, you can submit\n another GetInstancesHealthStatus
request to get the next group of results. Specify\n the value of NextToken
from the previous response in the next request.
A complex type that contains the IDs and the health status of the instances that you specified in the\n GetInstancesHealthStatus
request.
A complex type that contains the IDs and the health status of the instances that you\n specified in the GetInstancesHealthStatus
request.
If more than MaxResults
instances match the specified criteria, you can submit another\n GetInstancesHealthStatus
request to get the next group of results. Specify the value of\n NextToken
from the previous response in the next request.
If more than MaxResults
instances match the specified criteria, you can submit\n another GetInstancesHealthStatus
request to get the next group of results. Specify\n the value of NextToken
from the previous response in the next request.
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is\n healthy.
\nYou can't change the value of Type
after you create a health check.
You can create the following types of health checks:
\n\n HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits\n an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
\n\n HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53\n submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
\nIf you specify HTTPS for the value of Type
, the endpoint must support TLS v1.0 or later.
\n TCP: Route 53 tries to establish a TCP connection.
\nIf you specify TCP
for Type
, don't specify a value for\n ResourcePath
.
For more information, see How Route 53 Determines Whether\n an Endpoint Is Healthy in the Route 53 Developer Guide.
", + "smithy.api#documentation": "The type of health check that you want to create, which indicates how Route 53 determines\n whether an endpoint is healthy.
\nYou can't change the value of Type
after you create a health check.
You can create the following types of health checks:
\n\n HTTP: Route 53 tries to establish a TCP connection. If\n successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater\n and less than 400.
\n\n HTTPS: Route 53 tries to establish a TCP connection. If\n successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater\n and less than 400.
\nIf you specify HTTPS for the value of Type
, the endpoint must support TLS\n v1.0 or later.
\n TCP: Route 53 tries to establish a TCP connection.
\nIf you specify TCP
for Type
, don't specify a value for\n ResourcePath
.
For more information, see How Route 53\n Determines Whether an Endpoint Is Healthy in the\n Route 53 Developer Guide.
", "smithy.api#required": {} } }, "ResourcePath": { "target": "com.amazonaws.servicediscovery#ResourcePath", "traits": { - "smithy.api#documentation": "The path that you want Route 53 to request when performing health checks. The path can be any value that your\n endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is\n /docs/route53-health-check.html
. Route 53 automatically adds the DNS name for the service. If you don't\n specify a value for ResourcePath
, the default value is /
.
If you specify TCP
for Type
, you must not specify a value for\n ResourcePath
.
The path that you want Route 53 to request when performing health checks. The path can be any\n value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint\n is healthy. An example file is /docs/route53-health-check.html
. Route 53 automatically\n adds the DNS name for the service. If you don't specify a value for ResourcePath
,\n the default value is /
.
If you specify TCP
for Type
, you must not\n specify a value for ResourcePath
.
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current\n status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53\n Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
" + "smithy.api#documentation": "The number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or the other way around. For\n more information, see How Route 53\n Determines Whether an Endpoint Is Healthy in the\n Route 53 Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, Cloud Map associates the health check with the records\n that you specify in DnsConfig
.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or\n HealthCheckConfig
but not both.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about\n pricing for health checks, see Amazon Route 53 Pricing.
\nNote the following about configuring health checks.
\nIf DnsConfig
includes configurations for both A
and AAAA
records,\n Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint\n tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the A
and AAAA
\n records to be unhealthy.
You can't specify settings for HealthCheckConfig
when the DNSConfig
includes\n CNAME
for the value of Type
. If you do, the CreateService
request will\n fail with an InvalidInput
error.
A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request to an endpoint every\n 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health\n checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one second\n that's followed by a few seconds with no health checks at all.
\nHealth checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see\n Regions.
\nWhen you register an instance, if you include the AWS_ALIAS_DNS_NAME
attribute, Cloud Map\n creates a Route 53 alias record. Note the following:
Route 53 automatically sets EvaluateTargetHealth
to true for alias records. When\n EvaluateTargetHealth
is true, the alias record inherits the health of the referenced Amazon Web Services\n resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.
If you include HealthCheckConfig
and then use the service to register an instance that creates\n an alias record, Route 53 doesn't create the health check.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.
\n\n Public DNS and HTTP namespaces only. A complex type that contains\n settings for an optional health check. If you specify settings for a health check, Cloud Map\n associates the health check with the records that you specify in DnsConfig
.
If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig
or HealthCheckConfig
but not both.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For\n information about pricing for health checks, see Amazon Route 53 Pricing.
\nNote the following about configuring health checks.
\nIf DnsConfig
includes configurations for both A
and\n AAAA
records, Cloud Map creates a health check that uses the IPv4 address to\n check the health of the resource. If the endpoint tthat's specified by the IPv4 address is\n unhealthy, Route 53 considers both the A
and AAAA
records to be\n unhealthy.
You can't specify settings for HealthCheckConfig
when the\n DNSConfig
includes CNAME
for the value of Type
. If you\n do, the CreateService
request will fail with an InvalidInput
\n error.
A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request\n to an endpoint every 30 seconds. On average, your endpoint receives a health check request\n about every two seconds. However, health checkers don't coordinate with one another.\n Therefore, you might sometimes see several requests in one second that's followed by a few\n seconds with no health checks at all.
\nHealth checkers perform checks from all Route 53 health-checking Regions. For a list of the\n current Regions, see Regions.
\nWhen you register an instance, if you include the AWS_ALIAS_DNS_NAME
\n attribute, Cloud Map creates a Route 53 alias record. Note the following:
Route 53 automatically sets EvaluateTargetHealth
to true for alias records.\n When EvaluateTargetHealth
is true, the alias record inherits the health of the\n referenced Amazon Web Services resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.
If you include HealthCheckConfig
and then use the service to register an\n instance that creates an alias record, Route 53 doesn't create the health check.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For\n information about pricing for health checks, see Amazon Route 53 Pricing.
\nThis parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after\n receiving an UpdateInstanceCustomHealthStatus
request before changing the status of the service\n instance.
The number of 30-second intervals that you want Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus
request before it changes the health status of a service\n instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus
request with the same value before\n 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30
seconds after the first\n request to make the change.
This parameter is no longer supported and is always set to 1. Cloud Map waits for\n approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus
\n request before changing the status of the service instance.
The number of 30-second intervals that you want Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus
request before it changes the health status of a\n service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus
request with\n the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits\n 30
seconds after the first request to make the change.
A complex type that contains information about an optional custom health check. A custom health check, which\n requires that you use a third-party health checker to evaluate the health of your resources, is useful in the\n following circumstances:
\nYou can't use a health check that's defined by HealthCheckConfig
because the resource isn't\n available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC.\n (To check the health of resources in a VPC, the health checker must also be in the VPC.)
You want to use a third-party health checker regardless of where your resources are located.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig
or\n HealthCheckConfig
but not both.
To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus
request.\n Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent\n UpdateInstanceCustomHealthStatus
request.
Here's how custom health checks work:
\nYou create a service.
\nYou register an instance.
\nYou configure a third-party health checker to monitor the resource that's associated with the new instance.
\nCloud Map doesn't check the health of the resource directly.
\nThe third-party health-checker determines that the resource is unhealthy and notifies your application.
\nYour application submits an UpdateInstanceCustomHealthStatus
request.
Cloud Map waits for 30 seconds.
\nIf another UpdateInstanceCustomHealthStatus
request doesn't arrive during that time to change the\n status back to healthy, Cloud Map stops routing traffic to the resource.
A complex type that contains information about an optional custom health check. A custom\n health check, which requires that you use a third-party health checker to evaluate the health of\n your resources, is useful in the following circumstances:
\nYou can't use a health check that's defined by HealthCheckConfig
because the\n resource isn't available over the internet. For example, you can use a custom health check when\n the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health\n checker must also be in the VPC.)
You want to use a third-party health checker regardless of where your resources are\n located.
\nIf you specify a health check configuration, you can specify either\n HealthCheckCustomConfig
or HealthCheckConfig
but not both.
To change the status of a custom health check, submit an\n UpdateInstanceCustomHealthStatus
request. Cloud Map doesn't monitor the status of the\n resource, it just keeps a record of the status specified in the most recent\n UpdateInstanceCustomHealthStatus
request.
Here's how custom health checks work:
\nYou create a service.
\nYou register an instance.
\nYou configure a third-party health checker to monitor the resource that's associated with\n the new instance.
\nCloud Map doesn't check the health of the resource directly.
\nThe third-party health-checker determines that the resource is unhealthy and notifies your\n application.
\nYour application submits an UpdateInstanceCustomHealthStatus
request.
Cloud Map waits for 30 seconds.
\nIf another UpdateInstanceCustomHealthStatus
request doesn't arrive during\n that time to change the status back to healthy, Cloud Map stops routing traffic to the\n resource.
\n \n
\n
\n
The HttpName
name of the namespace. It's found in the HttpProperties
member of the\n Properties
member of the namespace.
\n \n
\n
\n
The HttpName
name of the namespace. It's found in the\n HttpProperties
member of the Properties
member of the\n namespace.
If you configured health checking in the service, the current health status of the service instance.
" + "smithy.api#documentation": "If you configured health checking in the service, the current health status of the service\n instance.
" } }, "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "If you included any attributes when you registered the instance, the values of those attributes.
" + "smithy.api#documentation": "If you included any attributes when you registered the instance, the values of those\n attributes.
" } } }, "traits": { - "smithy.api#documentation": "In a response to a DiscoverInstances request, HttpInstanceSummary
contains information about one instance that\n matches the values that you specified in the request.
In a response to a DiscoverInstances request,\n HttpInstanceSummary
contains information about one instance that matches the values\n that you specified in the request.
An updated description for the HTTP\n namespace.
", + "smithy.api#documentation": "An updated\n description for the HTTP namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated properties for the HTTP\n namespace.
" + "smithy.api#documentation": "Updated properties\n for the HTTP namespace.
" } }, "com.amazonaws.servicediscovery#HttpProperties": { @@ -1283,25 +1307,25 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "An identifier that you want to associate with the instance. Note the following:
\nIf the service that's specified by ServiceId
includes settings for an SRV
record,\n the value of InstanceId
is automatically included as part of the value for the SRV
\n record. For more information, see DnsRecord > Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that's unique among instances that you register by using\n the same service.
\nIf you specify an existing InstanceId
and ServiceId
, Cloud Map updates the existing\n DNS records. If there's also an existing health check, Cloud Map deletes the old health check and creates a new\n one.
The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks
request, for example.
An identifier that you want to associate with the instance. Note the following:
\nIf the service that's specified by ServiceId
includes settings for an\n SRV
record, the value of InstanceId
is automatically included as\n part of the value for the SRV
record. For more information, see DnsRecord >\n Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that's unique among instances that\n you register by using the same service.
\nIf you specify an existing InstanceId
and ServiceId
, Cloud Map\n updates the existing DNS records. If there's also an existing health check, Cloud Map deletes\n the old health check and creates a new one.
The health check isn't deleted immediately, so it will still appear for a while if you\n submit a ListHealthChecks
request, for example.
A unique string that identifies the request and that allows failed RegisterInstance
requests to be\n retried without the risk of executing the operation twice. You must use a unique CreatorRequestId
string\n every time you submit a RegisterInstance
request if you're registering additional instances for the same\n namespace and service. CreatorRequestId
can be any unique string (for example, a date/time\n stamp).
A unique string that identifies the request and that allows failed\n RegisterInstance
requests to be retried without the risk of executing the operation\n twice. You must use a unique CreatorRequestId
string every time you submit a\n RegisterInstance
request if you're registering additional instances for the same\n namespace and service. CreatorRequestId
can be any unique string (for example, a\n date/time stamp).
A string map that contains the following information for the service that you specify in\n ServiceId
:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nSupported attribute keys include the following:
\nIf you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify\n the DNS name that's associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that's specified by ServiceId
must include settings for an\n A
record, an AAAA
record, or both.
In the service that's specified by ServiceId
, the value of RoutingPolicy
must be\n WEIGHTED
.
If the service that's specified by ServiceId
includes HealthCheckConfig
settings,\n Cloud Map creates the health check, but it won't associate the health check with the alias record.
Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other\n than ELB load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME
, don't specify values for any of the\n AWS_INSTANCE
attributes.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address.
If the service configuration includes HealthCheckCustomConfig
, you can optionally use\n AWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,\n HEALTHY
or UNHEALTHY
. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS
, the initial status is HEALTHY
.
If the service configuration includes a CNAME
record, the domain name that you want Route 53 to\n return in response to DNS queries (for example, example.com
).
This value is required if the service specified by ServiceId
includes settings for an\n CNAME
record.
If the service configuration includes an A
record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44
).
This value is required if the service specified by ServiceId
includes settings for an\n A
record. If the service includes settings for an SRV
record, you must specify a value\n for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both.
If the service configuration includes an AAAA
record, the IPv6 address that you want Route 53 to\n return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345
).
This value is required if the service specified by ServiceId
includes settings for an\n AAAA
record. If the service includes settings for an SRV
record, you must specify a\n value for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both.
If the service includes an SRV
record, the value that you want Route 53 to return for the\n port.
If the service includes HealthCheckConfig
, the port on the endpoint that you want Route 53 to send\n requests to.
This value is required if you specified settings for an SRV
record or a Route 53 health check when\n you created the service.
A string map that contains the following information for the service that you specify in\n ServiceId
:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nDo not include sensitive information in the attributes if the namespace is discoverable by public DNS\n queries.
\nSupported attribute keys include the following:
\nIf you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing\n load balancer, specify the DNS name that's associated with the load balancer. For information\n about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that's specified by ServiceId
must\n include settings for an A
record, an AAAA
record, or both.
In the service that's specified by ServiceId
, the value of\n RoutingPolicy
must be WEIGHTED
.
If the service that's specified by ServiceId
includes\n HealthCheckConfig
settings, Cloud Map creates the health check, but it won't\n associate the health check with the alias record.
Auto naming currently doesn't support creating alias records that route traffic to\n Amazon Web Services resources other than ELB load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME
, don't specify values for\n any of the AWS_INSTANCE
attributes.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address.
If the service configuration includes HealthCheckCustomConfig
, you can\n optionally use AWS_INIT_HEALTH_STATUS
to specify the initial status of the custom\n health check, HEALTHY
or UNHEALTHY
. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS
, the initial status is HEALTHY
.
If the service configuration includes a CNAME
record, the domain name that\n you want Route 53 to return in response to DNS queries (for example,\n example.com
).
This value is required if the service specified by ServiceId
includes\n settings for an CNAME
record.
If the service configuration includes an A
record, the IPv4 address that you\n want Route 53 to return in response to DNS queries (for example, 192.0.2.44
).
This value is required if the service specified by ServiceId
includes\n settings for an A
record. If the service includes settings for an\n SRV
record, you must specify a value for AWS_INSTANCE_IPV4
,\n AWS_INSTANCE_IPV6
, or both.
If the service configuration includes an AAAA
record, the IPv6 address that\n you want Route 53 to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345
).
This value is required if the service specified by ServiceId
includes\n settings for an AAAA
record. If the service includes settings for an\n SRV
record, you must specify a value for AWS_INSTANCE_IPV4
,\n AWS_INSTANCE_IPV6
, or both.
If the service includes an SRV
record, the value that you want Route 53 to\n return for the port.
If the service includes HealthCheckConfig
, the port on the endpoint that you\n want Route 53 to send requests to.
This value is required if you specified settings for an SRV
record or a\n Route 53 health check when you created the service.
A complex type that contains information about an instance that Cloud Map creates when you submit a\n RegisterInstance
request.
A complex type that contains information about an instance that Cloud Map creates when you\n submit a RegisterInstance
request.
No instance exists with the specified ID, or the instance was recently registered, and information about the\n instance hasn't propagated yet.
", + "smithy.api#documentation": "No instance exists with the specified ID, or the instance was recently registered, and\n information about the instance hasn't propagated yet.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1362,12 +1386,12 @@ "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "A string map that contains the following information:
\nThe attributes that are associated with the instance.
\nFor each attribute, the applicable value.
\nSupported attribute keys include the following:
\nFor an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the\n load balancer.
\nThe Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID
attribute is specified,\n then the AWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address.
If the service configuration includes HealthCheckCustomConfig
, you can optionally use\n AWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,\n HEALTHY
or UNHEALTHY
. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS
, the initial status is HEALTHY
.
For a CNAME
record, the domain name that Route 53 returns in response to DNS queries (for example,\n example.com
).
For an A
record, the IPv4 address that Route 53 returns in response to DNS queries (for example,\n 192.0.2.44
).
For an AAAA
record, the IPv6 address that Route 53 returns in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345
).
For an SRV
record, the value that Route 53 returns for the port. In addition, if the service\n includes HealthCheckConfig
, the port on the endpoint that Route 53 sends requests to.
A string map that contains the following information:
\nThe attributes that are associated with the instance.
\nFor each attribute, the applicable value.
\nSupported attribute keys include the following:
\nFor an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's\n associated with the load balancer.
\nThe Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID
\n attribute is specified, then the AWS_INSTANCE_IPV4
attribute contains the primary\n private IPv4 address.
If the service configuration includes HealthCheckCustomConfig
, you can\n optionally use AWS_INIT_HEALTH_STATUS
to specify the initial status of the custom\n health check, HEALTHY
or UNHEALTHY
. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS
, the initial status is HEALTHY
.
For a CNAME
record, the domain name that Route 53 returns in response to DNS\n queries (for example, example.com
).
For an A
record, the IPv4 address that Route 53 returns in response to DNS\n queries (for example, 192.0.2.44
).
For an AAAA
record, the IPv6 address that Route 53 returns in response to DNS\n queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345
).
For an SRV
record, the value that Route 53 returns for the port. In addition,\n if the service includes HealthCheckConfig
, the port on the endpoint that Route 53\n sends requests to.
A complex type that contains information about the instances that you registered by using a specified\n service.
" + "smithy.api#documentation": "A complex type that contains information about the instances that you registered by using a\n specified service.
" } }, "com.amazonaws.servicediscovery#InstanceSummaryList": { @@ -1387,7 +1411,7 @@ } }, "traits": { - "smithy.api#documentation": "One or more specified values aren't valid. For example, a required value might be missing, a numeric value might\n be outside the allowed range, or a string value might exceed length constraints.
", + "smithy.api#documentation": "One or more specified values aren't valid. For example, a required value might be missing, a\n numeric value might be outside the allowed range, or a string value might exceed length\n constraints.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1409,7 +1433,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists summary information about the instances that you registered by using a specified service.
", + "smithy.api#documentation": "Lists summary information about the instances that you registered by using a specified\n service.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1430,13 +1454,13 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "For the first ListInstances
request, omit this value.
If more than MaxResults
instances match the specified criteria, you can submit another\n ListInstances
request to get the next group of results. Specify the value of NextToken
\n from the previous response in the next request.
For the first ListInstances
request, omit this value.
If more than MaxResults
instances match the specified criteria, you can submit\n another ListInstances
request to get the next group of results. Specify the value of\n NextToken
from the previous response in the next request.
The maximum number of instances that you want Cloud Map to return in the response to a\n ListInstances
request. If you don't specify a value for MaxResults
, Cloud Map returns up\n to 100 instances.
The maximum number of instances that you want Cloud Map to return in the response to a\n ListInstances
request. If you don't specify a value for MaxResults
,\n Cloud Map returns up to 100 instances.
Summary information about the instances that are associated with the specified service.
" + "smithy.api#documentation": "Summary information about the instances that are associated with the specified\n service.
" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "If more than MaxResults
instances match the specified criteria, you can submit another\n ListInstances
request to get the next group of results. Specify the value of NextToken
\n from the previous response in the next request.
If more than MaxResults
instances match the specified criteria, you can submit\n another ListInstances
request to get the next group of results. Specify the value of\n NextToken
from the previous response in the next request.
Lists summary information about the namespaces that were created by the current account.
", + "smithy.api#documentation": "Lists summary information about the namespaces that were created by the current Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1486,13 +1510,13 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "For the first ListNamespaces
request, omit this value.
If the response contains NextToken
, submit another ListNamespaces
request to get the\n next group of results. Specify the value of NextToken
from the previous response in the next\n request.
Cloud Map gets MaxResults
namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults
namespaces matched the specified criteria but that\n subsequent groups of MaxResults
namespaces do contain namespaces that match the criteria.
For the first ListNamespaces
request, omit this value.
If the response contains NextToken
, submit another ListNamespaces
\n request to get the next group of results. Specify the value of NextToken
from the\n previous response in the next request.
Cloud Map gets MaxResults
namespaces and then filters them based on the\n specified criteria. It's possible that no namespaces in the first MaxResults
\n namespaces matched the specified criteria but that subsequent groups of MaxResults
\n namespaces do contain namespaces that match the criteria.
The maximum number of namespaces that you want Cloud Map to return in the response to a\n ListNamespaces
request. If you don't specify a value for MaxResults
, Cloud Map returns up\n to 100 namespaces.
The maximum number of namespaces that you want Cloud Map to return in the response to a\n ListNamespaces
request. If you don't specify a value for MaxResults
,\n Cloud Map returns up to 100 namespaces.
An array that contains one NamespaceSummary
object for each namespace that matches the specified\n filter criteria.
An array that contains one NamespaceSummary
object for each namespace that\n matches the specified filter criteria.
If the response contains NextToken
, submit another ListNamespaces
request to get the\n next group of results. Specify the value of NextToken
from the previous response in the next\n request.
Cloud Map gets MaxResults
namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults
namespaces matched the specified criteria but that\n subsequent groups of MaxResults
namespaces do contain namespaces that match the criteria.
If the response contains NextToken
, submit another ListNamespaces
\n request to get the next group of results. Specify the value of NextToken
from the\n previous response in the next request.
Cloud Map gets MaxResults
namespaces and then filters them based on the\n specified criteria. It's possible that no namespaces in the first MaxResults
\n namespaces matched the specified criteria but that subsequent groups of MaxResults
\n namespaces do contain namespaces that match the criteria.
For the first ListOperations
request, omit this value.
If the response contains NextToken
, submit another ListOperations
request to get the\n next group of results. Specify the value of NextToken
from the previous response in the next\n request.
Cloud Map gets MaxResults
operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults
operations matched the specified criteria but that\n subsequent groups of MaxResults
operations do contain operations that match the criteria.
For the first ListOperations
request, omit this value.
If the response contains NextToken
, submit another ListOperations
\n request to get the next group of results. Specify the value of NextToken
from the\n previous response in the next request.
Cloud Map gets MaxResults
operations and then filters them based on the\n specified criteria. It's possible that no operations in the first MaxResults
\n operations matched the specified criteria but that subsequent groups of MaxResults
\n operations do contain operations that match the criteria.
The maximum number of items that you want Cloud Map to return in the response to a ListOperations
\n request. If you don't specify a value for MaxResults
, Cloud Map returns up to 100 operations.
The maximum number of items that you want Cloud Map to return in the response to a\n ListOperations
request. If you don't specify a value for MaxResults
,\n Cloud Map returns up to 100 operations.
A complex type that contains specifications for the operations that you want to list, for example, operations\n that you started between a specified start date and end date.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListOperations
.
A complex type that contains specifications for the operations that you want to list, for\n example, operations that you started between a specified start date and end date.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListOperations
.
If the response contains NextToken
, submit another ListOperations
request to get the\n next group of results. Specify the value of NextToken
from the previous response in the next\n request.
Cloud Map gets MaxResults
operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults
operations matched the specified criteria but that\n subsequent groups of MaxResults
operations do contain operations that match the criteria.
If the response contains NextToken
, submit another ListOperations
\n request to get the next group of results. Specify the value of NextToken
from the\n previous response in the next request.
Cloud Map gets MaxResults
operations and then filters them based on the\n specified criteria. It's possible that no operations in the first MaxResults
\n operations matched the specified criteria but that subsequent groups of MaxResults
\n operations do contain operations that match the criteria.
Lists summary information for all the services that are associated with one or more specified namespaces.
", + "smithy.api#documentation": "Lists summary information for all the services that are associated with one or more\n specified namespaces.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1610,19 +1634,19 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "For the first ListServices
request, omit this value.
If the response contains NextToken
, submit another ListServices
request to get the\n next group of results. Specify the value of NextToken
from the previous response in the next\n request.
Cloud Map gets MaxResults
services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults
services matched the specified criteria but that\n subsequent groups of MaxResults
services do contain services that match the criteria.
For the first ListServices
request, omit this value.
If the response contains NextToken
, submit another ListServices
\n request to get the next group of results. Specify the value of NextToken
from the\n previous response in the next request.
Cloud Map gets MaxResults
services and then filters them based on the\n specified criteria. It's possible that no services in the first MaxResults
services\n matched the specified criteria but that subsequent groups of MaxResults
services do\n contain services that match the criteria.
The maximum number of services that you want Cloud Map to return in the response to a ListServices
\n request. If you don't specify a value for MaxResults
, Cloud Map returns up to 100 services.
The maximum number of services that you want Cloud Map to return in the response to a\n ListServices
request. If you don't specify a value for MaxResults
,\n Cloud Map returns up to 100 services.
A complex type that contains specifications for the namespaces that you want to list services for.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListServices
.
A complex type that contains specifications for the namespaces that you want to list\n services for.
\nIf you specify more than one filter, an operation must match all filters to be returned by\n ListServices
.
An array that contains one ServiceSummary
object for each service that matches the specified filter\n criteria.
An array that contains one ServiceSummary
object for each service that matches\n the specified filter criteria.
If the response contains NextToken
, submit another ListServices
request to get the\n next group of results. Specify the value of NextToken
from the previous response in the next\n request.
Cloud Map gets MaxResults
services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults
services matched the specified criteria but that\n subsequent groups of MaxResults
services do contain services that match the criteria.
If the response contains NextToken
, submit another ListServices
\n request to get the next group of results. Specify the value of NextToken
from the\n previous response in the next request.
Cloud Map gets MaxResults
services and then filters them based on the\n specified criteria. It's possible that no services in the first MaxResults
services\n matched the specified criteria but that subsequent groups of MaxResults
services do\n contain services that match the criteria.
The type of the namespace. The methods for discovering instances depends on the value that you specify:
\nInstances can be discovered only programmatically, using the Cloud Map DiscoverInstances
\n API.
Instances can be discovered using public DNS queries and using the DiscoverInstances
API.
Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances
\n API.
The type of the namespace. The methods for discovering instances depends on the value that\n you specify:
\nInstances can be discovered only programmatically, using the Cloud Map\n DiscoverInstances
API.
Instances can be discovered using public DNS queries and using the\n DiscoverInstances
API.
Instances can be discovered using DNS queries in VPCs and using the\n DiscoverInstances
API.
A complex type that contains information that's specific to the type of the namespace.
" + "smithy.api#documentation": "A complex type that contains information that's specific to the type of the\n namespace.
" } }, "CreateDate": { "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The\n value of CreateDate
is accurate to milliseconds. For example, the value 1516925490.087
\n represents Friday, January 26, 2018 12:11:30.087 AM.
The date that the namespace was created, in Unix date/time format and Coordinated Universal\n Time (UTC). The value of CreateDate
is accurate to milliseconds. For example, the\n value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
A unique string that identifies the request and that allows failed requests to be retried without the risk of\n running an operation twice.
" + "smithy.api#documentation": "A unique string that identifies the request and that allows failed requests to be retried\n without the risk of running an operation twice.
" } } }, @@ -1793,37 +1816,49 @@ "Name": { "target": "com.amazonaws.servicediscovery#NamespaceFilterName", "traits": { - "smithy.api#documentation": "Specify TYPE
.
Specify the namespaces that you want to get using one of the following.
\n\n TYPE
: Gets the namespaces of the specified type.
\n NAME
: Gets the namespaces with the specified name.
\n HTTP_NAME
: Gets the namespaces with the specified HTTP name.
If you specify EQ
for Condition
, specify either DNS_PUBLIC
or\n DNS_PRIVATE
.
If you specify IN
for Condition
, you can specify DNS_PUBLIC
,\n DNS_PRIVATE
, or both.
Specify the values that are applicable to the value that you specify for\n Name
.
\n TYPE
: Specify HTTP
, DNS_PUBLIC
, or\n DNS_PRIVATE
.
\n NAME
: Specify the name of the namespace, which is found in\n Namespace.Name
.
\n HTTP_NAME
: Specify the HTTP name of the namespace, which is found in\n Namespace.Properties.HttpProperties.HttpName
.
The operator that you want to use to determine whether ListNamespaces
returns a namespace. Valid\n values for condition
include:
When you specify EQ
for the condition, you can choose to list only public namespaces or private\n namespaces, but not both. EQ
is the default condition and can be omitted.
When you specify IN
for the condition, you can choose to list public namespaces, private\n namespaces, or both.
Not applicable
\nSpecify the operator that you want to use to determine whether a namespace matches the\n specified value. Valid values for Condition
are one of the following.
\n EQ
: When you specify EQ
for Condition
, you can\n specify only one value. EQ
is supported for TYPE
, NAME
,\n and HTTP_NAME
. EQ
is the default condition and can be\n omitted.
\n BEGINS_WITH
: When you specify BEGINS_WITH
for\n Condition
, you can specify only one value. BEGINS_WITH
is supported\n for TYPE
, NAME
, and HTTP_NAME
.
A complex type that identifies the namespaces that you want to list. You can choose to list public or private\n namespaces.
" + "smithy.api#documentation": "A complex type that identifies the namespaces that you want to list. You can choose to list\n public or private namespaces.
" } }, "com.amazonaws.servicediscovery#NamespaceFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TYPE", - "name": "TYPE" + "type": "enum", + "members": { + "TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TYPE" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" } - ] + }, + "HTTP_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_NAME" + } + } } }, "com.amazonaws.servicediscovery#NamespaceFilters": { @@ -1859,9 +1894,9 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 1024 + "max": 253 }, - "smithy.api#pattern": "^[!-~]{1,1024}$" + "smithy.api#pattern": "^[!-~]{1,253}$" } }, "com.amazonaws.servicediscovery#NamespaceNamePublic": { @@ -1869,7 +1904,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 1024 + "max": 253 }, "smithy.api#pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$" } @@ -1893,7 +1928,7 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#DnsProperties", "traits": { - "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a\n namespace.
" + "smithy.api#documentation": "A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when\n you create a namespace.
" } }, "HttpProperties": { @@ -1931,7 +1966,7 @@ "Name": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted zone\n that has the same name as the namespace.
" + "smithy.api#documentation": "The name of the namespace. When you create a namespace, Cloud Map automatically creates a\n Route 53 hosted zone that has the same name as the namespace.
" } }, "Type": { @@ -1970,22 +2005,26 @@ } }, "com.amazonaws.servicediscovery#NamespaceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DNS_PUBLIC", - "name": "DNS_PUBLIC" - }, - { - "value": "DNS_PRIVATE", - "name": "DNS_PRIVATE" - }, - { - "value": "HTTP", - "name": "HTTP" + "type": "enum", + "members": { + "DNS_PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_PUBLIC" + } + }, + "DNS_PRIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_PRIVATE" } - ] + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + } } }, "com.amazonaws.servicediscovery#NextToken": { @@ -2021,25 +2060,25 @@ "ErrorMessage": { "target": "com.amazonaws.servicediscovery#Message", "traits": { - "smithy.api#documentation": "If the value of Status
is FAIL
, the reason that the operation failed.
If the value of Status
is FAIL
, the reason that the operation\n failed.
The code associated with ErrorMessage
. Values for ErrorCode
include the\n following:
\n ACCESS_DENIED
\n
\n CANNOT_CREATE_HOSTED_ZONE
\n
\n EXPIRED_TOKEN
\n
\n HOSTED_ZONE_NOT_FOUND
\n
\n INTERNAL_FAILURE
\n
\n INVALID_CHANGE_BATCH
\n
\n THROTTLED_REQUEST
\n
The code associated with ErrorMessage
. Values for ErrorCode
\n include the following:
\n ACCESS_DENIED
\n
\n CANNOT_CREATE_HOSTED_ZONE
\n
\n EXPIRED_TOKEN
\n
\n HOSTED_ZONE_NOT_FOUND
\n
\n INTERNAL_FAILURE
\n
\n INVALID_CHANGE_BATCH
\n
\n THROTTLED_REQUEST
\n
The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).\n The value of CreateDate
is accurate to milliseconds. For example, the value 1516925490.087
\n represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the request was submitted, in Unix date/time format and Coordinated\n Universal Time (UTC). The value of CreateDate
is accurate to milliseconds. For\n example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087\n AM.
The date and time that the value of Status
changed to the current value, in Unix date/time format\n and Coordinated Universal Time (UTC). The value of UpdateDate
is accurate to milliseconds. For example,\n the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the value of Status
changed to the current value, in\n Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate
\n is accurate to milliseconds. For example, the value 1516925490.087
represents\n Friday, January 26, 2018 12:11:30.087 AM.
Specify the operations that you want to get:
\n\n NAMESPACE_ID: Gets operations related to specified namespaces.
\n\n SERVICE_ID: Gets operations related to specified services.
\n\n STATUS: Gets operations based on the status of the operations:\n SUBMITTED
, PENDING
, SUCCEED
, or FAIL
.
\n TYPE: Gets specified types of operation.
\n\n UPDATE_DATE: Gets operations that changed status during a specified date/time\n range.
\nSpecify the operations that you want to get:
\n\n NAMESPACE_ID: Gets operations related to specified\n namespaces.
\n\n SERVICE_ID: Gets operations related to specified\n services.
\n\n STATUS: Gets operations based on the status of the\n operations: SUBMITTED
, PENDING
, SUCCEED
, or\n FAIL
.
\n TYPE: Gets specified types of operation.
\n\n UPDATE_DATE: Gets operations that changed status during a\n specified date/time range.
\nSpecify values that are applicable to the value that you specify for Name
:
\n NAMESPACE_ID: Specify one namespace ID.
\n\n SERVICE_ID: Specify one service ID.
\n\n STATUS: Specify one or more statuses: SUBMITTED
,\n PENDING
, SUCCEED
, or FAIL
.
\n TYPE: Specify one or more of the following types:\n CREATE_NAMESPACE
, DELETE_NAMESPACE
, UPDATE_SERVICE
,\n REGISTER_INSTANCE
, or DEREGISTER_INSTANCE
.
\n UPDATE_DATE: Specify a start date and an end date in Unix date/time format\n and Coordinated Universal Time (UTC). The start date must be the first value.
\nSpecify values that are applicable to the value that you specify for Name
:
\n NAMESPACE_ID: Specify one namespace ID.
\n\n SERVICE_ID: Specify one service ID.
\n\n STATUS: Specify one or more statuses:\n SUBMITTED
, PENDING
, SUCCEED
, or\n FAIL
.
\n TYPE: Specify one or more of the following types:\n CREATE_NAMESPACE
, DELETE_NAMESPACE
, UPDATE_SERVICE
,\n REGISTER_INSTANCE
, or DEREGISTER_INSTANCE
.
\n UPDATE_DATE: Specify a start date and an end date in Unix\n date/time format and Coordinated Universal Time (UTC). The start date must be the first\n value.
\nThe operator that you want to use to determine whether an operation matches the specified value. Valid values\n for condition include:
\n\n EQ
: When you specify EQ
for the condition, you can specify only one value.\n EQ
is supported for NAMESPACE_ID
, SERVICE_ID
, STATUS
, and\n TYPE
. EQ
is the default condition and can be omitted.
\n IN
: When you specify IN
for the condition, you can specify a list of one or more\n values. IN
is supported for STATUS
and TYPE
. An operation must match one of\n the specified values to be returned in the response.
\n BETWEEN
: Specify a start date and an end date in Unix date/time format and Coordinated Universal\n Time (UTC). The start date must be the first value. BETWEEN
is supported for UPDATE_DATE
.\n
The operator that you want to use to determine whether an operation matches the specified\n value. Valid values for condition include:
\n\n EQ
: When you specify EQ
for the condition, you can specify only\n one value. EQ
is supported for NAMESPACE_ID
, SERVICE_ID
,\n STATUS
, and TYPE
. EQ
is the default condition and can\n be omitted.
\n IN
: When you specify IN
for the condition, you can specify a\n list of one or more values. IN
is supported for STATUS
and\n TYPE
. An operation must match one of the specified values to be returned in the\n response.
\n BETWEEN
: Specify a start date and an end date in Unix date/time format and\n Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN
\n is supported for UPDATE_DATE
.
The status of the operation. Values include the following:
\n\n SUBMITTED: This is the initial state immediately after you submit a\n request.
\n\n PENDING: Cloud Map is performing the operation.
\n\n SUCCESS: The operation succeeded.
\n\n FAIL: The operation failed. For the failure reason, see\n ErrorMessage
.
The status of the operation. Values include the following:
\n\n SUBMITTED: This is the initial state immediately after\n you submit a request.
\n\n PENDING: Cloud Map is performing the operation.
\n\n SUCCESS: The operation succeeded.
\n\n FAIL: The operation failed. For the failure reason, see\n ErrorMessage
.
A complex type that contains information about an operation that matches the criteria that you specified in a\n ListOperations\n request.
" + "smithy.api#documentation": "A complex type that contains information about an operation that matches the criteria that\n you specified in a ListOperations request.
" } }, "com.amazonaws.servicediscovery#OperationSummaryList": { @@ -2192,22 +2245,26 @@ } }, "com.amazonaws.servicediscovery#OperationTargetType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NAMESPACE", - "name": "NAMESPACE" - }, - { - "value": "SERVICE", - "name": "SERVICE" - }, - { - "value": "INSTANCE", - "name": "INSTANCE" + "type": "enum", + "members": { + "NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE" + } + }, + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" + } + }, + "INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE" } - ] + } } }, "com.amazonaws.servicediscovery#OperationTargetsMap": { @@ -2220,34 +2277,44 @@ } }, "com.amazonaws.servicediscovery#OperationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_NAMESPACE", - "name": "CREATE_NAMESPACE" - }, - { - "value": "DELETE_NAMESPACE", - "name": "DELETE_NAMESPACE" - }, - { - "value": "UPDATE_NAMESPACE", - "name": "UPDATE_NAMESPACE" - }, - { - "value": "UPDATE_SERVICE", - "name": "UPDATE_SERVICE" - }, - { - "value": "REGISTER_INSTANCE", - "name": "REGISTER_INSTANCE" - }, - { - "value": "DEREGISTER_INSTANCE", - "name": "DEREGISTER_INSTANCE" + "type": "enum", + "members": { + "CREATE_NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_NAMESPACE" + } + }, + "DELETE_NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_NAMESPACE" + } + }, + "UPDATE_NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_NAMESPACE" + } + }, + "UPDATE_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_SERVICE" + } + }, + "REGISTER_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTER_INSTANCE" } - ] + }, + "DEREGISTER_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEREGISTER_INSTANCE" + } + } } }, "com.amazonaws.servicediscovery#PrivateDnsNamespaceChange": { @@ -2256,18 +2323,18 @@ "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "An updated description for the private\n DNS namespace.
" + "smithy.api#documentation": "An updated\n description for the private DNS namespace.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange", "traits": { - "smithy.api#documentation": "Properties to be updated in the private\n DNS namespace.
" + "smithy.api#documentation": "Properties to be\n updated in the private DNS namespace.
" } } }, "traits": { - "smithy.api#documentation": "Updated properties for the private DNS\n namespace.
" + "smithy.api#documentation": "Updated properties\n for the private DNS namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties": { @@ -2276,13 +2343,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable", "traits": { - "smithy.api#documentation": "DNS properties for the private DNS\n namespace.
", + "smithy.api#documentation": "DNS properties for\n the private DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for the private DNS\n namespace.
" + "smithy.api#documentation": "DNS properties for\n the private DNS namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange": { @@ -2291,13 +2358,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange", "traits": { - "smithy.api#documentation": "Updated DNS properties for the private\n DNS namespace.
", + "smithy.api#documentation": "Updated DNS\n properties for the private DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated properties for the private DNS\n namespace.
" + "smithy.api#documentation": "Updated properties\n for the private DNS namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable": { @@ -2306,13 +2373,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOA", "traits": { - "smithy.api#documentation": "Fields for the Start of Authority (SOA)\n record for the hosted zone for the private DNS namespace.
", + "smithy.api#documentation": "Fields for the Start\n of Authority (SOA) record for the hosted zone for the private DNS\n namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for the private DNS\n namespace.
" + "smithy.api#documentation": "DNS properties for\n the private DNS namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange": { @@ -2321,13 +2388,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOAChange", "traits": { - "smithy.api#documentation": "Updated fields for the Start of Authority\n (SOA) record for the hosted zone for the private DNS namespace.
", + "smithy.api#documentation": "Updated fields for\n the Start of Authority (SOA) record for the hosted zone for the private DNS\n namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated DNS properties for the private\n DNS namespace.
" + "smithy.api#documentation": "Updated DNS\n properties for the private DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsNamespaceChange": { @@ -2336,18 +2403,18 @@ "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "An updated description for the public DNS\n namespace.
" + "smithy.api#documentation": "An updated\n description for the public DNS namespace.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange", "traits": { - "smithy.api#documentation": "Properties to be updated in the public\n DNS namespace.
" + "smithy.api#documentation": "Properties to be\n updated in the public DNS namespace.
" } } }, "traits": { - "smithy.api#documentation": "Updated properties for the public DNS\n namespace.
" + "smithy.api#documentation": "Updated properties\n for the public DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties": { @@ -2356,13 +2423,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable", "traits": { - "smithy.api#documentation": "DNS properties for the public DNS\n namespace.
", + "smithy.api#documentation": "DNS properties for\n the public DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for the public DNS\n namespace.
" + "smithy.api#documentation": "DNS properties for\n the public DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange": { @@ -2371,13 +2438,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange", "traits": { - "smithy.api#documentation": "Updated DNS properties for the hosted\n zone for the public DNS namespace.
", + "smithy.api#documentation": "Updated DNS\n properties for the hosted zone for the public DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated properties for the public DNS\n namespace.
" + "smithy.api#documentation": "Updated properties\n for the public DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable": { @@ -2386,13 +2453,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOA", "traits": { - "smithy.api#documentation": "Start of Authority (SOA) record for the\n hosted zone for the public DNS namespace.
", + "smithy.api#documentation": "Start of Authority\n (SOA) record for the hosted zone for the public DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for the public DNS\n namespace.
" + "smithy.api#documentation": "DNS properties for\n the public DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange": { @@ -2401,19 +2468,18 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOAChange", "traits": { - "smithy.api#documentation": "Updated fields for the Start of Authority\n (SOA) record for the hosted zone for the public DNS namespace.
", + "smithy.api#documentation": "Updated fields for\n the Start of Authority (SOA) record for the hosted zone for the public DNS\n namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated DNS properties for the public DNS\n namespace.
" + "smithy.api#documentation": "Updated DNS\n properties for the public DNS namespace.
" } }, "com.amazonaws.servicediscovery#RecordTTL": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 2147483647 @@ -2421,26 +2487,32 @@ } }, "com.amazonaws.servicediscovery#RecordType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SRV", - "name": "SRV" - }, - { - "value": "A", - "name": "A" - }, - { - "value": "AAAA", - "name": "AAAA" - }, - { - "value": "CNAME", - "name": "CNAME" + "type": "enum", + "members": { + "SRV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SRV" + } + }, + "A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A" + } + }, + "AAAA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AAAA" + } + }, + "CNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CNAME" } - ] + } } }, "com.amazonaws.servicediscovery#RegisterInstance": { @@ -2469,7 +2541,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates one or more records and, optionally, creates a health check based on the settings in a\n specified service. When you submit a RegisterInstance
request, the following occurs:
For each DNS record that you define in the service that's specified by ServiceId
, a record is\n created or updated in the hosted zone that's associated with the corresponding namespace.
If the service includes HealthCheckConfig
, a health check is created based on the settings in the\n health check configuration.
The health check, if any, is associated with each of the new or updated records.
\nOne RegisterInstance
request must complete before you can submit another request and specify the\n same service ID and instance ID.
For more information, see CreateService.
\nWhen Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
\n\n If the health check is healthy: returns all the records
\n\n If the health check is unhealthy: returns the applicable value for the last\n healthy instance
\n\n If you didn't specify a health check configuration: returns all the\n records
\nFor the current quota on the number of instances that you can register using the same namespace and using the\n same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.
" + "smithy.api#documentation": "Creates or updates one or more records and, optionally, creates a health check based on the\n settings in a specified service. When you submit a RegisterInstance
request, the\n following occurs:
For each DNS record that you define in the service that's specified by\n ServiceId
, a record is created or updated in the hosted zone that's associated\n with the corresponding namespace.
If the service includes HealthCheckConfig
, a health check is created based on\n the settings in the health check configuration.
The health check, if any, is associated with each of the new or updated records.
\nOne RegisterInstance
request must complete before you can submit another\n request and specify the same service ID and instance ID.
For more information, see CreateService.
\nWhen Cloud Map receives a DNS query for the specified DNS name, it returns the applicable\n value:
\n\n If the health check is healthy: returns all the\n records
\n\n If the health check is unhealthy: returns the applicable\n value for the last healthy instance
\n\n If you didn't specify a health check configuration:\n returns all the records
\nFor the current quota on the number of instances that you can register using the same\n namespace and using the same service, see Cloud Map quotas in the\n Cloud Map Developer Guide.
" } }, "com.amazonaws.servicediscovery#RegisterInstanceRequest": { @@ -2485,21 +2557,21 @@ "InstanceId": { "target": "com.amazonaws.servicediscovery#InstanceId", "traits": { - "smithy.api#documentation": "An identifier that you want to associate with the instance. Note the following:
\nIf the service that's specified by ServiceId
includes settings for an SRV
record,\n the value of InstanceId
is automatically included as part of the value for the SRV
\n record. For more information, see DnsRecord > Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that's unique among instances that you register by using\n the same service.
\nIf you specify an existing InstanceId
and ServiceId
, Cloud Map updates the existing\n DNS records, if any. If there's also an existing health check, Cloud Map deletes the old health check and creates\n a new one.
The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks
request, for example.
An identifier that you want to associate with the instance. Note the following:
\nIf the service that's specified by ServiceId
includes settings for an\n SRV
record, the value of InstanceId
is automatically included as\n part of the value for the SRV
record. For more information, see DnsRecord >\n Type.
You can use this value to update an existing instance.
\nTo register a new instance, you must specify a value that's unique among instances that\n you register by using the same service.
\nIf you specify an existing InstanceId
and ServiceId
, Cloud Map\n updates the existing DNS records, if any. If there's also an existing health check, Cloud Map\n deletes the old health check and creates a new one.
The health check isn't deleted immediately, so it will still appear for a while if you\n submit a ListHealthChecks
request, for example.
Do not include sensitive information in InstanceId
if the namespace is discoverable by public DNS\n queries and any Type
member of DnsRecord
for the service contains SRV
because\n the InstanceId
is discoverable by public DNS queries.
A unique string that identifies the request and that allows failed RegisterInstance
requests to be\n retried without the risk of executing the operation twice. You must use a unique CreatorRequestId
string\n every time you submit a RegisterInstance
request if you're registering additional instances for the same\n namespace and service. CreatorRequestId
can be any unique string (for example, a date/time\n stamp).
A unique string that identifies the request and that allows failed\n RegisterInstance
requests to be retried without the risk of executing the operation\n twice. You must use a unique CreatorRequestId
string every time you submit a\n RegisterInstance
request if you're registering additional instances for the same\n namespace and service. CreatorRequestId
can be any unique string (for example, a\n date/time stamp).
A string map that contains the following information for the service that you specify in\n ServiceId
:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nSupported attribute keys include the following:
\nIf you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,\n specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see\n \"DNSName\" in the topic AliasTarget in the Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that's specified by ServiceId
must include settings for an\n A
record, an AAAA
record, or both.
In the service that's specified by ServiceId
, the value of RoutingPolicy
must be\n WEIGHTED
.
If the service that's specified by ServiceId
includes HealthCheckConfig
settings,\n Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias\n record.
Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services\n resources other than Elastic Load Balancing load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME
, don't specify values for any of the\n AWS_INSTANCE
attributes.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID
attribute is specified, then the only other attribute that can be specified is\n AWS_INIT_HEALTH_STATUS
. When the AWS_EC2_INSTANCE_ID
attribute is specified, then the\n AWS_INSTANCE_IPV4
attribute will be filled out with the primary private IPv4 address.
If the service configuration includes HealthCheckCustomConfig
, you can optionally use\n AWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,\n HEALTHY
or UNHEALTHY
. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS
, the initial status is HEALTHY
.
If the service configuration includes a CNAME
record, the domain name that you want Route 53 to\n return in response to DNS queries (for example, example.com
).
This value is required if the service specified by ServiceId
includes settings for an\n CNAME
record.
If the service configuration includes an A
record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44
).
This value is required if the service specified by ServiceId
includes settings for an\n A
record. If the service includes settings for an SRV
record, you must specify a value\n for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both.
If the service configuration includes an AAAA
record, the IPv6 address that you want Route 53 to\n return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345
).
This value is required if the service specified by ServiceId
includes settings for an\n AAAA
record. If the service includes settings for an SRV
record, you must specify a\n value for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both.
If the service includes an SRV
record, the value that you want Route 53 to return for the\n port.
If the service includes HealthCheckConfig
, the port on the endpoint that you want Route 53 to send\n requests to.
This value is required if you specified settings for an SRV
record or a Route 53 health check when\n you created the service.
You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is\n 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided\n attributes (sum of all keys and values) must not exceed 5,000 characters.
\nA string map that contains the following information for the service that you specify in\n ServiceId
:
The attributes that apply to the records that are defined in the service.
\nFor each attribute, the applicable value.
\nDo not include sensitive information in the attributes if the namespace is discoverable by public DNS\n queries.
\nSupported attribute keys include the following:
\nIf you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an\n Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For\n information about how to get the DNS name, see \"DNSName\" in the topic AliasTarget in the Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that's specified by ServiceId
must\n include settings for an A
record, an AAAA
record, or both.
In the service that's specified by ServiceId
, the value of\n RoutingPolicy
must be WEIGHTED
.
If the service that's specified by ServiceId
includes\n HealthCheckConfig
settings, Cloud Map will create the Route 53 health check, but\n it doesn't associate the health check with the alias record.
Auto naming currently doesn't support creating alias records that route traffic to\n Amazon Web Services resources other than Elastic Load Balancing load balancers.
\nIf you specify a value for AWS_ALIAS_DNS_NAME
, don't specify values for\n any of the AWS_INSTANCE
attributes.
\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID
attribute is specified, then the only other attribute that\n can be specified is AWS_INIT_HEALTH_STATUS
. When the\n AWS_EC2_INSTANCE_ID
attribute is specified, then the\n AWS_INSTANCE_IPV4
attribute will be filled out with the primary private IPv4\n address.
If the service configuration includes HealthCheckCustomConfig
, you can\n optionally use AWS_INIT_HEALTH_STATUS
to specify the initial status of the custom\n health check, HEALTHY
or UNHEALTHY
. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS
, the initial status is HEALTHY
.
If the service configuration includes a CNAME
record, the domain name that\n you want Route 53 to return in response to DNS queries (for example,\n example.com
).
This value is required if the service specified by ServiceId
includes\n settings for an CNAME
record.
If the service configuration includes an A
record, the IPv4 address that you\n want Route 53 to return in response to DNS queries (for example, 192.0.2.44
).
This value is required if the service specified by ServiceId
includes\n settings for an A
record. If the service includes settings for an\n SRV
record, you must specify a value for AWS_INSTANCE_IPV4
,\n AWS_INSTANCE_IPV6
, or both.
If the service configuration includes an AAAA
record, the IPv6 address that\n you want Route 53 to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345
).
This value is required if the service specified by ServiceId
includes\n settings for an AAAA
record. If the service includes settings for an\n SRV
record, you must specify a value for AWS_INSTANCE_IPV4
,\n AWS_INSTANCE_IPV6
, or both.
If the service includes an SRV
record, the value that you want Route 53 to\n return for the port.
If the service includes HealthCheckConfig
, the port on the endpoint that you\n want Route 53 to send requests to.
This value is required if you specified settings for an SRV
record or a\n Route 53 health check when you created the service.
You can add up to 30 custom attributes. For each key-value pair, the maximum length of\n the attribute name is 255 characters, and the maximum length of the attribute value is 1,024\n characters. The total size of all provided attributes (sum of all keys and values) must not\n exceed 5,000 characters.
\nThe operation can't be completed because you've reached the quota for the number of requests. For more\n information, see Cloud Map API request throttling\n quota in the Cloud Map Developer Guide.
", + "smithy.api#documentation": "The operation can't be completed because you've reached the quota for the number of\n requests. For more information, see Cloud Map API request throttling quota in the\n Cloud Map Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.servicediscovery#ResourceCount": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.servicediscovery#ResourceDescription": { "type": "string", @@ -2561,7 +2630,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified resource can't be deleted because it contains other resources. For example, you can't delete a\n service that contains any instances.
", + "smithy.api#documentation": "The specified resource can't be deleted because it contains other resources. For example,\n you can't delete a service that contains any instances.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -2574,7 +2643,7 @@ } }, "traits": { - "smithy.api#documentation": "The resource can't be created because you've reached the quota on the number of resources.
", + "smithy.api#documentation": "The resource can't be created because you've reached the quota on the number of\n resources.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2696,23 +2765,716 @@ "name": "servicediscovery" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice\n applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance\n with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and an optional\n health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer\n that contains up to eight healthy records.
", - "smithy.api#title": "AWS Cloud Map" + "smithy.api#documentation": "With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your\n microservice applications run in. When an instance becomes available, you can call the Cloud Map\n API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map\n automatically creates DNS records and an optional health check. Clients that submit public or\n private DNS queries, or HTTP requests, for the service receive an answer that contains up to\n eight healthy records.
", + "smithy.api#title": "AWS Cloud Map", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS 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" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "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": [], + "endpoint": { + "url": "https://servicediscovery-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, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "servicediscovery" + ] + } + ], + "endpoint": { + "url": "https://servicediscovery-fips.ca-central-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "servicediscovery" + ] + } + ], + "endpoint": { + "url": "https://servicediscovery-fips.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://servicediscovery-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, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://servicediscovery.{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://servicediscovery.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-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, + "Region": "us-iso-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicediscovery.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } } }, "com.amazonaws.servicediscovery#RoutingPolicy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MULTIVALUE", - "name": "MULTIVALUE" - }, - { - "value": "WEIGHTED", - "name": "WEIGHTED" + "type": "enum", + "members": { + "MULTIVALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTIVALUE" + } + }, + "WEIGHTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEIGHTED" } - ] + } } }, "com.amazonaws.servicediscovery#SOA": { @@ -2721,13 +3483,13 @@ "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "The time to live (TTL) for purposes of\n negative caching.
", + "smithy.api#documentation": "The time to live\n (TTL) for purposes of negative caching.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Start of Authority (SOA) properties for a\n public or private DNS namespace.
" + "smithy.api#documentation": "Start of Authority\n (SOA) properties for a public or private DNS namespace.
" } }, "com.amazonaws.servicediscovery#SOAChange": { @@ -2736,13 +3498,13 @@ "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "The updated time to live (TTL) for\n purposes of negative caching.
", + "smithy.api#documentation": "The updated time to\n live (TTL) for purposes of negative caching.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated Start of Authority (SOA)\n properties for a public or private DNS namespace.
" + "smithy.api#documentation": "Updated Start of\n Authority (SOA) properties for a public or private DNS namespace.
" } }, "com.amazonaws.servicediscovery#Service": { @@ -2781,43 +3543,43 @@ "InstanceCount": { "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { - "smithy.api#documentation": "The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that are deleted aren't included in the count. The count might not reflect pending\n registrations and deregistrations.
" + "smithy.api#documentation": "The number of instances that are currently associated with the service. Instances that were\n previously associated with the service but that are deleted aren't included in the count. The\n count might not reflect pending registrations and deregistrations.
" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you\n register an instance.
" + "smithy.api#documentation": "A complex type that contains information about the Route 53 DNS records that you want\n Cloud Map to create when you register an instance.
\nThe record types of a service can only be changed by deleting the service and recreating it\n with a new Dnsconfig
.
Describes the systems that can be used to discover the service instances.
\nThe service instances can be discovered using either DNS queries or the DiscoverInstances
API\n operation.
The service instances can only be discovered using the DiscoverInstances
API operation.
Reserved.
\nDescribes the systems that can be used to discover the service instances.
\nThe service instances can be discovered using either DNS queries or the\n DiscoverInstances
API operation.
The service instances can only be discovered using the DiscoverInstances
API\n operation.
Reserved.
\n\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, Cloud Map associates the health check with the records\n that you specify in DnsConfig
.
For information about the charges for health checks, see Amazon Route 53 Pricing.
" + "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains\n settings for an optional health check. If you specify settings for a health check, Cloud Map\n associates the health check with the records that you specify in DnsConfig
.
For information about the charges for health checks, see Amazon Route 53 Pricing.
" } }, "HealthCheckCustomConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { - "smithy.api#documentation": "A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig
or\n HealthCheckConfig
but not both.
A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either\n HealthCheckCustomConfig
or HealthCheckConfig
but not both.
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value\n of CreateDate
is accurate to milliseconds. For example, the value 1516925490.087
represents\n Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the service was created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreateDate
is accurate to milliseconds. For example, the\n value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
A unique string that identifies the request and that allows failed requests to be retried without the risk of\n running the operation twice. CreatorRequestId
can be any unique string (for example, a\n date/timestamp).
A unique string that identifies the request and that allows failed requests to be retried\n without the risk of running the operation twice. CreatorRequestId
can be any unique\n string (for example, a date/timestamp).
Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
" + "smithy.api#documentation": "Information about the Route 53 DNS records that you want Cloud Map to create when you register\n an instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify\n settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig
.
\n Public DNS and HTTP namespaces only. Settings for an optional health\n check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig
.
The values that are applicable to the value that you specify for Condition
to filter the list of\n services.
The values that are applicable to the value that you specify for Condition
to\n filter the list of services.
The operator that you want to use to determine whether a service is returned by ListServices
. Valid\n values for Condition
include the following:
\n EQ
: When you specify EQ
, specify one namespace ID for Values
.\n EQ
is the default condition and can be omitted.
\n IN
: When you specify IN
, specify a list of the IDs for the namespaces that you want\n ListServices
to return a list of services for.
\n BETWEEN
: Not applicable.
The operator that you want to use to determine whether a service is returned by\n ListServices
. Valid values for Condition
include the following:
\n EQ
: When you specify EQ
, specify one namespace ID for\n Values
. EQ
is the default condition and can be omitted.
A complex type that lets you specify the namespaces that you want to list services for.
" + "smithy.api#documentation": "A complex type that lets you specify the namespaces that you want to list services\n for.
" } }, "com.amazonaws.servicediscovery#ServiceFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NAMESPACE_ID", - "name": "NAMESPACE_ID" + "type": "enum", + "members": { + "NAMESPACE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE_ID" } - ] + } } }, "com.amazonaws.servicediscovery#ServiceFilters": { @@ -2973,7 +3735,7 @@ "Type": { "target": "com.amazonaws.servicediscovery#ServiceType", "traits": { - "smithy.api#documentation": "Describes the systems that can be used to discover the service instances.
\nThe service instances can be discovered using either DNS queries or the DiscoverInstances
API\n operation.
The service instances can only be discovered using the DiscoverInstances
API operation.
Reserved.
\nDescribes the systems that can be used to discover the service instances.
\nThe service instances can be discovered using either DNS queries or the\n DiscoverInstances
API operation.
The service instances can only be discovered using the DiscoverInstances
API\n operation.
Reserved.
\nThe number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that are deleted aren't included in the count. The count might not reflect pending\n registrations and deregistrations.
" + "smithy.api#documentation": "The number of instances that are currently associated with the service. Instances that were\n previously associated with the service but that are deleted aren't included in the count. The\n count might not reflect pending registrations and deregistrations.
" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
" + "smithy.api#documentation": "Information about the Route 53 DNS records that you want Cloud Map to create when you register\n an instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify\n settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig
.
\n Public DNS and HTTP namespaces only. Settings for an optional health\n check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig
.
Information about an optional custom health check. A custom health check, which requires that you use a\n third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
\nYou can't use a health check that's defined by HealthCheckConfig
because the resource isn't\n available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC.\n (To check the health of resources in a VPC, the health checker must also be in the VPC.)
You want to use a third-party health checker regardless of where your resources are located.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig
or\n HealthCheckConfig
but not both.
Information about an optional custom health check. A custom health check, which requires\n that you use a third-party health checker to evaluate the health of your resources, is useful in\n the following circumstances:
\nYou can't use a health check that's defined by HealthCheckConfig
because the\n resource isn't available over the internet. For example, you can use a custom health check when\n the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health\n checker must also be in the VPC.)
You want to use a third-party health checker regardless of where your resources are\n located.
\nIf you specify a health check configuration, you can specify either\n HealthCheckCustomConfig
or HealthCheckConfig
but not both.
The string value that's associated with the key of the tag. You can set the value of a tag to an empty string,\n but you can't set the value of a tag to null.
", + "smithy.api#documentation": "The string value that's associated with the key of the tag. You can set the value of a tag\n to an empty string, but you can't set the value of a tag to null.
", "smithy.api#required": {} } } @@ -3138,7 +3904,7 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to\n an empty string, but you can't set the value of a tag to null.
", + "smithy.api#documentation": "The tags to add to the specified resource. Specifying the tag key is required. You can set\n the value of a tag to an empty string, but you can't set the value of a tag to null.
", "smithy.api#required": {} } } @@ -3174,7 +3940,7 @@ } }, "traits": { - "smithy.api#documentation": "The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource\n is 50.
", + "smithy.api#documentation": "The list of tags on the resource is over the quota. The maximum number of tags that can be\n applied to a resource is 50.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3254,21 +4020,21 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the namespace that you want to\n update.
", + "smithy.api#documentation": "The ID of the\n namespace that you want to update.
", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that identifies the\n request and that allows failed UpdateHttpNamespace
requests to be retried without the risk of running\n the operation twice. UpdaterRequestId
can be any unique string (for example, a\n date/timestamp).
A unique string that\n identifies the request and that allows failed UpdateHttpNamespace
requests to be\n retried without the risk of running the operation twice. UpdaterRequestId
can be any\n unique string (for example, a date/timestamp).
Updated properties for the the HTTP\n namespace.
", + "smithy.api#documentation": "Updated properties\n for the the HTTP namespace.
", "smithy.api#required": {} } } @@ -3290,6 +4056,9 @@ "input": { "target": "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.servicediscovery#CustomHealthNotFound" @@ -3305,7 +4074,7 @@ } ], "traits": { - "smithy.api#documentation": "Submits a request to change the health status of a custom health check to healthy or unhealthy.
\nYou can use UpdateInstanceCustomHealthStatus
to change the status only for custom health checks,\n which you define using HealthCheckCustomConfig
when you create a service. You can't use it to change the\n status for Route 53 health checks, which you define using HealthCheckConfig
.
For more information, see HealthCheckCustomConfig.
" + "smithy.api#documentation": "Submits a request to change the health status of a custom health check to healthy or\n unhealthy.
\nYou can use UpdateInstanceCustomHealthStatus
to change the status only for\n custom health checks, which you define using HealthCheckCustomConfig
when you create\n a service. You can't use it to change the status for Route 53 health checks, which you define using\n HealthCheckConfig
.
For more information, see HealthCheckCustomConfig.
" } }, "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatusRequest": { @@ -3314,7 +4083,7 @@ "ServiceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the service that includes the configuration for the custom health check that you want to change the\n status for.
", + "smithy.api#documentation": "The ID of the service that includes the configuration for the custom health check that you\n want to change the status for.
", "smithy.api#required": {} } }, @@ -3366,21 +4135,21 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the namespace that you want to\n update.
", + "smithy.api#documentation": "The ID of the\n namespace that you want to update.
", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that identifies the\n request and that allows failed UpdatePrivateDnsNamespace
requests to be retried without the risk of\n running the operation twice. UpdaterRequestId
can be any unique string (for example, a\n date/timestamp).
A unique string that\n identifies the request and that allows failed UpdatePrivateDnsNamespace
requests to\n be retried without the risk of running the operation twice. UpdaterRequestId
can be\n any unique string (for example, a date/timestamp).
Updated properties for the private DNS\n namespace.
", + "smithy.api#documentation": "Updated properties\n for the private DNS namespace.
", "smithy.api#required": {} } } @@ -3429,21 +4198,21 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the namespace being\n updated.
", + "smithy.api#documentation": "The ID of the\n namespace being updated.
", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "A unique string that identifies the\n request and that allows failed UpdatePublicDnsNamespace
requests to be retried without the risk of\n running the operation twice. UpdaterRequestId
can be any unique string (for example, a\n date/timestamp).
A unique string that\n identifies the request and that allows failed UpdatePublicDnsNamespace
requests to\n be retried without the risk of running the operation twice. UpdaterRequestId
can be\n any unique string (for example, a date/timestamp).
Updated properties for the public DNS\n namespace.
", + "smithy.api#documentation": "Updated properties\n for the public DNS namespace.
", "smithy.api#required": {} } } @@ -3480,7 +4249,7 @@ } ], "traits": { - "smithy.api#documentation": "Submits a request to perform the following operations:
\nUpdate the TTL setting for existing DnsRecords
configurations
Add, update, or delete HealthCheckConfig
for a specified service
You can't add, update, or delete a HealthCheckCustomConfig
configuration.
For public and private DNS namespaces, note the following:
\nIf you omit any existing DnsRecords
or HealthCheckConfig
configurations from an\n UpdateService
request, the configurations are deleted from the service.
If you omit an existing HealthCheckCustomConfig
configuration from an UpdateService
\n request, the configuration isn't deleted from the service.
When you update settings for a service, Cloud Map also updates the corresponding settings in all the records\n and health checks that were created by using the specified service.
" + "smithy.api#documentation": "Submits a request to perform the following operations:
\nUpdate the TTL setting for existing DnsRecords
configurations
Add, update, or delete HealthCheckConfig
for a specified service
You can't add, update, or delete a HealthCheckCustomConfig
\n configuration.
For public and private DNS namespaces, note the following:
\nIf you omit any existing DnsRecords
or HealthCheckConfig
\n configurations from an UpdateService
request, the configurations are deleted from\n the service.
If you omit an existing HealthCheckCustomConfig
configuration from an\n UpdateService
request, the configuration isn't deleted from the service.
When you update settings for a service, Cloud Map also updates the corresponding settings\n in all the records and health checks that were created by using the specified service.
" } }, "com.amazonaws.servicediscovery#UpdateServiceRequest": { diff --git a/codegen/sdk-codegen/aws-models/sesv2.json b/codegen/sdk-codegen/aws-models/sesv2.json index 632722fe4a7..ef53a221181 100644 --- a/codegen/sdk-codegen/aws-models/sesv2.json +++ b/codegen/sdk-codegen/aws-models/sesv2.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -143,19 +143,23 @@ } }, "com.amazonaws.sesv2#BehaviorOnMxFailure": { - "type": "string", - "traits": { - "smithy.api#documentation": "The action to take if the required MX record can't be found when you send an email.\n When you set this value to UseDefaultValue
, the mail is sent using\n amazonses.com as the MAIL FROM domain. When you set this value\n to RejectMessage
, the Amazon SES API v2 returns a\n MailFromDomainNotVerified
error, and doesn't attempt to deliver the\n email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending
, Failed
, and TemporaryFailure
\n states.
The action to take if the required MX record can't be found when you send an email.\n When you set this value to UseDefaultValue
, the mail is sent using\n amazonses.com as the MAIL FROM domain. When you set this value\n to RejectMessage
, the Amazon SES API v2 returns a\n MailFromDomainNotVerified
error, and doesn't attempt to deliver the\n email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending
, Failed
, and TemporaryFailure
\n states.
The time when the blacklisting event occurred, shown in Unix time format.
" + "smithy.api#documentation": "The time when the blacklisting event occurred.
" } }, "Description": { @@ -320,66 +324,92 @@ } }, "com.amazonaws.sesv2#BulkEmailStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "MESSAGE_REJECTED", - "name": "MESSAGE_REJECTED" - }, - { - "value": "MAIL_FROM_DOMAIN_NOT_VERIFIED", - "name": "MAIL_FROM_DOMAIN_NOT_VERIFIED" - }, - { - "value": "CONFIGURATION_SET_NOT_FOUND", - "name": "CONFIGURATION_SET_NOT_FOUND" - }, - { - "value": "TEMPLATE_NOT_FOUND", - "name": "TEMPLATE_NOT_FOUND" - }, - { - "value": "ACCOUNT_SUSPENDED", - "name": "ACCOUNT_SUSPENDED" - }, - { - "value": "ACCOUNT_THROTTLED", - "name": "ACCOUNT_THROTTLED" - }, - { - "value": "ACCOUNT_DAILY_QUOTA_EXCEEDED", - "name": "ACCOUNT_DAILY_QUOTA_EXCEEDED" - }, - { - "value": "INVALID_SENDING_POOL_NAME", - "name": "INVALID_SENDING_POOL_NAME" - }, - { - "value": "ACCOUNT_SENDING_PAUSED", - "name": "ACCOUNT_SENDING_PAUSED" - }, - { - "value": "CONFIGURATION_SET_SENDING_PAUSED", - "name": "CONFIGURATION_SET_SENDING_PAUSED" - }, - { - "value": "INVALID_PARAMETER", - "name": "INVALID_PARAMETER" - }, - { - "value": "TRANSIENT_FAILURE", - "name": "TRANSIENT_FAILURE" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "MESSAGE_REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MESSAGE_REJECTED" + } + }, + "MAIL_FROM_DOMAIN_NOT_VERIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAIL_FROM_DOMAIN_NOT_VERIFIED" + } + }, + "CONFIGURATION_SET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIGURATION_SET_NOT_FOUND" + } + }, + "TEMPLATE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEMPLATE_NOT_FOUND" + } + }, + "ACCOUNT_SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_SUSPENDED" + } + }, + "ACCOUNT_THROTTLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_THROTTLED" + } + }, + "ACCOUNT_DAILY_QUOTA_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_DAILY_QUOTA_EXCEEDED" + } + }, + "INVALID_SENDING_POOL_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SENDING_POOL_NAME" + } + }, + "ACCOUNT_SENDING_PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_SENDING_PAUSED" + } + }, + "CONFIGURATION_SET_SENDING_PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIGURATION_SET_SENDING_PAUSED" + } + }, + "INVALID_PARAMETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_PARAMETER" + } + }, + "TRANSIENT_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIENT_FAILURE" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.sesv2#CampaignId": { @@ -426,7 +456,7 @@ "DefaultDimensionValue": { "target": "com.amazonaws.sesv2#DefaultDimensionValue", "traits": { - "smithy.api#documentation": "The default value of the dimension that is published to Amazon CloudWatch if you don't provide the\n value of the dimension when you send an email. This value has to meet the following\n criteria:
\nIt can only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-).
\nIt can contain no more than 256 characters.
\nThe default value of the dimension that is published to Amazon CloudWatch if you don't provide the\n value of the dimension when you send an email. This value has to meet the following\n criteria:
\nCan only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-), at signs (@), and periods (.).
\nIt can contain no more than 256 characters.
\nA boolean value status noting if the contact is unsubscribed from all contact list\n topics.
" } }, @@ -518,18 +549,20 @@ } }, "com.amazonaws.sesv2#ContactLanguage": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EN", - "name": "EN" - }, - { - "value": "JA", - "name": "JA" + "type": "enum", + "members": { + "EN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EN" + } + }, + "JA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JA" } - ] + } } }, "com.amazonaws.sesv2#ContactList": { @@ -575,18 +608,20 @@ } }, "com.amazonaws.sesv2#ContactListImportAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DELETE", - "name": "DELETE" - }, - { - "value": "PUT", - "name": "PUT" + "type": "enum", + "members": { + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" } - ] + } } }, "com.amazonaws.sesv2#ContactListName": { @@ -899,6 +934,7 @@ "UnsubscribeAll": { "target": "com.amazonaws.sesv2#UnsubscribeAll", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A boolean value status noting if the contact is unsubscribed from all contact list\n topics.
" } }, @@ -940,7 +976,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new custom verification email template.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", + "smithy.api#documentation": "Creates a new custom verification email template.
\nFor more information about custom verification email templates, see Using\n custom verification email templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", "smithy.api#http": { "method": "POST", "uri": "/v2/email/custom-verification-email-templates", @@ -975,7 +1011,7 @@ "TemplateContent": { "target": "com.amazonaws.sesv2#TemplateContent", "traits": { - "smithy.api#documentation": "The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.
", + "smithy.api#documentation": "The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom verification email frequently asked questions in the Amazon SES\n Developer Guide.
", "smithy.api#required": {} } }, @@ -1054,6 +1090,12 @@ "traits": { "smithy.api#documentation": "An object that defines the tags (keys and values) that you want to associate with the\n pool.
" } + }, + "ScalingMode": { + "target": "com.amazonaws.sesv2#ScalingMode", + "traits": { + "smithy.api#documentation": "The type of scaling mode.
" + } } }, "traits": { @@ -1297,7 +1339,7 @@ "DkimSigningAttributes": { "target": "com.amazonaws.sesv2#DkimSigningAttributes", "traits": { - "smithy.api#documentation": "If your request includes this object, Amazon SES configures the identity to use Bring Your\n Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for\n Easy DKIM.
\nYou can only specify this object if the email identity is a domain, as opposed to an\n address.
" + "smithy.api#documentation": "If your request includes this object, Amazon SES configures the identity to use Bring Your\n Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be\n used for Easy\n DKIM.
\nYou can only specify this object if the email identity is a domain, as opposed to an\n address.
" } }, "ConfigurationSetName": { @@ -1323,6 +1365,7 @@ "VerifiedForSendingStatus": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether or not the identity is verified. You can only send email from\n verified email addresses or domains. For more information about verifying identities,\n see the Amazon Pinpoint User Guide.
" } }, @@ -1547,19 +1590,23 @@ } }, "com.amazonaws.sesv2#DataFormat": { - "type": "string", - "traits": { - "smithy.api#documentation": "The data format of the import job's data source.
", - "smithy.api#enum": [ - { - "value": "CSV", - "name": "CSV" - }, - { - "value": "JSON", - "name": "JSON" + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" } - ] + } + }, + "traits": { + "smithy.api#documentation": "The data format of the import job's data source.
" } }, "com.amazonaws.sesv2#DedicatedIp": { @@ -1606,6 +1653,28 @@ "smithy.api#documentation": "A list of dedicated IP addresses that are associated with your Amazon Web Services account.
" } }, + "com.amazonaws.sesv2#DedicatedIpPool": { + "type": "structure", + "members": { + "PoolName": { + "target": "com.amazonaws.sesv2#PoolName", + "traits": { + "smithy.api#documentation": "The name of the dedicated IP pool.
", + "smithy.api#required": {} + } + }, + "ScalingMode": { + "target": "com.amazonaws.sesv2#ScalingMode", + "traits": { + "smithy.api#documentation": "The type of the dedicated IP pool.
\n\n STANDARD
– A dedicated IP pool where the customer can control which IPs are part of the pool.
\n MANAGED
– A dedicated IP pool where the reputation and number of IPs is automatically managed by Amazon SES.
Contains information about a dedicated IP pool.
" + } + }, "com.amazonaws.sesv2#DefaultDimensionValue": { "type": "string", "traits": { @@ -1846,7 +1915,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing custom verification email template.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", + "smithy.api#documentation": "Deletes an existing custom verification email template.
\nFor more information about custom verification email templates, see Using\n custom verification email templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", "smithy.api#http": { "method": "DELETE", "uri": "/v2/email/custom-verification-email-templates/{TemplateName}", @@ -2147,23 +2216,29 @@ } }, "com.amazonaws.sesv2#DeliverabilityDashboardAccountStatus": { - "type": "string", - "traits": { - "smithy.api#documentation": "The current status of your Deliverability dashboard subscription. If this value is\n PENDING_EXPIRATION
, your subscription is scheduled to expire at the end\n of the current calendar month.
The current status of your Deliverability dashboard subscription. If this value is\n PENDING_EXPIRATION
, your subscription is scheduled to expire at the end\n of the current calendar month.
The date and time when the predictive inbox placement test was created, in Unix time format.
" + "smithy.api#documentation": "The date and time when the predictive inbox placement test was created.
" } }, "DeliverabilityTestStatus": { @@ -2217,19 +2292,23 @@ } }, "com.amazonaws.sesv2#DeliverabilityTestStatus": { - "type": "string", - "traits": { - "smithy.api#documentation": "The status of a predictive inbox placement test. If the status is IN_PROGRESS
, then the predictive inbox placement test is\n currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test.\n If the status is COMPLETE
, then the test is finished, and you can use the\n GetDeliverabilityTestReport
operation to view the results of the\n test.
The status of a predictive inbox placement test. If the status is IN_PROGRESS
, then the predictive inbox placement test is\n currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test.\n If the status is COMPLETE
, then the test is finished, and you can use the\n GetDeliverabilityTestReport
operation to view the results of the\n test.
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To\n use the message tags that you specify using an X-SES-MESSAGE-TAGS
header or\n a parameter to the SendEmail
or SendRawEmail
API, choose\n messageTag
. To use your own email headers, choose\n emailHeader
. To use link tags, choose linkTags
.
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To\n use the message tags that you specify using an X-SES-MESSAGE-TAGS
header or\n a parameter to the SendEmail
or SendRawEmail
API, choose\n messageTag
. To use your own email headers, choose\n emailHeader
. To use link tags, choose linkTags
.
If the value is true
, then the messages that you send from the identity\n are signed using DKIM. If the value is false
, then the messages that you\n send from the identity aren't DKIM-signed.
The DKIM authentication status of the identity. The status can be one of the\n following:
\n\n PENDING
– The verification process was initiated, but Amazon SES\n hasn't yet detected the DKIM records in the DNS configuration for the\n domain.
\n SUCCESS
– The verification process completed\n successfully.
\n FAILED
– The verification process failed. This typically\n occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the\n domain.
\n TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES\n from determining the DKIM authentication status of the domain.
\n NOT_STARTED
– The DKIM verification process hasn't been\n initiated for the domain.
The DKIM authentication status of the identity. The status can be one of the\n following:
\n\n PENDING
– The verification process was initiated, but Amazon SES\n hasn't yet detected the DKIM records in the DNS configuration for the\n domain.
\n SUCCESS
– The verification process completed\n successfully.
\n FAILED
– The verification process failed. This typically\n occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the\n domain.
\n TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES\n from determining the DKIM authentication status of the domain.
\n NOT_STARTED
– The DKIM verification process hasn't been\n initiated for the domain.
The first time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.
" + "smithy.api#documentation": "The first time when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.
" } }, "LastSeenDateTime": { "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "The last time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.
" + "smithy.api#documentation": "The last time when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.
" } }, "InboxCount": { @@ -2575,7 +2675,7 @@ "SubscriptionStartDate": { "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "The date, in Unix time format, when you enabled the Deliverability dashboard for the\n domain.
" + "smithy.api#documentation": "The date when you enabled the Deliverability dashboard for the\n domain.
" } }, "InboxPlacementTrackingOption": { @@ -2770,14 +2870,14 @@ } }, "com.amazonaws.sesv2#Enabled": { - "type": "boolean" - }, - "com.amazonaws.sesv2#EnabledWrapper": { "type": "boolean", "traits": { - "smithy.api#box": {} + "smithy.api#default": false } }, + "com.amazonaws.sesv2#EnabledWrapper": { + "type": "boolean" + }, "com.amazonaws.sesv2#ErrorMessage": { "type": "string" }, @@ -2803,6 +2903,7 @@ "Enabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If true
, the event destination is enabled. When the event destination is\n enabled, the specified event types are sent to the destinations in this\n EventDestinationDefinition
.
If false
, the event destination is disabled. When the event destination\n is disabled, events aren't sent to the specified destinations.
If true
, the event destination is enabled. When the event destination is\n enabled, the specified event types are sent to the destinations in this\n EventDestinationDefinition
.
If false
, the event destination is disabled. When the event destination\n is disabled, events aren't sent to the specified destinations.
An email sending event type. For example, email sends, opens, and bounces are all\n email events.
", - "smithy.api#enum": [ - { - "value": "SEND", - "name": "SEND" - }, - { - "value": "REJECT", - "name": "REJECT" - }, - { - "value": "BOUNCE", - "name": "BOUNCE" - }, - { - "value": "COMPLAINT", - "name": "COMPLAINT" - }, - { - "value": "DELIVERY", - "name": "DELIVERY" - }, - { - "value": "OPEN", - "name": "OPEN" - }, - { - "value": "CLICK", - "name": "CLICK" - }, - { - "value": "RENDERING_FAILURE", - "name": "RENDERING_FAILURE" - }, - { - "value": "DELIVERY_DELAY", - "name": "DELIVERY_DELAY" - }, - { - "value": "SUBSCRIPTION", - "name": "SUBSCRIPTION" + "type": "enum", + "members": { + "SEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEND" + } + }, + "REJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECT" + } + }, + "BOUNCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOUNCE" } - ] + }, + "COMPLAINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLAINT" + } + }, + "DELIVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELIVERY" + } + }, + "OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPEN" + } + }, + "CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLICK" + } + }, + "RENDERING_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RENDERING_FAILURE" + } + }, + "DELIVERY_DELAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELIVERY_DELAY" + } + }, + "SUBSCRIPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBSCRIPTION" + } + } + }, + "traits": { + "smithy.api#documentation": "An email sending event type. For example, email sends, opens, and bounces are all\n email events.
" } }, "com.amazonaws.sesv2#EventTypes": { @@ -2953,10 +3075,7 @@ } }, "com.amazonaws.sesv2#FailedRecordsCount": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.sesv2#FailedRecordsS3Url": { "type": "string" @@ -3031,6 +3150,7 @@ "DedicatedIpAutoWarmupEnabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether or not the automatic warm-up feature is enabled for dedicated IP\n addresses that are associated with your account.
" } }, @@ -3043,6 +3163,7 @@ "ProductionAccessEnabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether or not your account has production access in the current Amazon Web Services\n Region.
\nIf the value is false
, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities. Additionally, the maximum number of emails you can send in\n a 24-hour period (your sending quota) is 200, and the maximum number of emails you can\n send per second (your maximum sending rate) is 1.
If the value is true
, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.
Indicates whether or not email sending is enabled for your Amazon SES account in the\n current Amazon Web Services Region.
" } }, @@ -3447,6 +3569,7 @@ "UnsubscribeAll": { "target": "com.amazonaws.sesv2#UnsubscribeAll", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A boolean value status noting if the contact is unsubscribed from all contact list\n topics.
" } }, @@ -3490,7 +3613,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the custom email verification template for the template name you\n specify.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", + "smithy.api#documentation": "Returns the custom email verification template for the template name you\n specify.
\nFor more information about custom verification email templates, see Using\n custom verification email templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", "smithy.api#http": { "method": "GET", "uri": "/v2/email/custom-verification-email-templates/{TemplateName}", @@ -3586,6 +3709,64 @@ } } }, + "com.amazonaws.sesv2#GetDedicatedIpPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#GetDedicatedIpPoolRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#GetDedicatedIpPoolResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieve information about the dedicated pool.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/email/dedicated-ip-pools/{PoolName}", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#GetDedicatedIpPoolRequest": { + "type": "structure", + "members": { + "PoolName": { + "target": "com.amazonaws.sesv2#PoolName", + "traits": { + "smithy.api#documentation": "The name of the dedicated IP pool to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to obtain more information about a dedicated IP pool.
" + } + }, + "com.amazonaws.sesv2#GetDedicatedIpPoolResponse": { + "type": "structure", + "members": { + "DedicatedIpPool": { + "target": "com.amazonaws.sesv2#DedicatedIpPool", + "traits": { + "smithy.api#documentation": "An object that contains information about a dedicated IP pool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The following element is returned by the service.
" + } + }, "com.amazonaws.sesv2#GetDedicatedIpRequest": { "type": "structure", "members": { @@ -3739,6 +3920,7 @@ "DashboardEnabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the Deliverability dashboard is enabled. If this value is true
,\n the dashboard is enabled.
The date, in Unix time format, when your current subscription to the Deliverability dashboard\n is scheduled to expire, if your subscription is scheduled to expire at the end of the\n current calendar month. This value is null if you have an active subscription that isn’t\n due to expire at the end of the month.
" + "smithy.api#documentation": "The date when your current subscription to the Deliverability dashboard\n is scheduled to expire, if your subscription is scheduled to expire at the end of the\n current calendar month. This value is null if you have an active subscription that isn’t\n due to expire at the end of the month.
" } }, "AccountStatus": { @@ -4112,12 +4294,14 @@ "FeedbackForwardingStatus": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "The feedback forwarding configuration for the identity.
\nIf the value is true
, you receive email notifications when bounce or\n complaint events occur. These notifications are sent to the address that you specified\n in the Return-Path
header of the original email.
You're required to have a method of tracking bounces and complaints. If you haven't\n set up another mechanism for receiving bounce or complaint notifications (for example,\n by setting up an event destination), you receive an email notification when these events\n occur (even if this setting is disabled).
" } }, "VerifiedForSendingStatus": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether or not the identity is verified. You can only send email from\n verified email addresses or domains. For more information about verifying identities,\n see the Amazon Pinpoint User Guide.
" } }, @@ -4150,6 +4334,12 @@ "traits": { "smithy.api#documentation": "The configuration set used by default when sending from this identity.
" } + }, + "VerificationStatus": { + "target": "com.amazonaws.sesv2#VerificationStatus", + "traits": { + "smithy.api#documentation": "The verification status of the identity. The status can be one of the following:
\n\n PENDING
– The verification process was initiated, but Amazon SES\n hasn't yet been able to verify the identity.
\n SUCCESS
– The verification process completed\n successfully.
\n FAILED
– The verification process failed.
\n TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES\n from determining the verification status of the identity.
\n NOT_STARTED
– The verification process hasn't been\n initiated for the identity.
Indicates whether or not you can send email from the identity.
\nAn identity is an email address or domain that you send email\n from. Before you can send email from an identity, you have to demostrate that you own\n the identity, and that you authorize Amazon SES to send email from that identity.
" } + }, + "VerificationStatus": { + "target": "com.amazonaws.sesv2#VerificationStatus", + "traits": { + "smithy.api#documentation": "The verification status of the identity. The status can be one of the following:
\n\n PENDING
– The verification process was initiated, but Amazon SES\n hasn't yet been able to verify the identity.
\n SUCCESS
– The verification process completed\n successfully.
\n FAILED
– The verification process failed.
\n TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES\n from determining the verification status of the identity.
\n NOT_STARTED
– The verification process hasn't been\n initiated for the identity.
The destination of the import job, which can be used to list import jobs that have a\n certain ImportDestinationType
.
The destination of the import job, which can be used to list import jobs that have a\n certain ImportDestinationType
.
The date and time when the import job was created.
" } + }, + "ProcessedRecordsCount": { + "target": "com.amazonaws.sesv2#ProcessedRecordsCount", + "traits": { + "smithy.api#documentation": "The current number of records processed.
" + } + }, + "FailedRecordsCount": { + "target": "com.amazonaws.sesv2#FailedRecordsCount", + "traits": { + "smithy.api#documentation": "The number of records that failed processing because of invalid input or other\n reasons.
" + } } }, "traits": { @@ -4545,6 +4762,7 @@ "Global": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether inbox placement data is being tracked for the domain.
" } }, @@ -4632,27 +4850,35 @@ } }, "com.amazonaws.sesv2#JobStatus": { - "type": "string", - "traits": { - "smithy.api#documentation": "The status of the import job.
", - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "PROCESSING", - "name": "PROCESSING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } + }, + "traits": { + "smithy.api#documentation": "The status of the import job.
" } }, "com.amazonaws.sesv2#KinesisFirehoseDestination": { @@ -4954,7 +5180,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the existing custom verification email templates for your account in the current\n Amazon Web Services Region.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", + "smithy.api#documentation": "Lists the existing custom verification email templates for your account in the current\n Amazon Web Services Region.
\nFor more information about custom verification email templates, see Using\n custom verification email templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", "smithy.api#http": { "method": "GET", "uri": "/v2/email/custom-verification-email-templates", @@ -5196,7 +5422,7 @@ "StartDate": { "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "The first day, in Unix time format, that you want to obtain deliverability data\n for.
", + "smithy.api#documentation": "The first day that you want to obtain deliverability data\n for.
", "smithy.api#httpQuery": "StartDate", "smithy.api#required": {} } @@ -5204,7 +5430,7 @@ "EndDate": { "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "The last day, in Unix time format, that you want to obtain deliverability data for.\n This value has to be less than or equal to 30 days after the value of the\n StartDate
parameter.
The last day that you want to obtain deliverability data for.\n This value has to be less than or equal to 30 days after the value of the\n StartDate
parameter.
Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list after a specific date. The date that you specify\n should be in Unix time format.
", + "smithy.api#documentation": "Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list after a specific date.
", "smithy.api#httpQuery": "StartDate" } }, "EndDate": { "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list before a specific date. The date that you specify\n should be in Unix time format.
", + "smithy.api#documentation": "Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list before a specific date.
", "smithy.api#httpQuery": "EndDate" } }, @@ -5690,7 +5916,7 @@ "BehaviorOnMxFailure": { "target": "com.amazonaws.sesv2#BehaviorOnMxFailure", "traits": { - "smithy.api#documentation": "The action to take if the required MX record can't be found when you send an email.\n When you set this value to UseDefaultValue
, the mail is sent using\n amazonses.com as the MAIL FROM domain. When you set this value\n to RejectMessage
, the Amazon SES API v2 returns a\n MailFromDomainNotVerified
error, and doesn't attempt to deliver the\n email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending
, Failed
, and TemporaryFailure
\n states.
The action to take if the required MX record can't be found when you send an email.\n When you set this value to USE_DEFAULT_VALUE
, the mail is sent using\n amazonses.com as the MAIL FROM domain. When you set this value\n to REJECT_MESSAGE
, the Amazon SES API v2 returns a\n MailFromDomainNotVerified
error, and doesn't attempt to deliver the\n email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending
, Failed
, and TemporaryFailure
\n states.
The status of the MAIL FROM domain. This status can have the following values:
\n\n PENDING
– Amazon SES hasn't started searching for the MX record\n yet.
\n SUCCESS
– Amazon SES detected the required MX record for the\n MAIL FROM domain.
\n FAILED
– Amazon SES can't find the required MX record, or the\n record no longer exists.
\n TEMPORARY_FAILURE
– A temporary issue occurred, which\n prevented Amazon SES from determining the status of the MAIL FROM domain.
The status of the MAIL FROM domain. This status can have the following values:
\n\n PENDING
– Amazon SES hasn't started searching for the MX record\n yet.
\n SUCCESS
– Amazon SES detected the required MX record for the\n MAIL FROM domain.
\n FAILED
– Amazon SES can't find the required MX record, or the\n record no longer exists.
\n TEMPORARY_FAILURE
– A temporary issue occurred, which\n prevented Amazon SES from determining the status of the MAIL FROM domain.
An object that contains information about inbox placement percentages.
" } }, "com.amazonaws.sesv2#Percentage100Wrapper": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.sesv2#PinpointDestination": { "type": "structure", @@ -6015,10 +6250,7 @@ } }, "com.amazonaws.sesv2#ProcessedRecordsCount": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.sesv2#PutAccountDedicatedIpWarmupAttributes": { "type": "operation", @@ -6051,6 +6283,7 @@ "AutoWarmupEnabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Enables or disables the automatic warm-up feature for dedicated IP addresses that are\n associated with your Amazon SES account in the current Amazon Web Services Region. Set to true
\n to enable the automatic warm-up feature, or set to false
to disable\n it.
Enables or disables your account's ability to send email. Set to true
to\n enable email sending, or set to false
to disable email sending.
If Amazon Web Services paused your account's ability to send email, you can't use this operation\n to resume your account's ability to send email.
\nIf true
, tracking of reputation metrics is enabled for the configuration\n set. If false
, tracking of reputation metrics is disabled for the\n configuration set.
If true
, email sending is enabled for the configuration set. If\n false
, email sending is disabled for the configuration set.
Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this\n value to true
.
Sets the DKIM signing configuration for the identity.
\nWhen you set this value true
, then the messages that are sent from the\n identity are signed using DKIM. If you set this value to false
, your\n messages are sent without DKIM signing.
An object that contains information about the private key and selector that you want\n to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or,\n configures the key length to be used for\n Easy DKIM.
" + "smithy.api#documentation": "An object that contains information about the private key and selector that you want\n to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the\n identity, or, configures the key length to be used for Easy DKIM.
" } } }, @@ -6942,6 +7180,7 @@ "EmailForwardingEnabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Sets the feedback forwarding configuration for the identity.
\nIf the value is true
, you receive email notifications when bounce or\n complaint events occur. These notifications are sent to the address that you specified\n in the Return-Path
header of the original email.
You're required to have a method of tracking bounces and complaints. If you haven't\n set up another mechanism for receiving bounce or complaint notifications (for example,\n by setting up an event destination), you receive an email notification when these events\n occur (even if this setting is disabled).
" } } @@ -7153,6 +7392,7 @@ "ReputationMetricsEnabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If true
, tracking of reputation metrics is enabled for the configuration\n set. If false
, tracking of reputation metrics is disabled for the\n configuration set.
Adds an email address to the list of identities for your Amazon SES account in the current\n Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a\n customized verification email is sent to the specified address.
\nTo use this operation, you must first create a custom verification email template. For\n more information about creating and using custom verification email templates, see\n Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", + "smithy.api#documentation": "Adds an email address to the list of identities for your Amazon SES account in the current\n Amazon Web Services Region and attempts to verify it. As a result of executing this\n operation, a customized verification email is sent to the specified address.
\nTo use this operation, you must first create a custom verification email template. For\n more information about creating and using custom verification email templates, see\n Using\n custom verification email templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", "smithy.api#http": { "method": "POST", "uri": "/v2/email/outbound-custom-verification-emails", @@ -7563,18 +7826,21 @@ "Max24HourSend": { "target": "com.amazonaws.sesv2#Max24HourSend", "traits": { - "smithy.api#documentation": "The maximum number of emails that you can send in the current Amazon Web Services Region over a\n 24-hour period. This value is also called your sending\n quota.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of emails that you can send in the current Amazon Web Services Region over a\n 24-hour period. A value of -1 signifies an unlimited quota. (This value is also referred\n to as your sending quota.)
" } }, "MaxSendRate": { "target": "com.amazonaws.sesv2#MaxSendRate", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of emails that you can send per second in the current Amazon Web Services Region.\n This value is also called your maximum sending rate or your\n maximum TPS (transactions per second) rate.
" } }, "SentLast24Hours": { "target": "com.amazonaws.sesv2#SentLast24Hours", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the\n past 24 hours.
" } } @@ -7589,6 +7855,7 @@ "SendingEnabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If true
, email sending is enabled for the configuration set. If\n false
, email sending is disabled for the configuration set.
\n Amazon SES is an Amazon Web Services service that\n you can use to send email messages to your customers.
\nIf you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer\n Guide. The Amazon SES Developer Guide provides information\n and code samples that demonstrate how to use Amazon SES API v2 features programmatically.
", - "smithy.api#title": "Amazon Simple Email Service" + "smithy.api#title": "Amazon Simple Email Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS 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" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "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": [], + "endpoint": { + "url": "https://email-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, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://email-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, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://email.{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://email.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } } }, "com.amazonaws.sesv2#SnsDestination": { @@ -7902,18 +9729,20 @@ "type": "string" }, "com.amazonaws.sesv2#SubscriptionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OPT_IN", - "name": "OPT_IN" - }, - { - "value": "OPT_OUT", - "name": "OPT_OUT" + "type": "enum", + "members": { + "OPT_IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPT_IN" + } + }, + "OPT_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPT_OUT" } - ] + } } }, "com.amazonaws.sesv2#SuccessRedirectionURL": { @@ -8042,35 +9871,43 @@ } }, "com.amazonaws.sesv2#SuppressionListImportAction": { - "type": "string", - "traits": { - "smithy.api#documentation": "The type of action to perform on the address. The following are possible values:
\nPUT: add the addresses to the suppression list.
\nDELETE: remove the address from the suppression list.
\nThe type of action to perform on the address. The following are possible values:
\nPUT: add the addresses to the suppression list.
\nDELETE: remove the address from the suppression list.
\nThe reason that the address was added to the suppression list for your account. The\n value can be one of the following:
\n\n COMPLAINT
– Amazon SES added an email address to the suppression\n list for your account because a message sent to that address results in a\n complaint.
\n BOUNCE
– Amazon SES added an email address to the suppression\n list for your account because a message sent to that address results in a hard\n bounce.
The reason that the address was added to the suppression list for your account. The\n value can be one of the following:
\n\n COMPLAINT
– Amazon SES added an email address to the suppression\n list for your account because a message sent to that address results in a\n complaint.
\n BOUNCE
– Amazon SES added an email address to the suppression\n list for your account because a message sent to that address results in a hard\n bounce.
Specifies whether messages that use the configuration set are required to use\n Transport Layer Security (TLS). If the value is Require
, messages are only\n delivered if a TLS connection can be established. If the value is Optional
,\n messages can be delivered in plain text if a TLS connection can't be established.
Specifies whether messages that use the configuration set are required to use\n Transport Layer Security (TLS). If the value is Require
, messages are only\n delivered if a TLS connection can be established. If the value is Optional
,\n messages can be delivered in plain text if a TLS connection can't be established.
Notes that the default subscription status should be applied to a contact because the\n contact has not noted their preference for subscribing to a topic.
" } } @@ -8425,7 +10267,10 @@ } }, "com.amazonaws.sesv2#UnsubscribeAll": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.sesv2#UntagResource": { "type": "operation", @@ -8668,6 +10513,7 @@ "UnsubscribeAll": { "target": "com.amazonaws.sesv2#UnsubscribeAll", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A boolean value status noting if the contact is unsubscribed from all contact list\n topics.
" } }, @@ -8703,7 +10549,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing custom verification email template.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", + "smithy.api#documentation": "Updates an existing custom verification email template.
\nFor more information about custom verification email templates, see Using\n custom verification email templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", "smithy.api#http": { "method": "PUT", "uri": "/v2/email/custom-verification-email-templates/{TemplateName}", @@ -8739,7 +10585,7 @@ "TemplateContent": { "target": "com.amazonaws.sesv2#TemplateContent", "traits": { - "smithy.api#documentation": "The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.
", + "smithy.api#documentation": "The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom verification email frequently asked questions in the Amazon SES\n Developer Guide.
", "smithy.api#required": {} } }, @@ -8904,12 +10750,49 @@ } }, "com.amazonaws.sesv2#UseDefaultIfPreferenceUnavailable": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.sesv2#VerificationStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "TEMPORARY_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEMPORARY_FAILURE" + } + }, + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STARTED" + } + } + } }, "com.amazonaws.sesv2#Volume": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "An object that contains information about inbox placement volume.
" } }, @@ -8946,19 +10829,23 @@ } }, "com.amazonaws.sesv2#WarmupStatus": { - "type": "string", - "traits": { - "smithy.api#documentation": "The warmup status of a dedicated IP.
", - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "DONE", - "name": "DONE" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "DONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DONE" } - ] + } + }, + "traits": { + "smithy.api#documentation": "The warmup status of a dedicated IP.
" } }, "com.amazonaws.sesv2#WebsiteURL": {