The parameters in the request body for the Lambda input event.
" } + }, + "function": { + "target": "com.amazonaws.bedrockagentruntime#Function", + "traits": { + "smithy.api#documentation": "The function in the action group to call.
" + } } }, "traits": { - "smithy.api#documentation": "Contains information about the action group being invoked.
" + "smithy.api#documentation": "Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput": { @@ -96,6 +102,16 @@ "smithy.api#pattern": "^[0-9a-zA-Z]+$" } }, + "com.amazonaws.bedrockagentruntime#AgentVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + } + }, "com.amazonaws.bedrockagentruntime#AmazonBedrockAgentRunTimeService": { "type": "service", "version": "2023-07-26", @@ -789,12 +805,151 @@ } } }, + "com.amazonaws.bedrockagentruntime#ApiContentMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#PropertyParameters" + } + }, + "com.amazonaws.bedrockagentruntime#ApiInvocationInput": { + "type": "structure", + "members": { + "actionGroup": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The action group that the API operation belongs to.
", + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The HTTP method of the API operation.
" + } + }, + "apiPath": { + "target": "com.amazonaws.bedrockagentruntime#ApiPath", + "traits": { + "smithy.api#documentation": "The path to the API operation.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#ApiParameters", + "traits": { + "smithy.api#documentation": "The parameters to provide for the API request, as the agent elicited from the user.
" + } + }, + "requestBody": { + "target": "com.amazonaws.bedrockagentruntime#ApiRequestBody", + "traits": { + "smithy.api#documentation": "The request body to provide for the API request, as the agent elicited from the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the API operation that the agent predicts should be called.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the Retrieve response\n
The name of the parameter.
" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data type for the parameter.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a parameter to provide to the API request.
\nThis data type is used in the following API operations:
\n\n Retrieve response\n
\nThe content of the request body. The key of the object in this field is a media type defining the format of the request body.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request body to provide for the API request, as the agent elicited from the user.
\nThis data type is used in the following API operations:
\n\n Retrieve response\n
\nThe action group that the API operation belongs to.
", + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The HTTP method for the API operation.
" + } + }, + "apiPath": { + "target": "com.amazonaws.bedrockagentruntime#ApiPath", + "traits": { + "smithy.api#documentation": "The path to the API operation.
" + } + }, + "responseBody": { + "target": "com.amazonaws.bedrockagentruntime#ResponseBody", + "traits": { + "smithy.api#documentation": "The response body from the API operation. The key of the object is the content type. The response may be returned directly or from the Lambda function.
" + } + }, + "httpStatusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "http status code from API execution response (for example: 200, 400, 500).
" + } + }, + "responseState": { + "target": "com.amazonaws.bedrockagentruntime#ResponseState", + "traits": { + "smithy.api#documentation": "Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the API operation that was called from the action group and the response body that was returned.
\nThis data type is used in the following API operations:
\nIn the returnControlInvocationResults of the Retrieve request\n
The body of the API response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the body of the API response.
\nThis data type is used in the following API operations:
\nIn the returnControlInvocationResults field of the Retrieve request\n
The action group that the function belongs to.
", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#FunctionParameters", + "traits": { + "smithy.api#documentation": "A list of parameters of the function.
" + } + }, + "function": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the function that the agent predicts should be called.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the Retrieve response\n
The name of the parameter.
" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data type of the parameter.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a parameter of the function.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the Retrieve response\n
The action group that the function belongs to.
", + "smithy.api#required": {} + } + }, + "function": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the function that was called.
" + } + }, + "responseBody": { + "target": "com.amazonaws.bedrockagentruntime#ResponseBody", + "traits": { + "smithy.api#documentation": "The response from the function call using the parameters. The response may be returned directly or from the Lambda function.
" + } + }, + "responseState": { + "target": "com.amazonaws.bedrockagentruntime#ResponseState", + "traits": { + "smithy.api#documentation": "Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the function that was called from the action group and the response that was returned.
\nThis data type is used in the following API operations:
\nIn the returnControlInvocationResults of the Retrieve request\n
Contains information about the API operation that the agent predicts should be called.
" + } + }, + "functionInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#FunctionInvocationInput", + "traits": { + "smithy.api#documentation": "Contains information about the function that the agent predicts should be called.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the API operation or function that the agent predicts should be called.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the Retrieve response\n
The result from the API response from the action group invocation.
" + } + }, + "functionResult": { + "target": "com.amazonaws.bedrockagentruntime#FunctionResult", + "traits": { + "smithy.api#documentation": "The result from the function from the action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A result from the action group invocation.
\nThis data type is used in the following API operations:
\n\n Retrieve request\n
\nSends a prompt for the agent to process and respond to.
\nThe CLI doesn't support InvokeAgent.
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
Include attributes for the session or prompt in the sessionState object.
The response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
Errors are also surfaced in the response.
\nSends a prompt for the agent to process and respond to. Use return control event type for function calling.
\nThe CLI doesn't support InvokeAgent.
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or parameters returned from the action group.
Use return control event type for function calling.
\nThe response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
Errors are also surfaced in the response.
\nThe prompt text to send the agent.
", - "smithy.api#required": {} + "smithy.api#documentation": "The prompt text to send the agent.
" } } }, @@ -1680,7 +1998,13 @@ } }, "traits": { - "smithy.api#documentation": "A parameter in the Lambda input event.
" + "smithy.api#documentation": "A parameter for the API request or function.
" + } + }, + "com.amazonaws.bedrockagentruntime#ParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Parameter" } }, "com.amazonaws.bedrockagentruntime#Parameters": { @@ -1897,6 +2221,20 @@ } } }, + "com.amazonaws.bedrockagentruntime#PropertyParameters": { + "type": "structure", + "members": { + "properties": { + "target": "com.amazonaws.bedrockagentruntime#ParameterList", + "traits": { + "smithy.api#documentation": "A list of parameters in the request body.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the parameters in the request body.
" + } + }, "com.amazonaws.bedrockagentruntime#Rationale": { "type": "structure", "members": { @@ -1956,7 +2294,7 @@ } }, "traits": { - "smithy.api#documentation": "The parameters in the request body for the Lambda input event.
" + "smithy.api#documentation": "The parameters in the API request body.
" } }, "com.amazonaws.bedrockagentruntime#ResourceNotFoundException": { @@ -1967,11 +2305,37 @@ } }, "traits": { - "smithy.api#documentation": "The specified resource ARN was not found. Check the ARN and try your request again.
", + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, + "com.amazonaws.bedrockagentruntime#ResponseBody": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#ContentBody" + } + }, + "com.amazonaws.bedrockagentruntime#ResponseState": { + "type": "enum", + "members": { + "FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILURE" + } + }, + "REPROMPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPROMPT" + } + } + } + }, "com.amazonaws.bedrockagentruntime#ResponseStream": { "type": "union", "members": { @@ -1984,7 +2348,13 @@ "trace": { "target": "com.amazonaws.bedrockagentruntime#TracePart", "traits": { - "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" + } + }, + "returnControl": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlPayload", + "traits": { + "smithy.api#documentation": "Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" } }, "internalServerException": { @@ -2002,7 +2372,7 @@ "resourceNotFoundException": { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", "traits": { - "smithy.api#documentation": "The specified resource ARN was not found. Check the ARN and try your request again.
" + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" } }, "serviceQuotaExceededException": { @@ -2569,6 +2939,39 @@ "target": "com.amazonaws.bedrockagentruntime#RetrievedReference" } }, + "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#InvocationResultMember" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#ReturnControlPayload": { + "type": "structure", + "members": { + "invocationInputs": { + "target": "com.amazonaws.bedrockagentruntime#InvocationInputs", + "traits": { + "smithy.api#documentation": "A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
" + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information to return from the action group that the agent has predicted to invoke.
\nThis data type is used in the following API operations:
\n\n Retrieve response\n
\nContains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.
" } + }, + "returnControlInvocationResults": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults", + "traits": { + "smithy.api#documentation": "Contains information about the results from the action group invocation.
" + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the invocation.
" + } } }, "traits": { @@ -2842,6 +3257,12 @@ "smithy.api#documentation": "The unique identifier of the session with the agent.
" } }, + "agentVersion": { + "target": "com.amazonaws.bedrockagentruntime#AgentVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
" + } + }, "trace": { "target": "com.amazonaws.bedrockagentruntime#Trace", "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.json b/codegen/sdk-codegen/aws-models/bedrock-agent.json index 4ded59f5001..8acc8289a0c 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json @@ -42,6 +42,12 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } + }, + "customControl": { + "target": "com.amazonaws.bedrockagent#CustomControlMethod", + "traits": { + "smithy.api#documentation": "To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" } }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
" + } + }, "actionGroupState": { "target": "com.amazonaws.bedrockagent#ActionGroupState", "traits": { @@ -2138,6 +2150,12 @@ "traits": { "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } } }, "traits": { @@ -2593,6 +2611,17 @@ } } }, + "com.amazonaws.bedrockagent#CustomControlMethod": { + "type": "enum", + "members": { + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, "com.amazonaws.bedrockagent#DataSource": { "type": "structure", "members": { @@ -3495,6 +3524,62 @@ "smithy.api#documentation": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
A name for the function.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FunctionDescription", + "traits": { + "smithy.api#documentation": "A description of the function and its purpose.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagent#ParameterMap", + "traits": { + "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
\nThis data type is used in the following API operations:
\nA list of functions that each define an action in the action group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
\nThis data type is used in the following API operations:
\nContains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
\nThis data type is used in the following API operations:
\nContains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
\nThis data type is used in the following API operations:
\nA description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#Type", + "traits": { + "smithy.api#documentation": "The data type of the parameter.
", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
\nThis data type is used in the following API operations:
\nContains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/payment-cryptography.json b/codegen/sdk-codegen/aws-models/payment-cryptography.json index 4e9412269fa..0a26efe18c1 100644 --- a/codegen/sdk-codegen/aws-models/payment-cryptography.json +++ b/codegen/sdk-codegen/aws-models/payment-cryptography.json @@ -146,7 +146,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.
\nYou can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.
\nTo change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nCreates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.
\nYou can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.
\nTo change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nCreates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.
\nIn addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.
\nWhen you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that define the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n " + "smithy.api#documentation": "Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.
\nIn addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.
\nWhen you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that define the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n " } }, "com.amazonaws.paymentcryptography#CreateKeyInput": { @@ -286,7 +286,7 @@ "target": "com.amazonaws.paymentcryptography#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nAssigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nDeletes the alias, but doesn't affect the underlying key.
\nEach key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nDeletes the alias, but doesn't affect the underlying key.
\nEach key can have multiple aliases. To get the aliases of all keys, use the UpdateAlias operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nDeletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.
\nKey deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period set using DeleteKeyInDays. The default waiting period is 7 days. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.
You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n RestoreKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nDeletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.
\nKey deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period set using DeleteKeyInDays. The default waiting period is 7 days. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.
You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n RestoreKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nExports a key from Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ExportKey you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanism. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK). After which you can export working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
\nThe TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
\nYou can also use ExportKey functionality to generate and export an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base Derivation Key) and ExportDukptInitialKey attribute KSN (KeySerialNumber). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export.
\n To export initial keys (KEK) or IPEK using TR-34\n
\nUsing this operation, you can export initial key using TR-34 asymmetric key exchange. You can only export KEK generated within Amazon Web Services Payment Cryptography. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the user receiving the key.
\nTo initiate TR-34 key export, the KRD must obtain an export token by calling GetParametersForExport. This operation also generates a key pair for the purpose of key export, signs the key and returns back the signing public key certificate (also known as KDH signing certificate) and root certificate chain. The KDH uses the private key to sign the the export payload and the signing public key certificate is provided to KRD to verify the signature. The KRD can import the root certificate into its Hardware Security Module (HSM), as required. The export token and the associated KDH signing certificate expires after 7 days.
\nNext the KRD generates a key pair for the the purpose of encrypting the KDH key and provides the public key cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey. The KDH, Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see section Exporting symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
\n\n ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
\n ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
\n KeyMaterial: Use Tr34KeyBlock parameters.
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KRD wrapping key certificate.
\n ExportToken: Obtained from KDH by calling GetParametersForImport.
\n WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for encryption of the TR-34 export payload. This certificate must be signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography.
When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock.
\n\n To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap\n
\nUsing this operation, you can export initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import the root certificate into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey.
Next call ExportKey and set the following parameters:
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed wrapping key certificate.
\n KeyMaterial: Set to KeyCryptogram.
\n WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component to unwrap the WrappedKeyCryptogram.
When this operation is successful, Amazon Web Services Payment Cryptography returns the WrappedKeyCryptogram.
\n\n To export working keys or IPEK using TR-31\n
\nUsing this operation, you can export working keys or IPEK using TR-31 symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey.
\nSet the following parameters:
\n\n ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
\n ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
\n KeyMaterial: Use Tr31KeyBlock parameters.
When this operation is successful, Amazon Web Services Payment Cryptography returns the working key or IPEK as a TR-31 WrappedKeyBlock.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nExports a key from Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ExportKey you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanism. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK). After which you can export working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
\nThe TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
\nYou can also use ExportKey functionality to generate and export an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base Derivation Key) and ExportDukptInitialKey attribute KSN (KeySerialNumber). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export.
For key exchange using TR-31 or TR-34 key blocks, you can also export optional blocks within the key block header which contain additional attribute information about the key. The KeyVersion within KeyBlockHeaders indicates the version of the key within the key block. Furthermore, KeyExportability within KeyBlockHeaders can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
The OptionalBlocks contain the additional data related to the key. For information on data type that can be included within optional blocks, refer to ASC X9.143-2022.
Data included in key block headers is signed but transmitted in clear text. Sensitive or confidential information should not be included in optional blocks. Refer to ASC X9.143-2022 standard for information on allowed data type.
\n\n To export initial keys (KEK) or IPEK using TR-34\n
\nUsing this operation, you can export initial key using TR-34 asymmetric key exchange. You can only export KEK generated within Amazon Web Services Payment Cryptography. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the user receiving the key.
\nTo initiate TR-34 key export, the KRD must obtain an export token by calling GetParametersForExport. This operation also generates a key pair for the purpose of key export, signs the key and returns back the signing public key certificate (also known as KDH signing certificate) and root certificate chain. The KDH uses the private key to sign the the export payload and the signing public key certificate is provided to KRD to verify the signature. The KRD can import the root certificate into its Hardware Security Module (HSM), as required. The export token and the associated KDH signing certificate expires after 7 days.
\nNext the KRD generates a key pair for the the purpose of encrypting the KDH key and provides the public key cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey. The KDH, Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see section Exporting symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
\n\n ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
\n ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
\n KeyMaterial: Use Tr34KeyBlock parameters.
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KRD wrapping key certificate.
\n ExportToken: Obtained from KDH by calling GetParametersForImport.
\n WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for encryption of the TR-34 export payload. This certificate must be signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography.
When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock.
\n\n To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap\n
\nUsing this operation, you can export initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import the root certificate into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey.
Next call ExportKey and set the following parameters:
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed wrapping key certificate.
\n KeyMaterial: Set to KeyCryptogram.
\n WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component to unwrap the WrappedKeyCryptogram.
When this operation is successful, Amazon Web Services Payment Cryptography returns the WrappedKeyCryptogram.
\n\n To export working keys or IPEK using TR-31\n
\nUsing this operation, you can export working keys or IPEK using TR-31 symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey.
\nSet the following parameters:
\n\n ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
\n ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
\n KeyMaterial: Use Tr31KeyBlock parameters.
When this operation is successful, Amazon Web Services Payment Cryptography returns the working key or IPEK as a TR-31 WrappedKeyBlock.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nThe KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" + } } }, "traits": { @@ -664,7 +670,7 @@ "ExportToken": { "target": "com.amazonaws.paymentcryptography#ExportTokenId", "traits": { - "smithy.api#documentation": "The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.
", + "smithy.api#documentation": "The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.
", "smithy.api#required": {} } }, @@ -680,6 +686,12 @@ "traits": { "smithy.api#documentation": "A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" } + }, + "KeyBlockHeaders": { + "target": "com.amazonaws.paymentcryptography#KeyBlockHeaders", + "traits": { + "smithy.api#documentation": "Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" + } } }, "traits": { @@ -716,7 +728,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Gets the Amazon Web Services Payment Cryptography key associated with the alias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nGets the Amazon Web Services Payment Cryptography key associated with the alias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nGets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", + "smithy.api#documentation": "Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", "smithy.api#readonly": {} } }, @@ -858,7 +870,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
\nThe signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nGets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
\nThe signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nGets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.
\nThe wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. You can use the same import token to import multiple keys into your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nGets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.
\nThe wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. You can use the same import token to import multiple keys into your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nImports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ImportKey you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
\nThe TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
\nYou can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nYou can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nUsing this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.
\nSet the following parameters:
\n\n KeyMaterial: RootCertificatePublicKey\n
\n KeyClass: PUBLIC_KEY\n
\n KeyModesOfUse: Verify\n
\n KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE\n
\n PublicKeyCertificate: The public key certificate in PEM format (base64 encoded) of the private root key under import.
\n To import a trusted public key certificate\n
\nThe root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:
\n\n KeyMaterial: TrustedCertificatePublicKey\n
\n CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
\n KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.
\n PublicKeyCertificate: The trusted public key certificate in PEM format (base64 encoded) under import.
\n To import initial keys (KEK or ZMK or similar) using TR-34\n
\nUsing this operation, you can import initial key using TR-34 asymmetric key exchange. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.
\nTo initiate TR-34 key import, the KDH must obtain an import token by calling GetParametersForImport. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 7 days.
\nNext the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling ImportKey for RootCertificatePublicKey. For more information on TR-34 key import, see section Importing symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
\n\n KeyMaterial: Use Tr34KeyBlock parameters.
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KDH signing key certificate.
\n ImportToken: Obtained from KRD by calling GetParametersForImport.
\n WrappedKeyBlock: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
\n SigningKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.
\n To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap\n
\nUsing this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call GetParametersForImport with KeyMaterial set to KEY_CRYPTOGRAM to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 7 days.
You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call ImportKey with KeyMaterial set to KEY_CRYPTOGRAM and provide the ImportToken and KeyAttributes for the key under import.
\n To import working keys using TR-31\n
\nAmazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using CreateKey. To initiate a TR-31 key import, set the following parameters:
\n\n KeyMaterial: Use Tr31KeyBlock parameters.
\n WrappedKeyBlock: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon Web Services Payment Cryptography.
\n WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nImports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ImportKey you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
\nThe TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
\nYou can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nYou can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nUsing this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.
\nSet the following parameters:
\n\n KeyMaterial: RootCertificatePublicKey\n
\n KeyClass: PUBLIC_KEY\n
\n KeyModesOfUse: Verify\n
\n KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE\n
\n PublicKeyCertificate: The public key certificate in PEM format (base64 encoded) of the private root key under import.
\n To import a trusted public key certificate\n
\nThe root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:
\n\n KeyMaterial: TrustedCertificatePublicKey\n
\n CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
\n KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.
\n PublicKeyCertificate: The trusted public key certificate in PEM format (base64 encoded) under import.
\n To import initial keys (KEK or ZMK or similar) using TR-34\n
\nUsing this operation, you can import initial key using TR-34 asymmetric key exchange. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.
\nTo initiate TR-34 key import, the KDH must obtain an import token by calling GetParametersForImport. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 7 days.
\nNext the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling ImportKey for RootCertificatePublicKey. For more information on TR-34 key import, see section Importing symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
\n\n KeyMaterial: Use Tr34KeyBlock parameters.
\n CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KDH signing key certificate.
\n ImportToken: Obtained from KRD by calling GetParametersForImport.
\n WrappedKeyBlock: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
\n SigningKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.
\n To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap\n
\nUsing this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call GetParametersForImport with KeyMaterial set to KEY_CRYPTOGRAM to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 7 days.
You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call ImportKey with KeyMaterial set to KEY_CRYPTOGRAM and provide the ImportToken and KeyAttributes for the key under import.
\n To import working keys using TR-31\n
\nAmazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using CreateKey. To initiate a TR-31 key import, set the following parameters:
\n\n KeyMaterial: Use Tr31KeyBlock parameters.
\n WrappedKeyBlock: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon Web Services Payment Cryptography.
\n WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nAssigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nAssigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nThe role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
" } }, + "com.amazonaws.paymentcryptography#KeyBlockHeaders": { + "type": "structure", + "members": { + "KeyModesOfUse": { + "target": "com.amazonaws.paymentcryptography#KeyModesOfUse" + }, + "KeyExportability": { + "target": "com.amazonaws.paymentcryptography#KeyExportability", + "traits": { + "smithy.api#documentation": "Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
\nWhen set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
" + } + }, + "OptionalBlocks": { + "target": "com.amazonaws.paymentcryptography#OptionalBlocks", + "traits": { + "smithy.api#documentation": "Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.
\nOptional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" + } + }, "com.amazonaws.paymentcryptography#KeyCheckValue": { "type": "string", "traits": { @@ -1660,6 +1701,25 @@ ] } }, + "com.amazonaws.paymentcryptography#KeyExportability": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EXPORTABLE", + "name": "EXPORTABLE" + }, + { + "value": "NON_EXPORTABLE", + "name": "NON_EXPORTABLE" + }, + { + "value": "SENSITIVE", + "name": "SENSITIVE" + } + ] + } + }, "com.amazonaws.paymentcryptography#KeyMaterial": { "type": "string", "traits": { @@ -2005,6 +2065,16 @@ ] } }, + "com.amazonaws.paymentcryptography#KeyVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[0-9A-Z]{2}+$" + } + }, "com.amazonaws.paymentcryptography#ListAliases": { "type": "operation", "input": { @@ -2035,7 +2105,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
\nThis is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value.\n Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n UpdateAlias\n
\nLists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
\nThis is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value.\n Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n UpdateAlias\n
\nLists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.
\nThis is a paginated operation, which means that each response might contain only a subset of all the keys.\n When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", + "smithy.api#documentation": "Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.
\nThis is a paginated operation, which means that each response might contain only a subset of all the keys.\n When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2211,7 +2281,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Lists the tags for an Amazon Web Services resource.
\nThis is a paginated operation, which means that each response might contain only a subset of all the tags.\n When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n TagResource\n
\n\n UntagResource\n
\nLists the tags for an Amazon Web Services resource.
\nThis is a paginated operation, which means that each response might contain only a subset of all the tags.\n When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n TagResource\n
\n\n UntagResource\n
\nCancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.
During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted.\n After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nCancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.
During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted.\n After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nEnables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n StopKeyUsage\n
\nEnables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n StopKeyUsage\n
\nDisables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
\nYou can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\nDisables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
\nYou can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\nAdds or edits tags on an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nEach tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n UntagResource\n
\nAdds or edits tags on an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nEach tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n UntagResource\n
\nOne or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTo use this parameter, you must have TagResource permission in an IAM policy.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nOne or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTo use this parameter, you must have TagResource permission in an IAM policy.
\nDon't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nDeletes a tag from an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n TagResource\n
\nDeletes a tag from an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n TagResource\n
\nOne or more tag keys. Don't include the tag values.
\nIf the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.
", + "smithy.api#documentation": "One or more tag keys. Don't include the tag values.
\nIf the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.
", "smithy.api#required": {} } } @@ -3602,7 +3703,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "Associates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\nAssociates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\nThe schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
\nFormat of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
\nFormat of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.
\nFormat of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
\nFormat of cron expressions is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
\nFormat of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
\nFormat of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
\nFormat of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
\nFormat of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see \n Cron Expressions in the Amazon CloudWatch Events User Guide.
\n The current account doesn't have the IAM permissions required to perform the specified operation.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 32 + } + } + }, + "com.amazonaws.route53profiles#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53profiles#AssociateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#AssociateProfileRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#AssociateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#LimitExceededException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceExistsException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with up to 5000 VPCs.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/profileassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53profiles#AssociateProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile.\n
", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The ID of the VPC.\n
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n A name for the association.\n
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.route53profiles#TagList", + "traits": { + "smithy.api#documentation": "\n A list of the tag keys and values that you want to identify the Profile association.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#AssociateProfileResponse": { + "type": "structure", + "members": { + "ProfileAssociation": { + "target": "com.amazonaws.route53profiles#ProfileAssociation", + "traits": { + "smithy.api#documentation": "\n The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#AssociateResourceToProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#AssociateResourceToProfileRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#AssociateResourceToProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#LimitExceededException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Associates a DNS reource configuration to a Route 53 Profile.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/profileresourceassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53profiles#AssociateResourceToProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile.\n
", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n Amazon resource number, ARN, of the DNS resource.\n
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n Name for the resource association.\n
", + "smithy.api#required": {} + } + }, + "ResourceProperties": { + "target": "com.amazonaws.route53profiles#ResourceProperties", + "traits": { + "smithy.api#documentation": "\n If you are adding a DNS Firewall rule group, include also a priority in this format:\n
\n\n Key=FirewallRuleGroupPriority,Value=100\n
\n Infromation about the AssociateResourceToProfile, including a status message.\n
\nThe request you submitted conflicts with an existing request.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#CreateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#CreateProfileRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#CreateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#LimitExceededException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Creates an empty Route 53 Profile.\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/profile" + } + } + }, + "com.amazonaws.route53profiles#CreateProfileRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n A name for the Profile.\n
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.route53profiles#CreatorRequestId", + "traits": { + "smithy.api#documentation": "\n ClientToken is an idempotency token that ensures a call to CreateProfile completes only once. You choose the value to pass. \n For example, an issue might prevent you from getting a response from CreateProfile. \n In this case, safely retry your call to CreateProfile by using the same CreateProfile parameter value.\n
\n A list of the tag keys and values that you want to associate with the Route 53 Profile.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#CreateProfileResponse": { + "type": "structure", + "members": { + "Profile": { + "target": "com.amazonaws.route53profiles#Profile", + "traits": { + "smithy.api#documentation": "\n The Profile that you just created.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#CreatorRequestId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53profiles#DeleteProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#DeleteProfileRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#DeleteProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/profile/{ProfileId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#DeleteProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The ID of the Profile that you want to delete.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#DeleteProfileResponse": { + "type": "structure", + "members": { + "Profile": { + "target": "com.amazonaws.route53profiles#Profile", + "traits": { + "smithy.api#documentation": "\n Information about the DeleteProfile request, including the status of the request.\n
\n Dissociates a specified Route 53 Profile from the specified VPC.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/profileassociation/Profileid/{ProfileId}/resourceid/{ResourceId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#DisassociateProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The ID of the VPC.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#DisassociateProfileResponse": { + "type": "structure", + "members": { + "ProfileAssociation": { + "target": "com.amazonaws.route53profiles#ProfileAssociation", + "traits": { + "smithy.api#documentation": "\n Information about the DisassociateProfile request.\n
\n Dissoaciated a specified resource, from the Route 53 Profile.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/profileresourceassociation/profileid/{ProfileId}/resourcearn/{ResourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#DisassociateResourceFromProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The ID of the Profile.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#DisassociateResourceFromProfileResponse": { + "type": "structure", + "members": { + "ProfileResourceAssociation": { + "target": "com.amazonaws.route53profiles#ProfileResourceAssociation", + "traits": { + "smithy.api#documentation": "\n Information about the DisassociateResourceFromProfile request, including the status of the request.\n
\n Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profile/{ProfileId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#GetProfileAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#GetProfileAssociationRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#GetProfileAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs. \n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profileassociation/{ProfileAssociationId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#GetProfileAssociationRequest": { + "type": "structure", + "members": { + "ProfileAssociationId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The identifier of the association you want to get information about.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#GetProfileAssociationResponse": { + "type": "structure", + "members": { + "ProfileAssociation": { + "target": "com.amazonaws.route53profiles#ProfileAssociation", + "traits": { + "smithy.api#documentation": "\n Information about the Profile association that you specified in a GetProfileAssociation request.\n
\n ID of the Profile.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#GetProfileResourceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#GetProfileResourceAssociationRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#GetProfileResourceAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Returns information about a specified Route 53 Profile resource association.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profileresourceassociation/{ProfileResourceAssociationId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#GetProfileResourceAssociationRequest": { + "type": "structure", + "members": { + "ProfileResourceAssociationId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n \n The ID of the profile resource association that you want to get information about.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#GetProfileResourceAssociationResponse": { + "type": "structure", + "members": { + "ProfileResourceAssociation": { + "target": "com.amazonaws.route53profiles#ProfileResourceAssociation", + "traits": { + "smithy.api#documentation": "\n Information about the Profile resource association that you specified in a GetProfileResourceAssociation request.\n
\n Information about the Profile, including the status of the Profile.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#InternalServiceErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "\nAn internal server error occured. Retry your request.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#InvalidNextTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#String" + } + }, + "traits": { + "smithy.api#documentation": "\nThe NextToken you provided isn;t valid.\n
\n The parameter field name for the invalid parameter exception.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n One or more parameters in this request are not valid.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#String" + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n The resource type that caused the limits to be exceeded.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The request caused one or more limits to be exceeded.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#ListProfileAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#ListProfileAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#ListProfileAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Lists all the VPCs that the specified Route 53 Profile is associated with.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profileassociations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProfileAssociations", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#ListProfileAssociationsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the VPC.\n
", + "smithy.api#httpQuery": "resourceId" + } + }, + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\nID of the Profile.\n
", + "smithy.api#httpQuery": "profileId" + } + }, + "MaxResults": { + "target": "com.amazonaws.route53profiles#MaxResults", + "traits": { + "smithy.api#documentation": "\n The maximum number of objects that you want to return for this request. If more objects are available, in the response, \n a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.
\n If you don't specify a value for MaxResults, up to 100 objects are returned.\n
\n For the first call to this list request, omit this value.\n
\nWhen you request a list of objects, at most the number of objects specified by MaxResults is returned. \n If more objects are available for retrieval, a NextToken value is returned in the response. \n To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
\n A complex type that containts settings information about the profile's VPC associations.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.route53profiles#NextToken", + "traits": { + "smithy.api#documentation": "\n If more than MaxResults profile associations match the specified criteria, you can submit another \n ListProfileAssociations request to get the next group of results. In the next request, specify the value of NextToken from the previous response.\n
\n Lists all the resource associations for the specified Route 53 Profile.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profileresourceassociations/profileid/{ProfileId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProfileResourceAssociations", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#ListProfileResourceAssociationsRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe ID of the Profile.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n ID of a resource if you want information on only one type.\n
", + "smithy.api#httpQuery": "resourceType" + } + }, + "MaxResults": { + "target": "com.amazonaws.route53profiles#MaxResults", + "traits": { + "smithy.api#documentation": "\n The maximum number of objects that you want to return for this request. If more objects are available, in the response, \n a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.
\n If you don't specify a value for MaxResults, up to 100 objects are returned.\n
\n For the first call to this list request, omit this value.\n
\nWhen you request a list of objects, at most the number of objects specified by MaxResults is returned. \n If more objects are available for retrieval, a NextToken value is returned in the response. \n To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
\n Information about the profile resource association that you specified in a GetProfileResourceAssociation request.\n
\n If more than MaxResults resource associations match the specified criteria, you can submit another \n ListProfileResourceAssociations request to get the next group of results. In the next request, specify the value of NextToken from the previous response.\n
\n Lists all the Route 53 Profiles associated with your Amazon Web Services account.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProfileSummaries", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#ListProfilesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.route53profiles#MaxResults", + "traits": { + "smithy.api#documentation": "\n The maximum number of objects that you want to return for this request. If more objects are available, in the response, \n a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.
\n If you don't specify a value for MaxResults, up to 100 objects are returned.\n
\n For the first call to this list request, omit this value.\n
\nWhen you request a list of objects, at most the number of objects specified by MaxResults is returned. \n If more objects are available for retrieval, a NextToken value is returned in the response. \n To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
\n Summary information about the Profiles.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.route53profiles#NextToken", + "traits": { + "smithy.api#documentation": "\n If more than MaxResults resource associations match the specified criteria, you can submit another \n ListProfiles request to get the next group of results. In the next request, specify the value of NextToken from the previous response.\n
\n Lists the tags that you associated with the specified resource.\n
", + "smithy.api#http": { + "uri": "/tags/{ResourceArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.route53profiles#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the resource that you want to list the tags for.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.route53profiles#TagMap", + "traits": { + "smithy.api#documentation": "\n The tags that are associated with the resource that you specified in the ListTagsForResource request.\n
\nID of the Profile.\n
" + } + }, + "Arn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Profile.\n
" + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\nName of the Profile.\n
" + } + }, + "OwnerId": { + "target": "com.amazonaws.route53profiles#AccountId", + "traits": { + "smithy.api#documentation": "\n Amazon Web Services account ID of the Profile owner.\n
" + } + }, + "Status": { + "target": "com.amazonaws.route53profiles#ProfileStatus", + "traits": { + "smithy.api#documentation": "\n The status for the Profile.\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n Status message that includes additiona information about the Profile.\n
" + } + }, + "ShareStatus": { + "target": "com.amazonaws.route53profiles#ShareStatus", + "traits": { + "smithy.api#documentation": "\n Sharing status for the Profile.\n
" + } + }, + "CreationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile was created, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + }, + "ModificationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile was modified, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + }, + "ClientToken": { + "target": "com.amazonaws.route53profiles#CreatorRequestId", + "traits": { + "smithy.api#documentation": "\n The ClientToken value that was assigned when the Profile was created.\n
\n A complex type that includes settings for a Route 53 Profile.\n
" + } + }, + "com.amazonaws.route53profiles#ProfileAssociation": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile association.\n
" + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n Name of the Profile association.\n
" + } + }, + "OwnerId": { + "target": "com.amazonaws.route53profiles#AccountId", + "traits": { + "smithy.api#documentation": "\n Amazon Web Services account ID of the Profile association owner.\n
" + } + }, + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\nID of the Profile.\n
" + } + }, + "ResourceId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the VPC.\n
" + } + }, + "Status": { + "target": "com.amazonaws.route53profiles#ProfileStatus", + "traits": { + "smithy.api#documentation": "\n Status of the Profile association.\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n Additional information about the Profile association.\n
" + } + }, + "CreationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + }, + "ModificationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n An association between a Route 53 Profile and a VPC.\n
" + } + }, + "com.amazonaws.route53profiles#ProfileAssociations": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#ProfileAssociation" + } + }, + "com.amazonaws.route53profiles#ProfileResourceAssociation": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile resource association.\n
" + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n Name of the Profile resource association.\n
" + } + }, + "OwnerId": { + "target": "com.amazonaws.route53profiles#AccountId", + "traits": { + "smithy.api#documentation": "\n Amazon Web Services account ID of the Profile resource association owner.\n
" + } + }, + "ProfileId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n Profile ID of the Profile that the resources are associated with.\n
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the resource association.\n
" + } + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n Resource type, such as a private hosted zone, or DNS Firewall rule group.\n
" + } + }, + "ResourceProperties": { + "target": "com.amazonaws.route53profiles#ResourceProperties", + "traits": { + "smithy.api#documentation": "\n If the DNS resource is a DNS Firewall rule group, this indicates the priority.\n
" + } + }, + "Status": { + "target": "com.amazonaws.route53profiles#ProfileStatus", + "traits": { + "smithy.api#documentation": "\n Status of the Profile resource association.\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n Additional information about the Profile resource association.\n
" + } + }, + "CreationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + }, + "ModificationTime": { + "target": "com.amazonaws.route53profiles#Rfc3339Timestamp", + "traits": { + "smithy.api#documentation": "\n The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The association between a Route 53 Profile and resources.\n
" + } + }, + "com.amazonaws.route53profiles#ProfileResourceAssociations": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#ProfileResourceAssociation" + } + }, + "com.amazonaws.route53profiles#ProfileStatus": { + "type": "enum", + "members": { + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.route53profiles#ProfileSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\n ID of the Profile.\n
" + } + }, + "Arn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Profile.\n
" + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\n Name of the Profile.\n
" + } + }, + "ShareStatus": { + "target": "com.amazonaws.route53profiles#ShareStatus", + "traits": { + "smithy.api#documentation": "\n Share status of the Profile.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Summary information about a Route 53 Profile.\n
" + } + }, + "com.amazonaws.route53profiles#ProfileSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#ProfileSummary" + } + }, + "com.amazonaws.route53profiles#ResourceExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#String" + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n The resource type that caused the resource exists exception.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The resource you are trying to associate, has already been associated.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53profiles#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#String" + }, + "ResourceType": { + "target": "com.amazonaws.route53profiles#String", + "traits": { + "smithy.api#documentation": "\n The resource type that caused the resource not found exception.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe resource you are associating is not found.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#ResourceProperties": { + "type": "string" + }, + "com.amazonaws.route53profiles#Rfc3339Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.route53profiles#Route53Profiles": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.route53profiles#AssociateProfile" + }, + { + "target": "com.amazonaws.route53profiles#AssociateResourceToProfile" + }, + { + "target": "com.amazonaws.route53profiles#CreateProfile" + }, + { + "target": "com.amazonaws.route53profiles#DeleteProfile" + }, + { + "target": "com.amazonaws.route53profiles#DisassociateProfile" + }, + { + "target": "com.amazonaws.route53profiles#DisassociateResourceFromProfile" + }, + { + "target": "com.amazonaws.route53profiles#GetProfile" + }, + { + "target": "com.amazonaws.route53profiles#GetProfileAssociation" + }, + { + "target": "com.amazonaws.route53profiles#GetProfileResourceAssociation" + }, + { + "target": "com.amazonaws.route53profiles#ListProfileAssociations" + }, + { + "target": "com.amazonaws.route53profiles#ListProfileResourceAssociations" + }, + { + "target": "com.amazonaws.route53profiles#ListProfiles" + }, + { + "target": "com.amazonaws.route53profiles#ListTagsForResource" + }, + { + "target": "com.amazonaws.route53profiles#TagResource" + }, + { + "target": "com.amazonaws.route53profiles#UntagResource" + }, + { + "target": "com.amazonaws.route53profiles#UpdateProfileResourceAssociation" + } + ], + "traits": { + "aws.api#service": { + "cloudTrailEventSource": "route53profiles.amazonaws.com", + "sdkId": "Route53Profiles", + "arnNamespace": "route53profiles" + }, + "aws.auth#sigv4": { + "name": "route53profiles" + }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the presence of tag key-value pairs attached to the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the presence of tag key-value pairs in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by the presence of tag keys in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "\n With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs and AWS accounts\n
", + "smithy.api#title": "Route 53 Profiles", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "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" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53profiles-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53profiles-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53profiles.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53profiles.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53profiles.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.route53profiles#ShareStatus": { + "type": "enum", + "members": { + "NOT_SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_SHARED" + } + }, + "SHARED_WITH_ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_WITH_ME" + } + }, + "SHARED_BY_ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_BY_ME" + } + } + } + }, + "com.amazonaws.route53profiles#String": { + "type": "string" + }, + "com.amazonaws.route53profiles#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.route53profiles#TagKey", + "traits": { + "smithy.api#documentation": "\n Key associated with the Tag.\n
\nValue for the Tag.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\nTag for the Profile.\n
" + } + }, + "com.amazonaws.route53profiles#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.route53profiles#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.route53profiles#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53profiles#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.route53profiles#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.route53profiles#TagKey" + }, + "value": { + "target": "com.amazonaws.route53profiles#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.route53profiles#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Adds one or more tags to a specified resource.\n
", + "smithy.api#http": { + "uri": "/tags/{ResourceArn}", + "method": "POST", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the resource that you want to add tags to. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.route53profiles#TagMap", + "traits": { + "smithy.api#documentation": "\n The tags that you want to add to the specified resource.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53profiles#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53profiles#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "\n The request was throttled. Try again in a few minutes.\n
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53profiles#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Removes one or more tags from a specified resource.\n
", + "smithy.api#http": { + "uri": "/tags/{ResourceArn}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.route53profiles#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53profiles#Arn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the resource that you want to remove tags from.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.route53profiles#TagKeyList", + "traits": { + "smithy.api#documentation": "\n The tags that you want to remove to the specified resource.\n
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53profiles#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53profiles#UpdateProfileResourceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53profiles#UpdateProfileResourceAssociationRequest" + }, + "output": { + "target": "com.amazonaws.route53profiles#UpdateProfileResourceAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53profiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53profiles#ConflictException" + }, + { + "target": "com.amazonaws.route53profiles#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53profiles#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53profiles#LimitExceededException" + }, + { + "target": "com.amazonaws.route53profiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53profiles#ThrottlingException" + }, + { + "target": "com.amazonaws.route53profiles#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nUpdates the specified Route 53 Profile resourse association.\n
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/profileresourceassociation/{ProfileResourceAssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.route53profiles#UpdateProfileResourceAssociationRequest": { + "type": "structure", + "members": { + "ProfileResourceAssociationId": { + "target": "com.amazonaws.route53profiles#ResourceId", + "traits": { + "smithy.api#documentation": "\nID of the resource association.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53profiles#Name", + "traits": { + "smithy.api#documentation": "\nName of the resource association.\n
" + } + }, + "ResourceProperties": { + "target": "com.amazonaws.route53profiles#ResourceProperties", + "traits": { + "smithy.api#documentation": "\n If you are adding a DNS Firewall rule group, include also a priority in this format:
\n\n Key=FirewallRuleGroupPriority,Value=100.\n
\n Information about the UpdateProfileResourceAssociation request, including a status message.\n
\n You have provided an invalid command.\n
", + "smithy.api#error": "client" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 7e882dbb706..16bddfbd6e5 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -14081,7 +14081,7 @@ "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The default size of the EBS storage volume for a private space.
", + "smithy.api#documentation": "The default size of the EBS storage volume for a space.
", "smithy.api#required": {} } }, @@ -14089,13 +14089,13 @@ "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum size of the EBS storage volume for a private space.
", + "smithy.api#documentation": "The maximum size of the EBS storage volume for a space.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A collection of default EBS storage settings that applies to private spaces created within a domain or user profile.
" + "smithy.api#documentation": "A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
" } }, "com.amazonaws.sagemaker#DefaultGid": { @@ -14127,6 +14127,21 @@ }, "KernelGatewayAppSettings": { "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings" + }, + "JupyterLabAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterLabAppSettings" + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings" + }, + "CustomPosixUserConfig": { + "target": "com.amazonaws.sagemaker#CustomPosixUserConfig" + }, + "CustomFileSystemConfigs": { + "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", + "traits": { + "smithy.api#documentation": "The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.
" + } } }, "traits": { @@ -14139,12 +14154,12 @@ "DefaultEbsStorageSettings": { "target": "com.amazonaws.sagemaker#DefaultEbsStorageSettings", "traits": { - "smithy.api#documentation": "The default EBS storage settings for a private space.
" + "smithy.api#documentation": "The default EBS storage settings for a space.
" } } }, "traits": { - "smithy.api#documentation": "The default storage settings for a private space.
" + "smithy.api#documentation": "The default storage settings for a space.
" } }, "com.amazonaws.sagemaker#DefaultUid": { @@ -25366,13 +25381,13 @@ "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size of an EBS storage volume for a private space.
", + "smithy.api#documentation": "The size of an EBS storage volume for a space.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A collection of EBS storage settings that applies to private spaces.
" + "smithy.api#documentation": "A collection of EBS storage settings that apply to both private and shared spaces.
" } }, "com.amazonaws.sagemaker#Edge": { @@ -47622,7 +47637,7 @@ "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The user profile who is the owner of the private space.
", + "smithy.api#documentation": "The user profile who is the owner of the space.
", "smithy.api#required": {} } } @@ -47637,7 +47652,7 @@ "OwnerUserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "The user profile who is the owner of the private space.
" + "smithy.api#documentation": "The user profile who is the owner of the space.
" } } }, @@ -58004,7 +58019,7 @@ "SpaceStorageSettings": { "target": "com.amazonaws.sagemaker#SpaceStorageSettings", "traits": { - "smithy.api#documentation": "The storage settings for a private space.
" + "smithy.api#documentation": "The storage settings for a space.
" } }, "CustomFileSystems": { @@ -58030,7 +58045,7 @@ "SpaceStorageSettings": { "target": "com.amazonaws.sagemaker#SpaceStorageSettings", "traits": { - "smithy.api#documentation": "The storage settings for a private space.
" + "smithy.api#documentation": "The storage settings for a space.
" } } }, @@ -58138,12 +58153,12 @@ "EbsStorageSettings": { "target": "com.amazonaws.sagemaker#EbsStorageSettings", "traits": { - "smithy.api#documentation": "A collection of EBS storage settings for a private space.
" + "smithy.api#documentation": "A collection of EBS storage settings for a space.
" } } }, "traits": { - "smithy.api#documentation": "The storage settings for a private space.
" + "smithy.api#documentation": "The storage settings for a space.
" } }, "com.amazonaws.sagemaker#SpawnRate": { @@ -66366,7 +66381,7 @@ "SpaceStorageSettings": { "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings", "traits": { - "smithy.api#documentation": "The storage settings for a private space.
" + "smithy.api#documentation": "The storage settings for a space.
" } }, "DefaultLandingUri": { diff --git a/codegen/sdk-codegen/aws-models/servicediscovery.json b/codegen/sdk-codegen/aws-models/servicediscovery.json index 5ff916fb3a9..483b9e06716 100644 --- a/codegen/sdk-codegen/aws-models/servicediscovery.json +++ b/codegen/sdk-codegen/aws-models/servicediscovery.json @@ -105,7 +105,7 @@ } ], "traits": { - "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.
", + "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 Amazon Web Services account, see Cloud Map\n quotas in the Cloud Map Developer Guide.
", "smithy.api#examples": [ { "title": "CreateHttpNamespace example", @@ -135,7 +135,7 @@ "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "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).
A unique string that identifies the request and that allows failed CreateHttpNamespace\n requests to be retried without the risk of running the operation twice. CreatorRequestId can be any\n unique string (for example, a date/time stamp).
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.
" + "smithy.api#documentation": "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.
" } } }, @@ -196,7 +196,7 @@ } ], "traits": { - "smithy.api#documentation": "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.
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The\n namespace defines your service naming scheme. For example, if you name your namespace example.com\n and name your service backend, the resulting DNS name for the service is\n backend.example.com. Service instances that are registered using a private DNS namespace can be\n discovered using either a DiscoverInstances request or using DNS. For the current quota on the\n 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 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#documentation": "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#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "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).
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).
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.
" + "smithy.api#documentation": "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.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties", "traits": { - "smithy.api#documentation": "Properties for the\n private DNS namespace.
" + "smithy.api#documentation": "Properties for the private DNS\n namespace.
" } } }, @@ -300,7 +300,7 @@ } ], "traits": { - "smithy.api#documentation": "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.
Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your\n service 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\n discover instances that were registered with a public DNS namespace by using either a\n DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you\n 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)\n Regions.
The name that you want to assign to this namespace.
\nDo not include sensitive information in the name. The name is publicly available using DNS\n queries.
\nThe name that you want to assign to this namespace.
\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\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).
A 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).
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.
" + "smithy.api#documentation": "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.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties", "traits": { - "smithy.api#documentation": "Properties for the\n public DNS namespace.
" + "smithy.api#documentation": "Properties for the public DNS\n namespace.
" } } }, @@ -363,7 +363,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\n status of the operation, see GetOperation.
" + "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.
" } } }, @@ -397,7 +397,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\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.
", + "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 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\n the same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.
", "smithy.api#examples": [ { "title": "Example: Create service", @@ -447,20 +447,20 @@ "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { - "smithy.api#documentation": "The name that you want to assign to the service.
\nDo not include sensitive information in the name if the namespace is discoverable by public\n DNS queries.
\nIf you want Cloud Map to create an SRV record when you register an instance\n and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for\n 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 name that you want to assign to the service.
\nDo not include sensitive information in the name if the namespace is discoverable by public DNS\n queries.
\nIf you want Cloud Map to create an SRV record when you register an instance and you're using\n a 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\n 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 names that differ\n only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be\n distinguished. However, if you use a namespace that's only accessible by API calls, then you can create\n 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\n specified, but it 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 specified, but\n it can be specified either here or in the DnsConfig object.
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 unique string that identifies the request and that allows failed CreateService requests to\n be retried without the risk of running the operation twice. CreatorRequestId can be any unique\n string (for example, a date/timestamp).
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.
" + "smithy.api#documentation": "A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create\n 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\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.
" + "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains settings for an\n optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check\n with all the Route 53 DNS records that you specify in DnsConfig.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n 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\n HealthCheckCustomConfig or HealthCheckConfig but not both.
You can't add, update, or delete a HealthCheckCustomConfig configuration from\n an existing service.
A complex type that contains information about an optional custom health check.
\nIf you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.
You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing\n service.
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.
" + "smithy.api#documentation": "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.
" } }, "Type": { "target": "com.amazonaws.servicediscovery#ServiceTypeOption", "traits": { - "smithy.api#documentation": "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.
If present, specifies that the service instances are only discoverable using the\n DiscoverInstances API operation. No DNS records is registered for the service instances. The only\n valid value is HTTP.
The health check for the instance that's specified by ServiceId and\n InstanceId isn't a custom health check.
The health check for the instance that's specified by ServiceId and InstanceId\n isn't a custom health check.
Deletes a namespace from the current account. If the namespace still contains one or more\n services, the request fails.
", + "smithy.api#documentation": "Deletes a namespace from the current account. If the namespace still contains one or more services, the\n request fails.
", "smithy.api#examples": [ { "title": "Example: Delete namespace", @@ -636,7 +636,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified service. If the service still contains one or more registered instances,\n the request fails.
", + "smithy.api#documentation": "Deletes a specified service. If the service still contains one or more registered instances, the request\n fails.
", "smithy.api#examples": [ { "title": "Example: Delete service", @@ -697,7 +697,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the\n specified instance.
", + "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#examples": [ { "title": "Example: Deregister a service instance", @@ -772,7 +772,7 @@ } ], "traits": { - "smithy.api#documentation": "Discovers registered instances for a specified namespace and service. You can use\n DiscoverInstances to discover instances for any type of namespace.\n DiscoverInstances returns a randomized list of instances allowing customers to\n distribute traffic evenly across instances. For public and private DNS namespaces, you can also\n use DNS queries 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. DiscoverInstances\n returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For\n public and private DNS namespaces, you can also use DNS queries to discover instances.
The HttpName name of the namespace. It's found in the\n HttpProperties member of the Properties member of the\n namespace.
The HttpName name of the namespace. It's found in the HttpProperties member of\n the Properties member of the namespace. In most cases, Name and HttpName\n match. However, if you reuse Name for namespace creation, a generated hash is added to\n HttpName to distinguish the two.
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.
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\n returns up to 100 instances.
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.
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.
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.
Opportunistic filters to scope the results based on custom attributes. If there are instances that match\n both the filters specified in both the QueryParameters parameter and this parameter, all of these\n instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are\n specified in the QueryParameters parameter are returned.
The 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.
\nThe health status of the instances that you want to discover. This parameter is ignored for services that\n 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, return all\n instances. This is also called failing open.
\nA complex type that contains one HttpInstanceSummary for each registered\n instance.
A complex type that contains one HttpInstanceSummary for each registered instance.
The increasing revision associated to the response Instances list. If a new instance is\n registered or deregistered, the InstancesRevision updates. The health status updates\n don't update InstancesRevision.
The increasing revision associated to the response Instances list. If a new instance is registered or\n deregistered, the InstancesRevision updates. The health status updates don't update\n InstancesRevision.
Discovers the increasing revision associated with an instance.
", "smithy.api#endpoint": { "hostPrefix": "data-" - } + }, + "smithy.api#examples": [ + { + "title": "To discover the revision for a registered instance", + "documentation": "The following example discovers the revision ID for a registered instance.", + "input": { + "NamespaceName": "example-namespace", + "ServiceName": "example-service" + }, + "output": { + "InstancesRevision": 123456 + } + } + ] } }, "com.amazonaws.servicediscovery#DiscoverInstancesRevisionRequest": { @@ -905,7 +918,7 @@ "NamespaceName": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "The HttpName name of the namespace. It's found in the\n HttpProperties member of the Properties member of the\n namespace.
The HttpName name of the namespace. It's found in the HttpProperties member of\n the Properties member of the namespace.
The increasing revision associated to the response Instances list. If a new instance is\n registered or deregistered, the InstancesRevision updates. The health status updates\n don't update InstancesRevision.
The increasing revision associated to the response Instances list. If a new instance is registered or\n deregistered, the InstancesRevision updates. The health status updates don't update\n InstancesRevision.
\n Use\n NamespaceId in Service instead.\n
\nThe ID of the namespace to use for DNS configuration.
" + "smithy.api#documentation": "\n Use\n NamespaceId in Service\n 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\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.
\nThe routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you\n 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 returns the\n applicable 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\n to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with\n the IP 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\n returns 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\n less 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\n one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds\n to DNS 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\n returns the applicable value for one randomly selected instance.
\nFor more information about the weighted routing policy, see Weighted Routing in\n the Route 53 Developer Guide.
\nAn 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.
An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map\n to create when you register an instance.
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.
A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create\n when you register an instance.
\nThe record types of a service can only be changed by deleting the service and recreating it with a new\n Dnsconfig.
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.
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.
A complex type that contains information about changes to the Route 53 DNS records that\n Cloud Map creates when you register an instance.
" + "smithy.api#documentation": "A complex type that contains information about changes to the Route 53 DNS records that Cloud Map creates\n when you register an instance.
" } }, "com.amazonaws.servicediscovery#DnsProperties": { @@ -1006,7 +1019,7 @@ } }, "traits": { - "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.
" + "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.
" } }, "com.amazonaws.servicediscovery#DnsRecord": { @@ -1015,20 +1028,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\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 type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.\n You 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\n or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA records, when\n 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 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\n 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 1 and can't\n 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 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\n the RegisterInstance request, Cloud Map automatically creates A and/or\n AAAA records that have the same name as the value of service-hostname in the\n SRV record. You can ignore these records.
If you're using a system that requires a specific SRV format, such as HAProxy, see the\n Name element\n in the documentation about CreateService for information about how to specify the correct name\n format.
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.
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\n routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request,\n the 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.
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.
" + "smithy.api#documentation": "A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create\n when you register an instance.
" } }, "com.amazonaws.servicediscovery#DnsRecordList": { @@ -1216,7 +1229,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets 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.
\nGets the current health status (Healthy, Unhealthy, or Unknown) of\n one or 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.
\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.
\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.
\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\n MaxResults, Cloud Map 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 MaxResults,\n 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\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.
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.
A complex type that contains the IDs and the health status of the instances that you\n specified in the GetInstancesHealthStatus request.
A complex type that contains the IDs and the health status of the instances that you specified in the\n GetInstancesHealthStatus 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.
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.
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#documentation": "The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint\n 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 successful, Route 53\n submits 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\n 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\n Whether an Endpoint Is Healthy in the 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\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 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\n don't specify a value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value\n for ResourcePath.
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.
" + "smithy.api#documentation": "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\n Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
" } } }, "traits": { - "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.
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.
\n\n Public DNS and HTTP namespaces only. A complex type that contains settings for an\n optional health check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information\n about pricing for health checks, see Amazon Route 53\n 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\n endpoint tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the A and\n AAAA 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\n will 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\n every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However,\n health checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one\n second 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\n Regions, see 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\n 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 information about\n pricing for health checks, see Amazon Route 53\n Pricing.
\nThis 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.
This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds\n after receiving an UpdateInstanceCustomHealthStatus request before changing the status of the\n 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 service\n instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value\n before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after the\n first request to make the change.
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.
A complex type that contains information about an optional custom health check. A custom health check,\n which requires 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 resource isn't\n available over the internet. For example, you can use a custom health check when the instance is in an Amazon\n VPC. (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\n or HealthCheckConfig but not both.
To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus\n request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in\n the most recent 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\n 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 that time to\n change the status back to healthy, Cloud Map stops routing traffic to the resource.
\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.
\n \n \n \n
The HttpName name of the namespace. It's found in the HttpProperties member of\n the Properties member of the namespace.
If you configured health checking in the service, the current health status of the service\n instance.
" + "smithy.api#documentation": "If you configured health checking in the service, the current health status of the service 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\n attributes.
" + "smithy.api#documentation": "If you included any attributes when you registered the instance, the values of those attributes.
" } } }, "traits": { - "smithy.api#documentation": "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.
In a response to a DiscoverInstances request, HttpInstanceSummary contains information about one instance\n that matches the values that you specified in the request.
An updated\n description for the HTTP namespace.
", + "smithy.api#documentation": "An updated description for the HTTP\n namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the HTTP namespace.
" + "smithy.api#documentation": "Updated properties for the HTTP\n namespace.
" } }, "com.amazonaws.servicediscovery#HttpProperties": { @@ -1658,25 +1671,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\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.
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\n record, the value of InstanceId is automatically included as part of the value for the\n SRV 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\n using the same service.
\nIf you specify an existing InstanceId and ServiceId, Cloud Map updates the\n existing DNS records. If there's also an existing health check, Cloud Map deletes the old health check and\n creates 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.
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 unique string that identifies the request and that allows failed RegisterInstance requests\n to be retried without the risk of executing the operation twice. You must use a unique\n CreatorRequestId string every time you submit a RegisterInstance request if you're\n registering additional instances for the same namespace and service. CreatorRequestId can be any\n unique string (for example, a 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.
\nDo not include sensitive information in the attributes if the namespace is discoverable by\n public DNS 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 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 load balancer,\n specify the DNS name that's associated with the load balancer. For information about how to get the DNS name,\n 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\n an A record, an AAAA record, or both.
In the service that's specified by ServiceId, the value of RoutingPolicy\n must be WEIGHTED.
If the service that's specified by ServiceId includes HealthCheckConfig\n settings, Cloud Map creates the health check, but it won'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 resources\n other 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\n to 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\n value 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\n 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 settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify\n a 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\n send requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check\n when you created the service.
A complex type that contains information about an instance that Cloud Map creates when you\n submit a RegisterInstance request.
A complex type that contains information about an instance that Cloud Map creates when you submit a\n RegisterInstance request.
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#documentation": "No instance exists with the specified ID, or the instance was recently registered, and information about\n the instance hasn't propagated yet.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1737,12 +1750,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\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 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\n the load balancer.
\nThe Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is\n specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4\n 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\n example, example.com).
For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for\n example, 192.0.2.44).
For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for\n example, 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 complex type that contains information about the instances that you registered by using a\n specified service.
" + "smithy.api#documentation": "A complex type that contains information about the instances that you registered by using a specified\n service.
" } }, "com.amazonaws.servicediscovery#InstanceSummaryList": { @@ -1762,7 +1775,7 @@ } }, "traits": { - "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#documentation": "One or more specified values aren't valid. For example, a required value might be missing, a numeric value\n might be outside the allowed range, or a string value might exceed length constraints.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1784,7 +1797,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists summary information about the instances that you registered by using a specified\n service.
", + "smithy.api#documentation": "Lists summary information about the instances that you registered by using a specified service.
", "smithy.api#examples": [ { "title": "Example: List service instances", @@ -1825,13 +1838,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\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.
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\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,\n Cloud Map returns up 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, Cloud Map\n returns up to 100 instances.
Summary information about the instances that are associated with the specified\n service.
" + "smithy.api#documentation": "Summary information about the instances that are associated with the specified service.
" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "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.
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\n NextToken from the previous response in the next request.
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.
For the first ListNamespaces request, omit this value.
If the response contains NextToken, submit another ListNamespaces request to get\n the 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.\n It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria\n but that subsequent groups of MaxResults namespaces do contain namespaces that match the\n 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,\n Cloud Map returns up 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, Cloud Map\n returns up to 100 namespaces.
An array that contains one NamespaceSummary object for each namespace that\n matches the specified filter criteria.
An array that contains one NamespaceSummary object for each namespace that matches the\n specified filter 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.
If the response contains NextToken, submit another ListNamespaces request to get\n the 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.\n It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria\n but that subsequent groups of MaxResults namespaces do contain namespaces that match the\n 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.
For the first ListOperations request, omit this value.
If the response contains NextToken, submit another ListOperations request to get\n the 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.\n It's possible that no operations in the first MaxResults operations matched the specified criteria\n but that subsequent groups of MaxResults operations do contain operations that match the\n criteria.
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.
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, Cloud Map\n returns up to 100 operations.
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.
A complex type that contains specifications for the operations that you want to list, for example,\n 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\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.
If the response contains NextToken, submit another ListOperations request to get\n the 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.\n It's possible that no operations in the first MaxResults operations matched the specified criteria\n but that subsequent groups of MaxResults operations do contain operations that match the\n criteria.
Lists summary information for all the services that are associated with one or more\n specified namespaces.
", + "smithy.api#documentation": "Lists summary information for all the services that are associated with one or more\n namespaces.
", "smithy.api#examples": [ { "title": "Example: List services", @@ -2136,19 +2149,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\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.
For the first ListServices request, omit this value.
If the response contains NextToken, submit another ListServices request to get\n the 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.\n It's possible that no services in the first MaxResults services matched the specified criteria but\n that subsequent groups of MaxResults services do contain services that match the criteria.
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.
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, Cloud Map returns\n up to 100 services.
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.
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.
An array that contains one ServiceSummary object for each service that matches\n the specified filter criteria.
An array that contains one ServiceSummary object for each service that matches the specified\n filter 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.
If the response contains NextToken, submit another ListServices request to get\n the 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.\n It's possible that no services in the first MaxResults services matched the specified criteria but\n that subsequent groups of MaxResults services do contain services that match the criteria.
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.
The type of the namespace. The methods for discovering instances depends on the value that you\n 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\n API.
Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances\n API.
A complex type that contains information that's specific to the type of the\n namespace.
" + "smithy.api#documentation": "A complex type that contains information that's specific to the type of the 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\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.
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.
A unique string that identifies the request and that allows failed requests to be retried\n without the risk of running an operation twice.
" + "smithy.api#documentation": "A unique string that identifies the request and that allows failed requests to be retried without the risk\n of running an operation twice.
" } } }, @@ -2358,19 +2371,19 @@ "Values": { "target": "com.amazonaws.servicediscovery#FilterValues", "traits": { - "smithy.api#documentation": "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.
Specify the values that are applicable to the value that you specify for 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.
Specify 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 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.
Specify the operator that you want to use to determine whether a namespace matches the specified value.\n Valid values for Condition are one of the following.
\n EQ: When you specify EQ for Condition, you can specify only one\n value. EQ is supported for TYPE, NAME, and HTTP_NAME.\n EQ is the default condition and can be omitted.
\n BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can\n specify only one value. BEGINS_WITH is supported for TYPE, NAME, and\n HTTP_NAME.
A complex type that identifies the namespaces that you want to list. You can choose to list\n public or private namespaces.
" + "smithy.api#documentation": "A complex type that identifies the namespaces that you want to list. You can choose to list public or\n private namespaces.
" } }, "com.amazonaws.servicediscovery#NamespaceFilterName": { @@ -2463,7 +2476,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\n you create a namespace.
" + "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.
" } }, "HttpProperties": { @@ -2501,7 +2514,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\n Route 53 hosted zone 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 Route 53 hosted\n zone that has the same name as the namespace.
" } }, "Type": { @@ -2595,25 +2608,25 @@ "ErrorMessage": { "target": "com.amazonaws.servicediscovery#Message", "traits": { - "smithy.api#documentation": "If the value of Status is FAIL, the reason that the operation\n failed.
If the value of Status is FAIL, the reason that the operation failed.
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 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 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 request was submitted, in Unix date/time format and Coordinated Universal Time\n (UTC). The value of CreateDate is accurate to milliseconds. For example, the value\n 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.
The date and time that the value of Status changed to the current value, in Unix date/time\n format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents 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\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 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\n 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:\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.
\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\n format and Coordinated Universal Time (UTC). The start date must be the first value.
\nThe 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 operator that you want to use to determine whether an operation matches the specified value. Valid\n values 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\n more values. IN is supported for STATUS and TYPE. An operation must\n match one of 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\n Universal Time (UTC). The start date must be the first value. BETWEEN is supported for\n UPDATE_DATE.
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.
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.
A complex type that contains information about an operation that matches the criteria that\n you specified in a ListOperations request.
" + "smithy.api#documentation": "A complex type that contains information about an operation that matches the criteria that you specified in\n a ListOperations\n request.
" } }, "com.amazonaws.servicediscovery#OperationSummaryList": { @@ -2858,18 +2871,18 @@ "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "An updated\n description for the private DNS namespace.
" + "smithy.api#documentation": "An updated description for the\n private DNS namespace.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange", "traits": { - "smithy.api#documentation": "Properties to be\n updated in the private DNS namespace.
" + "smithy.api#documentation": "Properties to be updated in the\n private DNS namespace.
" } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the private DNS namespace.
" + "smithy.api#documentation": "Updated properties for the private\n DNS namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties": { @@ -2878,13 +2891,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable", "traits": { - "smithy.api#documentation": "DNS properties for\n the private DNS namespace.
", + "smithy.api#documentation": "DNS properties for the private DNS\n namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for\n the private DNS namespace.
" + "smithy.api#documentation": "DNS properties for the private DNS\n namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange": { @@ -2893,13 +2906,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange", "traits": { - "smithy.api#documentation": "Updated DNS\n properties for the private DNS namespace.
", + "smithy.api#documentation": "Updated DNS properties for the\n private DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the private DNS namespace.
" + "smithy.api#documentation": "Updated properties for the private\n DNS namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable": { @@ -2908,13 +2921,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOA", "traits": { - "smithy.api#documentation": "Fields for the Start\n of Authority (SOA) record for the hosted zone for the private DNS\n namespace.
", + "smithy.api#documentation": "Fields for the Start of Authority\n (SOA) record for the hosted zone for the private DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for\n the private DNS namespace.
" + "smithy.api#documentation": "DNS properties for the private DNS\n namespace.
" } }, "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange": { @@ -2923,13 +2936,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOAChange", "traits": { - "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#documentation": "Updated fields for the Start of\n Authority (SOA) record for the hosted zone for the private DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated DNS\n properties for the private DNS namespace.
" + "smithy.api#documentation": "Updated DNS properties for the\n private DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsNamespaceChange": { @@ -2938,18 +2951,18 @@ "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "An updated\n description for the public DNS namespace.
" + "smithy.api#documentation": "An updated description for the\n public DNS namespace.
" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange", "traits": { - "smithy.api#documentation": "Properties to be\n updated in the public DNS namespace.
" + "smithy.api#documentation": "Properties to be updated in the\n public DNS namespace.
" } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the public DNS namespace.
" + "smithy.api#documentation": "Updated properties for the public\n DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties": { @@ -2958,13 +2971,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable", "traits": { - "smithy.api#documentation": "DNS properties for\n the public DNS namespace.
", + "smithy.api#documentation": "DNS properties for the public DNS\n namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for\n the public DNS namespace.
" + "smithy.api#documentation": "DNS properties for the public DNS\n namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange": { @@ -2973,13 +2986,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange", "traits": { - "smithy.api#documentation": "Updated DNS\n properties for the hosted zone for the public DNS namespace.
", + "smithy.api#documentation": "Updated DNS properties for the\n hosted zone for the public DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated properties\n for the public DNS namespace.
" + "smithy.api#documentation": "Updated properties for the public\n DNS namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable": { @@ -2988,13 +3001,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOA", "traits": { - "smithy.api#documentation": "Start of Authority\n (SOA) record for the hosted zone for the public DNS namespace.
", + "smithy.api#documentation": "Start of Authority (SOA) record for\n the hosted zone for the public DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "DNS properties for\n the public DNS namespace.
" + "smithy.api#documentation": "DNS properties for the public DNS\n namespace.
" } }, "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange": { @@ -3003,13 +3016,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOAChange", "traits": { - "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#documentation": "Updated fields for the Start of\n Authority (SOA) record for the hosted zone for the public DNS namespace.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated DNS\n properties for the public DNS namespace.
" + "smithy.api#documentation": "Updated DNS properties for the\n public DNS namespace.
" } }, "com.amazonaws.servicediscovery#RecordTTL": { @@ -3076,7 +3089,7 @@ } ], "traits": { - "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.
", + "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\n is 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\n 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 request and specify\n 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 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\n last 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\n the same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.
", "smithy.api#examples": [ { "title": "Example: Register Instance", @@ -3110,21 +3123,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\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\n discoverable by public DNS queries and any Type member of DnsRecord\n for the service contains SRV because the InstanceId is discoverable by\n public DNS queries.
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\n record, the value of InstanceId is automatically included as part of the value for the\n SRV 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\n using the same service.
\nIf you specify an existing InstanceId and ServiceId, Cloud Map updates the\n existing DNS records, if any. If there's also an existing health check, Cloud Map deletes the old health\n check and creates 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.
Do not include sensitive information in InstanceId if the namespace is discoverable by public\n DNS queries and any Type member of DnsRecord for the service contains\n SRV because the InstanceId is discoverable by public DNS queries.
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 unique string that identifies the request and that allows failed RegisterInstance requests\n to be retried without the risk of executing the operation twice. You must use a unique\n CreatorRequestId string every time you submit a RegisterInstance request if you're\n registering additional instances for the same namespace and service. CreatorRequestId can be any\n unique string (for example, a 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.
\nDo not include sensitive information in the attributes if the namespace is discoverable by\n public DNS 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.
Cloud Map 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.
\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.
\nThe following are the supported attribute keys.
\nIf you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load\n balancer, specify the DNS name that's associated with the load balancer. For information about how to get the\n DNS name, see \"DNSName\" in the topic AliasTarget in the\n Route 53 API Reference.
\nNote the following:
\nThe configuration for the service that's specified by ServiceId must include settings for\n an A record, an AAAA record, or both.
In the service that's specified by ServiceId, the value of RoutingPolicy\n must be WEIGHTED.
If the service that's specified by ServiceId includes HealthCheckConfig\n settings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the\n alias record.
Cloud Map 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.
The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.
\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\n is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified,\n then the AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4\n 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\n to 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\n value 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\n 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 settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify\n a 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\n send requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check\n when you created the service.
You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute\n name is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of\n all provided attributes (sum of all keys and values) must not exceed 5,000 characters.
\nThe 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#documentation": "The 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\n throttling quota in the Cloud Map Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -3189,7 +3202,7 @@ } }, "traits": { - "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#documentation": "The specified resource can't be deleted because it contains other resources. For example, you can't delete\n a service that contains any instances.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -3202,7 +3215,7 @@ } }, "traits": { - "smithy.api#documentation": "The resource can't be created because you've reached the quota on the number of\n resources.
", + "smithy.api#documentation": "The resource can't be created because you've reached the quota on the number of resources.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3330,7 +3343,7 @@ "name": "servicediscovery" }, "aws.protocols#awsJson1_1": {}, - "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#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\n instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and\n an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service\n receive an answer that contains up to eight healthy records.
", "smithy.api#title": "AWS Cloud Map", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3374,7 +3387,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3417,7 +3429,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3430,7 +3443,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3444,7 +3456,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3467,7 +3478,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3502,7 +3512,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -3513,14 +3522,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3534,14 +3545,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -3550,11 +3559,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -3565,14 +3574,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3586,7 +3597,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3606,7 +3616,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3692,14 +3701,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -3710,9 +3721,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -4398,13 +4411,13 @@ "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "The time to live\n (TTL) for purposes of negative caching.
", + "smithy.api#documentation": "The time to live (TTL) for purposes\n of negative caching.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Start of Authority\n (SOA) properties for a public or private DNS namespace.
" + "smithy.api#documentation": "Start of Authority (SOA) properties\n for a public or private DNS namespace.
" } }, "com.amazonaws.servicediscovery#SOAChange": { @@ -4413,13 +4426,13 @@ "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "The updated time to\n live (TTL) for purposes of negative caching.
", + "smithy.api#documentation": "The updated time to live (TTL) for\n purposes of negative caching.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updated Start of\n Authority (SOA) properties for a public or private DNS namespace.
" + "smithy.api#documentation": "Updated Start of Authority (SOA)\n properties for a public or private DNS namespace.
" } }, "com.amazonaws.servicediscovery#Service": { @@ -4458,43 +4471,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\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.
" + "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\n 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\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.
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create\n when you register an instance.
\nThe record types of a service can only be changed by deleting the service and recreating it with a new\n 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\n DiscoverInstances API operation.
The service instances can only be discovered using the DiscoverInstances API\n 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 DiscoverInstances\n 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\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.
" + "smithy.api#documentation": "\n Public DNS and HTTP namespaces only. A complex type that contains settings for an\n optional health check. If you specify settings for a health check, Cloud Map associates the health check with\n 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\n HealthCheckCustomConfig or 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 HealthCheckCustomConfig\n or HealthCheckConfig but not both.
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.
The date and time that the service was created, in Unix 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.
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).
A unique string that identifies the request and that allows failed requests to be retried without the risk\n of running the operation twice. CreatorRequestId can be any unique string (for example, a\n date/timestamp).
Information about the Route 53 DNS records that you want Cloud Map to create when you register\n an instance.
" + "smithy.api#documentation": "Information about the Route 53 DNS records that you want Cloud Map to create when you register an\n instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "\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.
\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you\n specify settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig.
The values that are applicable to the value that you specify for Condition to\n filter the list of services.
The values that are applicable to the value that you specify for Condition to filter the list\n of services.
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.
The operator that you want to use to determine whether a service is returned by ListServices.\n Valid 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.
A complex type that lets you specify the namespaces that you want to list services\n for.
" + "smithy.api#documentation": "A complex type that lets you specify the namespaces that you want to list services for.
" } }, "com.amazonaws.servicediscovery#ServiceFilterName": { @@ -4650,7 +4663,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\n DiscoverInstances API operation.
The service instances can only be discovered using the DiscoverInstances API\n 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 DiscoverInstances\n 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\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.
" + "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\n 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\n an instance.
" + "smithy.api#documentation": "Information about the Route 53 DNS records that you want Cloud Map to create when you register an\n instance.
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "\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.
\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you\n specify settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig.
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.
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\n 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\n VPC. (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\n 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\n to an empty string, 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 to an empty\n string, but you can't set the value of a tag to null.
", "smithy.api#required": {} } } @@ -4839,7 +4852,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\n the value of a tag to 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 the value of a\n tag to an empty string, but you can't set the value of a tag to null.
", "smithy.api#required": {} } } @@ -4881,7 +4894,7 @@ } }, "traits": { - "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#documentation": "The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a\n resource is 50.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4972,7 +4985,22 @@ } ], "traits": { - "smithy.api#documentation": "Updates an HTTP\n namespace.
" + "smithy.api#documentation": "Updates an HTTP\n namespace.
", + "smithy.api#examples": [ + { + "title": "To update a HTTP namespace", + "documentation": "The following example updates the description of a HTTP namespace.", + "input": { + "Id": "ns-vh4nbmEXAMPLE", + "Namespace": { + "Description": "The updated namespace description." + } + }, + "output": { + "OperationId": "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE" + } + } + ] } }, "com.amazonaws.servicediscovery#UpdateHttpNamespaceRequest": { @@ -4981,21 +5009,21 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the\n namespace that you want to update.
", + "smithy.api#documentation": "The ID of the namespace that you\n want to update.
", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "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).
A unique string that identifies the\n request and that allows failed UpdateHttpNamespace 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).
Updated properties\n for the the HTTP namespace.
", + "smithy.api#documentation": "Updated properties for the the HTTP\n namespace.
", "smithy.api#required": {} } } @@ -5041,7 +5069,7 @@ } ], "traits": { - "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.
", + "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\n checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it\n to change the status for Route 53 health checks, which you define using HealthCheckConfig.
For more information, see HealthCheckCustomConfig.
", "smithy.api#examples": [ { "title": "UpdateInstanceCustomHealthStatus Example", @@ -5061,7 +5089,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\n want to change the status for.
", + "smithy.api#documentation": "The ID of the service that includes the configuration for the custom health check that you want to change\n the status for.
", "smithy.api#required": {} } }, @@ -5107,7 +5135,37 @@ } ], "traits": { - "smithy.api#documentation": "Updates a private DNS\n namespace.
" + "smithy.api#documentation": "Updates a private DNS\n namespace.
", + "smithy.api#examples": [ + { + "title": "To update a private DNS namespace", + "documentation": "The following example updates the description of a private DNS namespace.", + "input": { + "Id": "ns-bk3aEXAMPLE", + "UpdaterRequestId": "", + "Namespace": { + "Description": "The updated namespace description." + } + }, + "output": { + "OperationId": "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE" + } + }, + { + "title": "To update a public DNS namespace", + "documentation": "The following example updates the description of a public DNS namespace.", + "input": { + "Id": "ns-bk3aEXAMPLE", + "UpdaterRequestId": "", + "Namespace": { + "Description": "The updated namespace description." + } + }, + "output": { + "OperationId": "ft52xe2koxhoeormaceymagglsdjEXAMPLE" + } + } + ] } }, "com.amazonaws.servicediscovery#UpdatePrivateDnsNamespaceRequest": { @@ -5116,21 +5174,21 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the\n namespace that you want to update.
", + "smithy.api#documentation": "The ID of the namespace that you\n want to update.
", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "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).
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).
Updated properties\n for the private DNS namespace.
", + "smithy.api#documentation": "Updated properties for the private\n DNS namespace.
", "smithy.api#required": {} } } @@ -5185,21 +5243,21 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the\n namespace being updated.
", + "smithy.api#documentation": "The ID of the namespace being\n updated.
", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "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).
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).
Updated properties\n for the public DNS namespace.
", + "smithy.api#documentation": "Updated properties for the public\n DNS namespace.
", "smithy.api#required": {} } } @@ -5242,7 +5300,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\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.
", + "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\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 in all the\n records and health checks that were created by using the specified service.
", "smithy.api#examples": [ { "title": "UpdateService Example", diff --git a/codegen/sdk-codegen/aws-models/transfer.json b/codegen/sdk-codegen/aws-models/transfer.json index 11f0680a463..9a7d0b552f5 100644 --- a/codegen/sdk-codegen/aws-models/transfer.json +++ b/codegen/sdk-codegen/aws-models/transfer.json @@ -2607,7 +2607,7 @@ "Usage": { "target": "com.amazonaws.transfer#CertificateUsageType", "traits": { - "smithy.api#documentation": "Specifies how this certificate is used. It can be used in the following ways:
\n\n SIGNING: For signing AS2 messages
\n ENCRYPTION: For encrypting AS2 messages
\n TLS: For securing AS2 communications sent over HTTPS
Specifies whether this certificate is used for signing or encryption.
" } }, "Status": { @@ -3866,7 +3866,7 @@ "Usage": { "target": "com.amazonaws.transfer#CertificateUsageType", "traits": { - "smithy.api#documentation": "Specifies how this certificate is used. It can be used in the following ways:
\n\n SIGNING: For signing AS2 messages
\n ENCRYPTION: For encrypting AS2 messages
\n TLS: For securing AS2 communications sent over HTTPS
Specifies whether this certificate is used for signing or encryption.
", "smithy.api#required": {} } }, @@ -5279,7 +5279,7 @@ "Usage": { "target": "com.amazonaws.transfer#CertificateUsageType", "traits": { - "smithy.api#documentation": "Specifies how this certificate is used. It can be used in the following ways:
\n\n SIGNING: For signing AS2 messages
\n ENCRYPTION: For encrypting AS2 messages
\n TLS: For securing AS2 communications sent over HTTPS
Specifies whether this certificate is used for signing or encryption.
" } }, "Status": { @@ -5628,6 +5628,16 @@ "target": "com.amazonaws.transfer#ListedWorkflow" } }, + "com.amazonaws.transfer#ListingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[0-9a-zA-Z./-]+$" + } + }, "com.amazonaws.transfer#LogGroupName": { "type": "string", "traits": { @@ -5695,6 +5705,15 @@ } } }, + "com.amazonaws.transfer#MaxItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, "com.amazonaws.transfer#MaxResults": { "type": "integer", "traits": { @@ -5818,6 +5837,16 @@ } } }, + "com.amazonaws.transfer#OutputFileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 26, + "max": 537 + }, + "smithy.api#pattern": "^c-([0-9a-f]{17})-[0-9a-zA-Z./-]+.json$" + } + }, "com.amazonaws.transfer#OverwriteExisting": { "type": "enum", "members": { @@ -6720,6 +6749,92 @@ } } }, + "com.amazonaws.transfer#StartDirectoryListing": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#StartDirectoryListingRequest" + }, + "output": { + "target": "com.amazonaws.transfer#StartDirectoryListingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.transfer#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of the contents of a directory from a remote SFTP server. You specify the\n connector ID, the output path, and the remote directory path. You can also specify the\n optional MaxItems value to control the maximum number of items that are listed\n from the remote directory. This API returns a list of all files and directories in the remote\n directory (up to the maximum value), but does not return files or folders in sub-directories.\n That is, it only returns a list of files and directories one-level deep.
After you receive the listing file, you can provide the files that you want to transfer to\n the RetrieveFilePaths parameter of the StartFileTransfer API\n call.
The naming convention for the output file is\n \n connector-ID-listing-ID.json. The\n output file contains the following information:
\n filePath: the complete path of a remote file, relative to the directory\n of the listing request for your SFTP connector on the remote server.
\n modifiedTimestamp: the last time the file was modified, in UTC time\n format. This field is optional. If the remote file attributes don't contain a timestamp,\n it is omitted from the file listing.
\n size: the size of the file, in bytes. This field is optional. If the\n remote file attributes don't contain a file size, it is omitted from the file\n listing.
\n path: the complete path of a remote directory, relative to the directory\n of the listing request for your SFTP connector on the remote server.
\n truncated: a flag indicating whether the list output contains all of the\n items contained in the remote directory or not. If your Truncated output\n value is true, you can increase the value provided in the optional max-items\n input attribute to be able to list more items (up to the maximum allowed list size of\n 10,000 items).
The unique identifier for the connector.
", + "smithy.api#required": {} + } + }, + "RemoteDirectoryPath": { + "target": "com.amazonaws.transfer#FilePath", + "traits": { + "smithy.api#documentation": "Specifies the directory on the remote SFTP server for which you want to list its contents.
", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "com.amazonaws.transfer#MaxItems", + "traits": { + "smithy.api#documentation": "An optional parameter where you can specify the maximum number of file/directory names to\n retrieve. The default value is 1,000.
" + } + }, + "OutputDirectoryPath": { + "target": "com.amazonaws.transfer#FilePath", + "traits": { + "smithy.api#documentation": "Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transfer#StartDirectoryListingResponse": { + "type": "structure", + "members": { + "ListingId": { + "target": "com.amazonaws.transfer#ListingId", + "traits": { + "smithy.api#documentation": "Returns a unique identifier for the directory listing call.
", + "smithy.api#required": {} + } + }, + "OutputFileName": { + "target": "com.amazonaws.transfer#OutputFileName", + "traits": { + "smithy.api#documentation": "Returns the file name where the results are stored. This is a combination of the connector ID and the listing ID: <connector-id>-<listing-id>.json.
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
\nFor an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files\n you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both\n cases, you specify the ConnectorId. Depending on the direction of the transfer,\n you also specify the following items:
If you are transferring file from a partner's SFTP server to Amazon Web Services\n storage, you specify one or more RetreiveFilePaths to identify the files\n you want to transfer, and a LocalDirectoryPath to specify the destination\n folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services\n storage, you specify one or more SendFilePaths to identify the files you\n want to transfer, and a RemoteDirectoryPath to specify the destination\n folder.
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
\nFor an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files\n you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both\n cases, you specify the ConnectorId. Depending on the direction of the transfer,\n you also specify the following items:
If you are transferring file from a partner's SFTP server to Amazon Web Services\n storage, you specify one or more RetrieveFilePaths to identify the files\n you want to transfer, and a LocalDirectoryPath to specify the destination\n folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services\n storage, you specify one or more SendFilePaths to identify the files you\n want to transfer, and a RemoteDirectoryPath to specify the destination\n folder.