Specifies if there is a guardrail intervention in the response.
" } }, + "GuardrailAction": { + "base": null, + "refs": { + "GuardrailTrace$action": "The trace action details used with the Guardrail.
" + } + }, + "GuardrailAssessment": { + "base": "Assessment details of the content analyzed by Guardrails.
", + "refs": { + "GuardrailAssessmentList$member": null + } + }, + "GuardrailAssessmentList": { + "base": null, + "refs": { + "GuardrailTrace$inputAssessments": "The details of the input assessments used in the Guardrail Trace.
", + "GuardrailTrace$outputAssessments": "The details of the output assessments used in the Guardrail Trace.
" + } + }, "GuardrailConfiguration": { "base": "The configuration details for the guardrail.
", "refs": { @@ -364,6 +383,164 @@ "GuardrailConfiguration$guardrailVersion": "The version of the guardrail.
" } }, + "GuardrailContentFilter": { + "base": "Details of the content filter used in the Guardrail.
", + "refs": { + "GuardrailContentFilterList$member": null + } + }, + "GuardrailContentFilterConfidence": { + "base": null, + "refs": { + "GuardrailContentFilter$confidence": "The confidence level regarding the content detected in the filter by the Guardrail.
" + } + }, + "GuardrailContentFilterList": { + "base": null, + "refs": { + "GuardrailContentPolicyAssessment$filters": "The filter details of the policy assessment used in the Guardrails filter.
" + } + }, + "GuardrailContentFilterType": { + "base": null, + "refs": { + "GuardrailContentFilter$type": "The type of content detected in the filter by the Guardrail.
" + } + }, + "GuardrailContentPolicyAction": { + "base": null, + "refs": { + "GuardrailContentFilter$action": "The action placed on the content by the Guardrail filter.
" + } + }, + "GuardrailContentPolicyAssessment": { + "base": "The details of the policy assessment in the Guardrails filter.
", + "refs": { + "GuardrailAssessment$contentPolicy": "Content policy details of the Guardrail.
" + } + }, + "GuardrailCustomWord": { + "base": "The custom word details for the filter in the Guardrail.
", + "refs": { + "GuardrailCustomWordList$member": null + } + }, + "GuardrailCustomWordList": { + "base": null, + "refs": { + "GuardrailWordPolicyAssessment$customWords": "The custom word details for words defined in the Guardrail filter.
" + } + }, + "GuardrailManagedWord": { + "base": "The managed word details for the filter in the Guardrail.
", + "refs": { + "GuardrailManagedWordList$member": null + } + }, + "GuardrailManagedWordList": { + "base": null, + "refs": { + "GuardrailWordPolicyAssessment$managedWordLists": "The managed word lists for words defined in the Guardrail filter.
" + } + }, + "GuardrailManagedWordType": { + "base": null, + "refs": { + "GuardrailManagedWord$type": "The type details for the managed word filter in the Guardrail.
" + } + }, + "GuardrailPiiEntityFilter": { + "base": "The Guardrail filter to identify and remove personally identifiable information (PII).
", + "refs": { + "GuardrailPiiEntityFilterList$member": null + } + }, + "GuardrailPiiEntityFilterList": { + "base": null, + "refs": { + "GuardrailSensitiveInformationPolicyAssessment$piiEntities": "The details of the PII entities used in the sensitive policy assessment for the Guardrail.
" + } + }, + "GuardrailPiiEntityType": { + "base": null, + "refs": { + "GuardrailPiiEntityFilter$type": "The type of PII the Guardrail filter has identified and removed.
" + } + }, + "GuardrailRegexFilter": { + "base": "The details for the regex filter used in the Guardrail.
", + "refs": { + "GuardrailRegexFilterList$member": null + } + }, + "GuardrailRegexFilterList": { + "base": null, + "refs": { + "GuardrailSensitiveInformationPolicyAssessment$regexes": "The details of the regexes used in the sensitive policy assessment for the Guardrail.
" + } + }, + "GuardrailSensitiveInformationPolicyAction": { + "base": null, + "refs": { + "GuardrailPiiEntityFilter$action": "The action of the Guardrail filter to identify and remove PII.
", + "GuardrailRegexFilter$action": "The action details for the regex filter used in the Guardrail.
" + } + }, + "GuardrailSensitiveInformationPolicyAssessment": { + "base": "The details of the sensitive policy assessment used in the Guardrail.
", + "refs": { + "GuardrailAssessment$sensitiveInformationPolicy": "Sensitive Information policy details of Guardrail.
" + } + }, + "GuardrailTopic": { + "base": "The details for a specific topic defined in the Guardrail.
", + "refs": { + "GuardrailTopicList$member": null + } + }, + "GuardrailTopicList": { + "base": null, + "refs": { + "GuardrailTopicPolicyAssessment$topics": "The topic details of the policy assessment used in the Guardrail.
" + } + }, + "GuardrailTopicPolicyAction": { + "base": null, + "refs": { + "GuardrailTopic$action": "The action details on a specific topic in the Guardrail.
" + } + }, + "GuardrailTopicPolicyAssessment": { + "base": "The details of the policy assessment used in the Guardrail.
", + "refs": { + "GuardrailAssessment$topicPolicy": "Topic policy details of the Guardrail.
" + } + }, + "GuardrailTopicType": { + "base": null, + "refs": { + "GuardrailTopic$type": "The type details on a specific topic in the Guardrail.
" + } + }, + "GuardrailTrace": { + "base": "The trace details used in the Guardrail.
", + "refs": { + "Trace$guardrailTrace": "The trace details for a trace defined in the Guardrail filter.
" + } + }, + "GuardrailWordPolicyAction": { + "base": null, + "refs": { + "GuardrailCustomWord$action": "The action details for the custom word filter in the Guardrail.
", + "GuardrailManagedWord$action": "The action details for the managed word filter in the Guardrail.
" + } + }, + "GuardrailWordPolicyAssessment": { + "base": "The assessment details for words defined in the Guardrail filter.
", + "refs": { + "GuardrailAssessment$wordPolicy": "Word policy details of the Guardrail.
" + } + }, "Identifier": { "base": null, "refs": { @@ -992,6 +1169,13 @@ "FunctionParameter$value": "The value of the parameter.
", "FunctionResult$actionGroup": "The action group that the function belongs to.
", "FunctionResult$function": "The name of the function that was called.
", + "GuardrailCustomWord$match": "The match details for the custom word filter in the Guardrail.
", + "GuardrailManagedWord$match": "The match details for the managed word filter in the Guardrail.
", + "GuardrailPiiEntityFilter$match": "The match to settings in the Guardrail filter to identify and remove PII.
", + "GuardrailRegexFilter$match": "The match details for the regex filter used in the Guardrail.
", + "GuardrailRegexFilter$name": "The name details for the regex filter used in the Guardrail.
", + "GuardrailRegexFilter$regex": "The regex details for the regex filter used in the Guardrail.
", + "GuardrailTopic$name": "The name details on a specific topic in the Guardrail.
", "Parameter$name": "The name of the parameter.
", "Parameter$type": "The type of the parameter.
", "Parameter$value": "The value of the parameter.
", @@ -1064,6 +1248,7 @@ "base": null, "refs": { "FailureTrace$traceId": "The unique identifier of the trace.
", + "GuardrailTrace$traceId": "The details of the trace Id used in the Guardrail Trace.
", "InvocationInput$traceId": "The unique identifier of the trace.
", "ModelInvocationInput$traceId": "The unique identifier of the trace.
", "Observation$traceId": "The unique identifier of the trace.
", diff --git a/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json.php b/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json.php index 34dbe614b9..a1a17b4677 100644 --- a/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json.php +++ b/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Contains APIs related to model invocation and querying of knowledge bases.
', 'operations' => [ 'InvokeAgent' => 'The CLI doesn\'t support InvokeAgent.
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
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, if you configured an action group to return control, results from invocation of the action group.
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.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Queries a knowledge base and retrieves information from it.
', 'RetrieveAndGenerate' => 'Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'The request is denied because of missing access permissions. Check your permissions and retry your request.
', 'refs' => [ 'ResponseStream$accessDeniedException' => 'The request is denied because of missing access permissions. Check your permissions and retry your request.
', ], ], 'ActionGroupInvocationInput' => [ 'base' => '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.
', 'refs' => [ 'InvocationInput$actionGroupInvocationInput' => 'Contains information about the action group to be invoked.
', ], ], 'ActionGroupInvocationOutput' => [ 'base' => 'Contains the JSON-formatted string returned by the API invoked by the action group.
', 'refs' => [ 'Observation$actionGroupInvocationOutput' => 'Contains the JSON-formatted string returned by the API invoked by the action group.
', ], ], 'ActionGroupName' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$actionGroupName' => 'The name of the action group.
', ], ], 'ActionGroupOutputString' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationOutput$text' => 'The JSON-formatted string returned by the API invoked by the action group.
', ], ], 'AdditionalModelRequestFields' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesGenerationConfiguration$additionalModelRequestFields' => 'Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.
', 'GenerationConfiguration$additionalModelRequestFields' => 'Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
', ], ], 'AdditionalModelRequestFieldsKey' => [ 'base' => NULL, 'refs' => [ 'AdditionalModelRequestFields$key' => NULL, ], ], 'AdditionalModelRequestFieldsValue' => [ 'base' => NULL, 'refs' => [ 'AdditionalModelRequestFields$value' => NULL, ], ], 'AgentAliasId' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$agentAliasId' => 'The alias of the agent to use.
', 'TracePart$agentAliasId' => 'The unique identifier of the alias of the agent.
', ], ], 'AgentId' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$agentId' => 'The unique identifier of the agent to use.
', 'TracePart$agentId' => 'The unique identifier of the agent.
', ], ], 'AgentVersion' => [ 'base' => NULL, 'refs' => [ 'TracePart$agentVersion' => 'The version of the agent.
', ], ], 'ApiContentMap' => [ 'base' => NULL, 'refs' => [ 'ApiRequestBody$content' => 'The content of the request body. The key of the object in this field is a media type defining the format of the request body.
', ], ], 'ApiInvocationInput' => [ 'base' => 'Contains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Contains information about the API operation that the agent predicts should be called.
', ], ], 'ApiParameter' => [ 'base' => 'Information about a parameter to provide to the API request.
This data type is used in the following API operations:
', 'refs' => [ 'ApiParameters$member' => NULL, ], ], 'ApiParameters' => [ 'base' => NULL, 'refs' => [ 'ApiInvocationInput$parameters' => 'The parameters to provide for the API request, as the agent elicited from the user.
', ], ], 'ApiPath' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$apiPath' => 'The path to the API to call, based off the action group.
', 'ApiInvocationInput$apiPath' => 'The path to the API operation.
', 'ApiResult$apiPath' => 'The path to the API operation.
', ], ], 'ApiRequestBody' => [ 'base' => 'The request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
', 'refs' => [ 'ApiInvocationInput$requestBody' => 'The request body to provide for the API request, as the agent elicited from the user.
', ], ], 'ApiResult' => [ 'base' => 'Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
The result from the API response from the action group invocation.
', ], ], 'Attribution' => [ 'base' => 'Contains citations for a part of an agent response.
', 'refs' => [ 'PayloadPart$attribution' => 'Contains citations for a part of an agent response.
', ], ], 'BadGatewayException' => [ 'base' => 'There was an issue with a dependency due to a server issue. Retry your request.
', 'refs' => [ 'ResponseStream$badGatewayException' => 'There was an issue with a dependency due to a server issue. Retry your request.
', ], ], 'BedrockModelArn' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$modelArn' => 'The modelArn used with the external source wrapper object in the retrieveAndGenerate function.
', 'KnowledgeBaseRetrieveAndGenerateConfiguration$modelArn' => 'The ARN of the foundation model used to generate a response.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$enableTrace' => 'Specifies whether to turn on the trace or not to track the agent\'s reasoning process. For more information, see Trace enablement.
', 'InvokeAgentRequest$endSession' => 'Specifies whether to end the session with the agent or not.
', 'PreProcessingParsedResponse$isValid' => 'Whether the user input is valid or not. If false, the agent doesn\'t proceed to orchestration.
The byte value of the file to upload, encoded as a Base-64 string.
', ], ], 'ByteContentDoc' => [ 'base' => 'This property contains the document to chat with, along with its attributes.
', 'refs' => [ 'ExternalSource$byteContent' => 'The identifier, contentType, and data of the external source wrapper object.
', ], ], 'Citation' => [ 'base' => 'An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
InvokeAgent response – in the citations field
RetrieveAndGenerate response – in the citations field
A list of citations and related information for a part of an agent response.
', 'RetrieveAndGenerateResponse$citations' => 'A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
', ], ], 'ConflictException' => [ 'base' => 'There was a conflict performing an operation. Resolve the conflict and retry your request.
', 'refs' => [ 'ResponseStream$conflictException' => 'There was a conflict performing an operation. Resolve the conflict and retry your request.
', ], ], 'ContentBody' => [ 'base' => 'Contains the body of the API response.
This data type is used in the following API operations:
In the returnControlInvocationResults field of the InvokeAgent request
The content in the request body.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$contentType' => 'The MIME type of the document contained in the wrapper object.
', ], ], 'CreationMode' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$parserMode' => 'Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.
Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.
There was an issue with a dependency. Check the resource configurations and retry the request.
', 'refs' => [ 'ResponseStream$dependencyFailedException' => 'There was an issue with a dependency. Check the resource configurations and retry the request.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrievalResult$score' => 'The level of relevance of the result to the query.
', ], ], 'ExternalSource' => [ 'base' => 'The unique external source of the content contained in the wrapper object.
', 'refs' => [ 'ExternalSources$member' => NULL, ], ], 'ExternalSourceType' => [ 'base' => NULL, 'refs' => [ 'ExternalSource$sourceType' => 'The source type of the external source wrapper object.
', ], ], 'ExternalSources' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$sources' => 'The document used with the external source wrapper object in the retrieveAndGenerate function.
', ], ], 'ExternalSourcesGenerationConfiguration' => [ 'base' => 'Contains the generation configuration of the external source wrapper object.
', 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$generationConfiguration' => 'The prompt used with the external source wrapper object with the retrieveAndGenerate function.
', ], ], 'ExternalSourcesRetrieveAndGenerateConfiguration' => [ 'base' => 'The configurations of the external source wrapper object in the retrieveAndGenerate function.
', 'refs' => [ 'RetrieveAndGenerateConfiguration$externalSourcesConfiguration' => 'The configuration used with the external source wrapper object in the retrieveAndGenerate function.
', ], ], 'FailureReasonString' => [ 'base' => NULL, 'refs' => [ 'FailureTrace$failureReason' => 'The reason the interaction failed.
', ], ], 'FailureTrace' => [ 'base' => 'Contains information about the failure of the interaction.
', 'refs' => [ 'Trace$failureTrace' => 'Contains information about the failure of the interaction.
', ], ], 'FilterAttribute' => [ 'base' => 'Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.
This data type is used in the following API operations:
', 'refs' => [ 'RetrievalFilter$equals' => 'Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
"equals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
"greaterThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
"greaterThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
"in": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
"lessThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
"lessThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example ["dog", "cat"]).
"listContains": { "key": "animals", "value": "cat" }
Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn\'t match the value in this object are returned.
The following example would return data sources that don\'t contain an animal attribute whose value is cat.
"notEquals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn\'t in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
"notIn": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
"startsWith": { "key": "animal", "value": "ca" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
"stringContains": { "key": "animal", "value": "at" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example ["dog", "cat"]).
"stringContains": { "key": "animals", "value": "at" }
The name that the metadata attribute must match.
', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterAttribute$value' => 'The value to whcih to compare the value of the metadata attribute.
', ], ], 'FinalResponse' => [ 'base' => 'Contains details about the response to the user.
', 'refs' => [ 'Observation$finalResponse' => 'Contains details about the response to the user.
', ], ], 'FinalResponseString' => [ 'base' => NULL, 'refs' => [ 'FinalResponse$text' => 'The text in the response to the user.
', ], ], 'Function' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$function' => 'The function in the action group to call.
', ], ], 'FunctionInvocationInput' => [ 'base' => 'Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Contains information about the function that the agent predicts should be called.
', ], ], 'FunctionParameter' => [ 'base' => 'Contains information about a parameter of the function.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
A list of parameters of the function.
', ], ], 'FunctionResult' => [ 'base' => 'Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
The result from the function from the action group invocation.
', ], ], 'GeneratedResponsePart' => [ 'base' => 'Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
InvokeAgent response – in the generatedResponsePart field
RetrieveAndGenerate response – in the generatedResponsePart field
Contains the generated response and metadata
', ], ], 'GenerationConfiguration' => [ 'base' => 'Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
', 'refs' => [ 'KnowledgeBaseRetrieveAndGenerateConfiguration$generationConfiguration' => 'Contains configurations for response generation based on the knowwledge base query results.
', ], ], 'GuadrailAction' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateResponse$guardrailAction' => 'Specifies if there is a guardrail intervention in the response.
', ], ], 'GuardrailConfiguration' => [ 'base' => 'The configuration details for the guardrail.
', 'refs' => [ 'ExternalSourcesGenerationConfiguration$guardrailConfiguration' => 'The configuration details for the guardrail.
', 'GenerationConfiguration$guardrailConfiguration' => 'The configuration details for the guardrail.
', ], ], 'GuardrailConfigurationGuardrailIdString' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailId' => 'The unique identifier for the guardrail.
', ], ], 'GuardrailConfigurationGuardrailVersionString' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailVersion' => 'The version of the guardrail.
', ], ], 'Identifier' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$identifier' => 'The file name of the document contained in the wrapper object.
', ], ], 'InferenceConfig' => [ 'base' => 'The configuration for inference settings when generating responses using RetrieveAndGenerate.
', 'refs' => [ 'ExternalSourcesGenerationConfiguration$inferenceConfig' => 'Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
', 'GenerationConfiguration$inferenceConfig' => 'Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
', ], ], 'InferenceConfiguration' => [ 'base' => 'Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
', 'refs' => [ 'ModelInvocationInput$inferenceConfiguration' => 'Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
', ], ], 'InputText' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$inputText' => 'The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
http status code from API execution response (for example: 200, 400, 500).
', ], ], 'InternalServerException' => [ 'base' => 'An internal server error occurred. Retry your request.
', 'refs' => [ 'ResponseStream$internalServerException' => 'An internal server error occurred. Retry your request.
', ], ], 'InvocationInput' => [ 'base' => 'Contains information pertaining to the action group or knowledge base that is being invoked.
', 'refs' => [ 'OrchestrationTrace$invocationInput' => 'Contains information pertaining to the action group or knowledge base that is being invoked.
', ], ], 'InvocationInputMember' => [ 'base' => 'Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
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.
', ], ], 'InvocationResultMember' => [ 'base' => 'A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.
This data type is used in the following API operations:
', 'refs' => [ 'ReturnControlInvocationResults$member' => NULL, ], ], 'InvocationType' => [ 'base' => NULL, 'refs' => [ 'InvocationInput$invocationType' => 'Specifies whether the agent is invoking an action group or a knowledge base.
', ], ], 'InvokeAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateSessionConfiguration$kmsKeyArn' => 'The ARN of the KMS key encrypting the session.
', ], ], 'KnowledgeBaseId' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrieveAndGenerateConfiguration$knowledgeBaseId' => 'The unique identifier of the knowledge base that is queried and the foundation model used for generation.
', 'RetrieveRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to query.
', ], ], 'KnowledgeBaseLookupInput' => [ 'base' => 'Contains details about the knowledge base to look up and the query to be made.
', 'refs' => [ 'InvocationInput$knowledgeBaseLookupInput' => 'Contains details about the knowledge base to look up and the query to be made.
', ], ], 'KnowledgeBaseLookupInputString' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseLookupInput$text' => 'The query made to the knowledge base.
', ], ], 'KnowledgeBaseLookupOutput' => [ 'base' => 'Contains details about the results from looking up the knowledge base.
', 'refs' => [ 'Observation$knowledgeBaseLookupOutput' => 'Contains details about the results from looking up the knowledge base.
', ], ], 'KnowledgeBaseQuery' => [ 'base' => 'Contains the query made to the knowledge base.
This data type is used in the following API operations:
Retrieve request – in the retrievalQuery field
Contains the query to send the knowledge base.
', ], ], 'KnowledgeBaseQueryTextString' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseQuery$text' => 'The text of the query made to the knowledge base.
', ], ], 'KnowledgeBaseRetrievalConfiguration' => [ 'base' => 'Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the retrievalConfiguration field
RetrieveAndGenerate request – in the retrievalConfiguration field
Contains configurations for how to retrieve and return the knowledge base query.
', 'RetrieveRequest$retrievalConfiguration' => 'Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
', ], ], 'KnowledgeBaseRetrievalResult' => [ 'base' => 'Details about a result from querying the knowledge base.
This data type is used in the following API operations:
Retrieve response – in the retrievalResults field
A list of results from querying the knowledge base.
', ], ], 'KnowledgeBaseRetrieveAndGenerateConfiguration' => [ 'base' => 'Contains details about the resource being queried.
This data type is used in the following API operations:
Retrieve request – in the knowledgeBaseConfiguration field
RetrieveAndGenerate request – in the knowledgeBaseConfiguration field
Contains details about the resource being queried.
', ], ], 'KnowledgeBaseVectorSearchConfiguration' => [ 'base' => 'Configurations for how to perform the search query and return results. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the vectorSearchConfiguration field
RetrieveAndGenerate request – in the vectorSearchConfiguration field
Contains details about how the results from the vector search should be returned. For more information, see Query configurations.
', ], ], 'KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$numberOfResults' => 'The number of source chunks to retrieve.
', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$overrideLambda' => 'The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
', ], ], 'MaxTokens' => [ 'base' => NULL, 'refs' => [ 'TextInferenceConfig$maxTokens' => 'The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
', ], ], 'MaximumLength' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$maximumLength' => 'The maximum number of tokens allowed in the generated response.
', ], ], 'MimeType' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentResponse$contentType' => 'The MIME type of the input data in the request. The default value is application/json.
The input for the pre-processing step.
The type matches the agent step.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the orchestration step.
The type is ORCHESTRATION.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the post-processing step.
The type is POST_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the pre-processing step.
The type is PRE_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
', 'ConflictException$message' => NULL, 'DependencyFailedException$message' => NULL, 'DependencyFailedException$resourceName' => 'The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
', 'InternalServerException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'Observation' => [ 'base' => 'Contains the result or output of an action group or knowledge base, or the response to the user.
', 'refs' => [ 'OrchestrationTrace$observation' => 'Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
', ], ], 'OrchestrationTrace' => [ 'base' => 'Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
', 'refs' => [ 'Trace$orchestrationTrace' => 'Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
', ], ], 'OutputString' => [ 'base' => NULL, 'refs' => [ 'PostProcessingParsedResponse$text' => 'The text returned by the parser.
', ], ], 'Parameter' => [ 'base' => 'A parameter for the API request or function.
', 'refs' => [ 'ParameterList$member' => NULL, 'Parameters$member' => NULL, ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'PropertyParameters$properties' => 'A list of parameters in the request body.
', ], ], 'Parameters' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$parameters' => 'The parameters in the Lambda input event.
', 'ContentMap$value' => NULL, ], ], 'PartBody' => [ 'base' => NULL, 'refs' => [ 'PayloadPart$bytes' => 'A part of the agent response in bytes.
', ], ], 'PayloadPart' => [ 'base' => 'Contains a part of an agent response and citations for it.
', 'refs' => [ 'ResponseStream$chunk' => 'Contains a part of an agent response and citations for it.
', ], ], 'PostProcessingModelInvocationOutput' => [ 'base' => 'The foundation model output from the post-processing step.
', 'refs' => [ 'PostProcessingTrace$modelInvocationOutput' => 'The foundation model output from the post-processing step.
', ], ], 'PostProcessingParsedResponse' => [ 'base' => 'Details about the response from the Lambda parsing of the output from the post-processing step.
', 'refs' => [ 'PostProcessingModelInvocationOutput$parsedResponse' => 'Details about the response from the Lambda parsing of the output of the post-processing step.
', ], ], 'PostProcessingTrace' => [ 'base' => 'Details about the post-processing step, in which the agent shapes the response.
', 'refs' => [ 'Trace$postProcessingTrace' => 'Details about the post-processing step, in which the agent shapes the response..
', ], ], 'PreProcessingModelInvocationOutput' => [ 'base' => 'The foundation model output from the pre-processing step.
', 'refs' => [ 'PreProcessingTrace$modelInvocationOutput' => 'The foundation model output from the pre-processing step.
', ], ], 'PreProcessingParsedResponse' => [ 'base' => 'Details about the response from the Lambda parsing of the output from the pre-processing step.
', 'refs' => [ 'PreProcessingModelInvocationOutput$parsedResponse' => 'Details about the response from the Lambda parsing of the output of the pre-processing step.
', ], ], 'PreProcessingTrace' => [ 'base' => 'Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
', 'refs' => [ 'Trace$preProcessingTrace' => 'Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
', ], ], 'PromptSessionAttributesMap' => [ 'base' => NULL, 'refs' => [ 'SessionState$promptSessionAttributes' => 'Contains 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.
', ], ], 'PromptTemplate' => [ 'base' => 'Contains the template for the prompt that\'s sent to the model for response generation. For more information, see Knowledge base prompt templates.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the filter field
Contain the textPromptTemplate string for the external source wrapper object.
', 'GenerationConfiguration$promptTemplate' => 'Contains the template for the prompt that\'s sent to the model for response generation.
', ], ], 'PromptText' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$text' => 'The text that prompted the agent at this step.
', ], ], 'PromptType' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$type' => 'The step in the agent sequence.
', ], ], 'PropertyParameters' => [ 'base' => 'Contains the parameters in the request body.
', 'refs' => [ 'ApiContentMap$value' => NULL, ], ], 'RAGStopSequences' => [ 'base' => NULL, 'refs' => [ 'TextInferenceConfig$stopSequences' => 'A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
', ], ], 'RAGStopSequencesMemberString' => [ 'base' => NULL, 'refs' => [ 'RAGStopSequences$member' => NULL, ], ], 'Rationale' => [ 'base' => 'Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
', 'refs' => [ 'OrchestrationTrace$rationale' => 'Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
', ], ], 'RationaleString' => [ 'base' => NULL, 'refs' => [ 'PreProcessingParsedResponse$rationale' => 'The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.
', 'Rationale$text' => 'The reasoning or thought process of the agent, based on the input.
', ], ], 'RepromptResponse' => [ 'base' => 'Contains details about the agent\'s response to reprompt the input.
', 'refs' => [ 'Observation$repromptResponse' => 'Contains details about the response to reprompt the input.
', ], ], 'RequestBody' => [ 'base' => 'The parameters in the API request body.
', 'refs' => [ 'ActionGroupInvocationInput$requestBody' => 'The parameters in the request body for the Lambda input event.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
', 'refs' => [ 'ResponseStream$resourceNotFoundException' => 'The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
', ], ], 'ResponseBody' => [ 'base' => NULL, 'refs' => [ 'ApiResult$responseBody' => 'The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
The response from the function call using the parameters. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
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
', 'FunctionResult$responseState' => '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
', ], ], 'ResponseStream' => [ 'base' => 'The response from invoking the agent and associated citations and trace information.
', 'refs' => [ 'InvokeAgentResponse$completion' => 'The agent\'s response to the user prompt.
', ], ], 'RetrievalFilter' => [ 'base' => 'Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.
This data type is used in the following API operations:
Retrieve request – in the filter field
RetrieveAndGenerate request – in the filter field
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
', 'RetrievalFilterList$member' => NULL, ], ], 'RetrievalFilterList' => [ 'base' => NULL, 'refs' => [ 'RetrievalFilter$andAll' => 'Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
', 'RetrievalFilter$orAll' => 'Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
', ], ], 'RetrievalResultContent' => [ 'base' => 'Contains the cited text from the data source.
This data type is used in the following API operations:
Retrieve response – in the content field
RetrieveAndGenerate response – in the content field
InvokeAgent response – in the content field
Contains a chunk of text from a data source in the knowledge base.
', 'RetrievedReference$content' => 'Contains the cited text from the data source.
', ], ], 'RetrievalResultLocation' => [ 'base' => 'Contains information about the location of the data source.
This data type is used in the following API operations:
Retrieve response – in the location field
RetrieveAndGenerate response – in the location field
InvokeAgent response – in the locatino field
Contains information about the location of the data source.
', 'RetrievedReference$location' => 'Contains information about the location of the data source.
', ], ], 'RetrievalResultLocationType' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultLocation$type' => 'The type of the location of the data source.
', ], ], 'RetrievalResultMetadata' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrievalResult$metadata' => 'Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
', 'RetrievedReference$metadata' => 'Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
', ], ], 'RetrievalResultMetadataKey' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultMetadata$key' => NULL, ], ], 'RetrievalResultMetadataValue' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultMetadata$value' => NULL, ], ], 'RetrievalResultS3Location' => [ 'base' => 'Contains the S3 location of the data source.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
InvokeAgent response – in the s3Location field
Contains the S3 location of the data source.
', ], ], 'RetrieveAndGenerateConfiguration' => [ 'base' => 'Contains details about the resource being queried.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the retrieveAndGenerateConfiguration field
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
', ], ], 'RetrieveAndGenerateInput' => [ 'base' => 'Contains the query made to the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the input field
Contains the query to be made to the knowledge base.
', ], ], 'RetrieveAndGenerateInputTextString' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateInput$text' => 'The query made to the knowledge base.
', ], ], 'RetrieveAndGenerateOutput' => [ 'base' => 'Contains the response generated from querying the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the output field
Contains the response generated from querying the knowledge base.
', ], ], 'RetrieveAndGenerateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveAndGenerateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveAndGenerateSessionConfiguration' => [ 'base' => 'Contains configuration about the session with the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the sessionConfiguration field
Contains details about the session with the knowledge base.
', ], ], 'RetrieveAndGenerateType' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateConfiguration$type' => 'The type of resource that is queried by the request.
', ], ], 'RetrieveRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetrievedReference' => [ 'base' => 'Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the retrievedReferences field
InvokeAgent response – in the retrievedReferences field
Contains metadata about the sources cited for the generated response.
', 'KnowledgeBaseLookupOutput$retrievedReferences' => 'Contains metadata about the sources cited for the generated response.
', ], ], 'ReturnControlInvocationResults' => [ 'base' => NULL, 'refs' => [ 'SessionState$returnControlInvocationResults' => 'Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
If you include this field, the inputText field will be ignored.
Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
', 'refs' => [ 'ResponseStream$returnControl' => '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.
', ], ], 'S3ObjectDoc' => [ 'base' => 'The unique wrapper object of the document from the S3 location.
', 'refs' => [ 'ExternalSource$s3Location' => 'The S3 location of the external source wrapper object.
', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'S3ObjectDoc$uri' => 'The file location of the S3 wrapper object.
', ], ], 'SearchType' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$overrideSearchType' => 'By default, Amazon Bedrock decides a search strategy for you. If you\'re using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
The number of requests exceeds the service quota. Resubmit your request later.
', 'refs' => [ 'ResponseStream$serviceQuotaExceededException' => 'The number of requests exceeds the service quota. Resubmit your request later.
', ], ], 'SessionAttributesMap' => [ 'base' => NULL, 'refs' => [ 'SessionState$sessionAttributes' => 'Contains attributes that persist across a session and the values of those attributes.
', ], ], 'SessionId' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$sessionId' => 'The unique identifier of the session. Use the same value across requests to continue the same conversation.
', 'InvokeAgentResponse$sessionId' => 'The unique identifier of the session with the agent.
', 'RetrieveAndGenerateRequest$sessionId' => 'The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.
', 'RetrieveAndGenerateResponse$sessionId' => 'The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.
', 'TracePart$sessionId' => 'The unique identifier of the session with the agent.
', ], ], 'SessionState' => [ 'base' => 'Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent\'s behavior. For more information, see Control session context.
', 'refs' => [ 'InvokeAgentRequest$sessionState' => 'Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Specifies what output is prompting the agent to reprompt the input.
', ], ], 'Span' => [ 'base' => 'Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the span field
InvokeAgent response – in the span field
Contains information about where the text with a citation begins and ends in the generated output.
', ], ], 'SpanEndInteger' => [ 'base' => NULL, 'refs' => [ 'Span$end' => 'Where the text with a citation ends in the generated output.
', ], ], 'SpanStartInteger' => [ 'base' => NULL, 'refs' => [ 'Span$start' => 'Where the text with a citation starts in the generated output.
', ], ], 'StopSequences' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$stopSequences' => 'A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ApiContentMap$key' => NULL, 'ApiInvocationInput$actionGroup' => 'The action group that the API operation belongs to.
', 'ApiInvocationInput$httpMethod' => 'The HTTP method of the API operation.
', 'ApiParameter$name' => 'The name of the parameter.
', 'ApiParameter$type' => 'The data type for the parameter.
', 'ApiParameter$value' => 'The value of the parameter.
', 'ApiResult$actionGroup' => 'The action group that the API operation belongs to.
', 'ApiResult$httpMethod' => 'The HTTP method for the API operation.
', 'ContentBody$body' => 'The body of the API response.
', 'ContentMap$key' => NULL, 'FunctionInvocationInput$actionGroup' => 'The action group that the function belongs to.
', 'FunctionInvocationInput$function' => 'The name of the function.
', 'FunctionParameter$name' => 'The name of the parameter.
', 'FunctionParameter$type' => 'The data type of the parameter.
', 'FunctionParameter$value' => 'The value of the parameter.
', 'FunctionResult$actionGroup' => 'The action group that the function belongs to.
', 'FunctionResult$function' => 'The name of the function that was called.
', 'Parameter$name' => 'The name of the parameter.
', 'Parameter$type' => 'The type of the parameter.
', 'Parameter$value' => 'The value of the parameter.
', 'PromptSessionAttributesMap$key' => NULL, 'PromptSessionAttributesMap$value' => NULL, 'RepromptResponse$text' => 'The text reprompting the input.
', 'ResponseBody$key' => NULL, 'RetrievalResultContent$text' => 'The cited text from the data source.
', 'RetrievalResultS3Location$uri' => 'The S3 URI of the data source.
', 'RetrieveAndGenerateOutput$text' => 'The response generated from querying the knowledge base.
', 'ReturnControlPayload$invocationId' => 'The identifier of the action group invocation.
', 'SessionAttributesMap$key' => NULL, 'SessionAttributesMap$value' => NULL, 'SessionState$invocationId' => 'The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
The part of the generated text that contains a citation.
', ], ], 'Temperature' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$temperature' => 'The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
', 'TextInferenceConfig$temperature' => 'Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
', ], ], 'TextInferenceConfig' => [ 'base' => 'Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
The valid range of maxTokens depends on the accepted values for your chosen model\'s inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.
Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.
', ], ], 'TextPromptTemplate' => [ 'base' => NULL, 'refs' => [ 'PromptTemplate$textPromptTemplate' => 'The template for the prompt that\'s sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see the following resources:
', ], ], 'TextResponsePart' => [ 'base' => 'Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the textResponsePart field
InvokeAgent response – in the textResponsePart field
Contains metadata about a textual part of the generated response that is accompanied by a citation.
', ], ], 'ThrottlingException' => [ 'base' => 'The number of requests exceeds the limit. Resubmit your request later.
', 'refs' => [ 'ResponseStream$throttlingException' => 'The number of requests exceeds the limit. Resubmit your request later.
', ], ], 'TopK' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topK' => 'While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
', ], ], 'Trace' => [ 'base' => 'Contains one part of the agent\'s reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
', 'refs' => [ 'TracePart$trace' => 'Contains one part of the agent\'s reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
', ], ], 'TraceId' => [ 'base' => NULL, 'refs' => [ 'FailureTrace$traceId' => 'The unique identifier of the trace.
', 'InvocationInput$traceId' => 'The unique identifier of the trace.
', 'ModelInvocationInput$traceId' => 'The unique identifier of the trace.
', 'Observation$traceId' => 'The unique identifier of the trace.
', 'PostProcessingModelInvocationOutput$traceId' => 'The unique identifier of the trace.
', 'PreProcessingModelInvocationOutput$traceId' => 'The unique identifier of the trace.
', 'Rationale$traceId' => 'The unique identifier of the trace step.
', ], ], 'TraceKnowledgeBaseId' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseLookupInput$knowledgeBaseId' => 'The unique identifier of the knowledge base to look up.
', ], ], 'TracePart' => [ 'base' => '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 enablement.
', 'refs' => [ 'ResponseStream$trace' => '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.
', ], ], 'Type' => [ 'base' => NULL, 'refs' => [ 'Observation$type' => 'Specifies what kind of information the agent returns in the observation. The following values are possible.
ACTION_GROUP – The agent returns the result of an action group.
KNOWLEDGE_BASE – The agent returns information from a knowledge base.
FINISH – The agent returns a final response to the user with no follow-up.
ASK_USER – The agent asks the user a question.
REPROMPT – The agent prompts the user again for the same information.
Input validation failed. Check your request parameters and retry the request.
', 'refs' => [ 'ResponseStream$validationException' => 'Input validation failed. Check your request parameters and retry the request.
', ], ], 'Verb' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$verb' => 'The API method being used, based off the action group.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Contains APIs related to model invocation and querying of knowledge bases.
', 'operations' => [ 'InvokeAgent' => 'The CLI doesn\'t support InvokeAgent.
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
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, if you configured an action group to return control, results from invocation of the action group.
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.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Queries a knowledge base and retrieves information from it.
', 'RetrieveAndGenerate' => 'Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'The request is denied because of missing access permissions. Check your permissions and retry your request.
', 'refs' => [ 'ResponseStream$accessDeniedException' => 'The request is denied because of missing access permissions. Check your permissions and retry your request.
', ], ], 'ActionGroupInvocationInput' => [ 'base' => '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.
', 'refs' => [ 'InvocationInput$actionGroupInvocationInput' => 'Contains information about the action group to be invoked.
', ], ], 'ActionGroupInvocationOutput' => [ 'base' => 'Contains the JSON-formatted string returned by the API invoked by the action group.
', 'refs' => [ 'Observation$actionGroupInvocationOutput' => 'Contains the JSON-formatted string returned by the API invoked by the action group.
', ], ], 'ActionGroupName' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$actionGroupName' => 'The name of the action group.
', ], ], 'ActionGroupOutputString' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationOutput$text' => 'The JSON-formatted string returned by the API invoked by the action group.
', ], ], 'AdditionalModelRequestFields' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesGenerationConfiguration$additionalModelRequestFields' => 'Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.
', 'GenerationConfiguration$additionalModelRequestFields' => 'Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
', ], ], 'AdditionalModelRequestFieldsKey' => [ 'base' => NULL, 'refs' => [ 'AdditionalModelRequestFields$key' => NULL, ], ], 'AdditionalModelRequestFieldsValue' => [ 'base' => NULL, 'refs' => [ 'AdditionalModelRequestFields$value' => NULL, ], ], 'AgentAliasId' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$agentAliasId' => 'The alias of the agent to use.
', 'TracePart$agentAliasId' => 'The unique identifier of the alias of the agent.
', ], ], 'AgentId' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$agentId' => 'The unique identifier of the agent to use.
', 'TracePart$agentId' => 'The unique identifier of the agent.
', ], ], 'AgentVersion' => [ 'base' => NULL, 'refs' => [ 'TracePart$agentVersion' => 'The version of the agent.
', ], ], 'ApiContentMap' => [ 'base' => NULL, 'refs' => [ 'ApiRequestBody$content' => 'The content of the request body. The key of the object in this field is a media type defining the format of the request body.
', ], ], 'ApiInvocationInput' => [ 'base' => 'Contains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Contains information about the API operation that the agent predicts should be called.
', ], ], 'ApiParameter' => [ 'base' => 'Information about a parameter to provide to the API request.
This data type is used in the following API operations:
', 'refs' => [ 'ApiParameters$member' => NULL, ], ], 'ApiParameters' => [ 'base' => NULL, 'refs' => [ 'ApiInvocationInput$parameters' => 'The parameters to provide for the API request, as the agent elicited from the user.
', ], ], 'ApiPath' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$apiPath' => 'The path to the API to call, based off the action group.
', 'ApiInvocationInput$apiPath' => 'The path to the API operation.
', 'ApiResult$apiPath' => 'The path to the API operation.
', ], ], 'ApiRequestBody' => [ 'base' => 'The request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
', 'refs' => [ 'ApiInvocationInput$requestBody' => 'The request body to provide for the API request, as the agent elicited from the user.
', ], ], 'ApiResult' => [ 'base' => 'Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
The result from the API response from the action group invocation.
', ], ], 'Attribution' => [ 'base' => 'Contains citations for a part of an agent response.
', 'refs' => [ 'PayloadPart$attribution' => 'Contains citations for a part of an agent response.
', ], ], 'BadGatewayException' => [ 'base' => 'There was an issue with a dependency due to a server issue. Retry your request.
', 'refs' => [ 'ResponseStream$badGatewayException' => 'There was an issue with a dependency due to a server issue. Retry your request.
', ], ], 'BedrockModelArn' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$modelArn' => 'The modelArn used with the external source wrapper object in the retrieveAndGenerate function.
', 'KnowledgeBaseRetrieveAndGenerateConfiguration$modelArn' => 'The ARN of the foundation model used to generate a response.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$enableTrace' => 'Specifies whether to turn on the trace or not to track the agent\'s reasoning process. For more information, see Trace enablement.
', 'InvokeAgentRequest$endSession' => 'Specifies whether to end the session with the agent or not.
', 'PreProcessingParsedResponse$isValid' => 'Whether the user input is valid or not. If false, the agent doesn\'t proceed to orchestration.
The byte value of the file to upload, encoded as a Base-64 string.
', ], ], 'ByteContentDoc' => [ 'base' => 'This property contains the document to chat with, along with its attributes.
', 'refs' => [ 'ExternalSource$byteContent' => 'The identifier, contentType, and data of the external source wrapper object.
', ], ], 'Citation' => [ 'base' => 'An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
InvokeAgent response – in the citations field
RetrieveAndGenerate response – in the citations field
A list of citations and related information for a part of an agent response.
', 'RetrieveAndGenerateResponse$citations' => 'A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
', ], ], 'ConflictException' => [ 'base' => 'There was a conflict performing an operation. Resolve the conflict and retry your request.
', 'refs' => [ 'ResponseStream$conflictException' => 'There was a conflict performing an operation. Resolve the conflict and retry your request.
', ], ], 'ContentBody' => [ 'base' => 'Contains the body of the API response.
This data type is used in the following API operations:
In the returnControlInvocationResults field of the InvokeAgent request
The content in the request body.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$contentType' => 'The MIME type of the document contained in the wrapper object.
', ], ], 'CreationMode' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$parserMode' => 'Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.
Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.
There was an issue with a dependency. Check the resource configurations and retry the request.
', 'refs' => [ 'ResponseStream$dependencyFailedException' => 'There was an issue with a dependency. Check the resource configurations and retry the request.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrievalResult$score' => 'The level of relevance of the result to the query.
', ], ], 'ExternalSource' => [ 'base' => 'The unique external source of the content contained in the wrapper object.
', 'refs' => [ 'ExternalSources$member' => NULL, ], ], 'ExternalSourceType' => [ 'base' => NULL, 'refs' => [ 'ExternalSource$sourceType' => 'The source type of the external source wrapper object.
', ], ], 'ExternalSources' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$sources' => 'The document used with the external source wrapper object in the retrieveAndGenerate function.
', ], ], 'ExternalSourcesGenerationConfiguration' => [ 'base' => 'Contains the generation configuration of the external source wrapper object.
', 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$generationConfiguration' => 'The prompt used with the external source wrapper object with the retrieveAndGenerate function.
', ], ], 'ExternalSourcesRetrieveAndGenerateConfiguration' => [ 'base' => 'The configurations of the external source wrapper object in the retrieveAndGenerate function.
', 'refs' => [ 'RetrieveAndGenerateConfiguration$externalSourcesConfiguration' => 'The configuration used with the external source wrapper object in the retrieveAndGenerate function.
', ], ], 'FailureReasonString' => [ 'base' => NULL, 'refs' => [ 'FailureTrace$failureReason' => 'The reason the interaction failed.
', ], ], 'FailureTrace' => [ 'base' => 'Contains information about the failure of the interaction.
', 'refs' => [ 'Trace$failureTrace' => 'Contains information about the failure of the interaction.
', ], ], 'FilterAttribute' => [ 'base' => 'Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.
This data type is used in the following API operations:
', 'refs' => [ 'RetrievalFilter$equals' => 'Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
"equals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
"greaterThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
"greaterThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
"in": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
"lessThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
"lessThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example ["dog", "cat"]).
"listContains": { "key": "animals", "value": "cat" }
Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn\'t match the value in this object are returned.
The following example would return data sources that don\'t contain an animal attribute whose value is cat.
"notEquals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn\'t in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
"notIn": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
"startsWith": { "key": "animal", "value": "ca" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
"stringContains": { "key": "animal", "value": "at" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example ["dog", "cat"]).
"stringContains": { "key": "animals", "value": "at" }
The name that the metadata attribute must match.
', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterAttribute$value' => 'The value to whcih to compare the value of the metadata attribute.
', ], ], 'FinalResponse' => [ 'base' => 'Contains details about the response to the user.
', 'refs' => [ 'Observation$finalResponse' => 'Contains details about the response to the user.
', ], ], 'FinalResponseString' => [ 'base' => NULL, 'refs' => [ 'FinalResponse$text' => 'The text in the response to the user.
', ], ], 'Function' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$function' => 'The function in the action group to call.
', ], ], 'FunctionInvocationInput' => [ 'base' => 'Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Contains information about the function that the agent predicts should be called.
', ], ], 'FunctionParameter' => [ 'base' => 'Contains information about a parameter of the function.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
A list of parameters of the function.
', ], ], 'FunctionResult' => [ 'base' => 'Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
The result from the function from the action group invocation.
', ], ], 'GeneratedResponsePart' => [ 'base' => 'Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
InvokeAgent response – in the generatedResponsePart field
RetrieveAndGenerate response – in the generatedResponsePart field
Contains the generated response and metadata
', ], ], 'GenerationConfiguration' => [ 'base' => 'Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
', 'refs' => [ 'KnowledgeBaseRetrieveAndGenerateConfiguration$generationConfiguration' => 'Contains configurations for response generation based on the knowwledge base query results.
', ], ], 'GuadrailAction' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateResponse$guardrailAction' => 'Specifies if there is a guardrail intervention in the response.
', ], ], 'GuardrailAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailTrace$action' => 'The trace action details used with the Guardrail.
', ], ], 'GuardrailAssessment' => [ 'base' => 'Assessment details of the content analyzed by Guardrails.
', 'refs' => [ 'GuardrailAssessmentList$member' => NULL, ], ], 'GuardrailAssessmentList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTrace$inputAssessments' => 'The details of the input assessments used in the Guardrail Trace.
', 'GuardrailTrace$outputAssessments' => 'The details of the output assessments used in the Guardrail Trace.
', ], ], 'GuardrailConfiguration' => [ 'base' => 'The configuration details for the guardrail.
', 'refs' => [ 'ExternalSourcesGenerationConfiguration$guardrailConfiguration' => 'The configuration details for the guardrail.
', 'GenerationConfiguration$guardrailConfiguration' => 'The configuration details for the guardrail.
', ], ], 'GuardrailConfigurationGuardrailIdString' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailId' => 'The unique identifier for the guardrail.
', ], ], 'GuardrailConfigurationGuardrailVersionString' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailVersion' => 'The version of the guardrail.
', ], ], 'GuardrailContentFilter' => [ 'base' => 'Details of the content filter used in the Guardrail.
', 'refs' => [ 'GuardrailContentFilterList$member' => NULL, ], ], 'GuardrailContentFilterConfidence' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$confidence' => 'The confidence level regarding the content detected in the filter by the Guardrail.
', ], ], 'GuardrailContentFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentPolicyAssessment$filters' => 'The filter details of the policy assessment used in the Guardrails filter.
', ], ], 'GuardrailContentFilterType' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$type' => 'The type of content detected in the filter by the Guardrail.
', ], ], 'GuardrailContentPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$action' => 'The action placed on the content by the Guardrail filter.
', ], ], 'GuardrailContentPolicyAssessment' => [ 'base' => 'The details of the policy assessment in the Guardrails filter.
', 'refs' => [ 'GuardrailAssessment$contentPolicy' => 'Content policy details of the Guardrail.
', ], ], 'GuardrailCustomWord' => [ 'base' => 'The custom word details for the filter in the Guardrail.
', 'refs' => [ 'GuardrailCustomWordList$member' => NULL, ], ], 'GuardrailCustomWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$customWords' => 'The custom word details for words defined in the Guardrail filter.
', ], ], 'GuardrailManagedWord' => [ 'base' => 'The managed word details for the filter in the Guardrail.
', 'refs' => [ 'GuardrailManagedWordList$member' => NULL, ], ], 'GuardrailManagedWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$managedWordLists' => 'The managed word lists for words defined in the Guardrail filter.
', ], ], 'GuardrailManagedWordType' => [ 'base' => NULL, 'refs' => [ 'GuardrailManagedWord$type' => 'The type details for the managed word filter in the Guardrail.
', ], ], 'GuardrailPiiEntityFilter' => [ 'base' => 'The Guardrail filter to identify and remove personally identifiable information (PII).
', 'refs' => [ 'GuardrailPiiEntityFilterList$member' => NULL, ], ], 'GuardrailPiiEntityFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$piiEntities' => 'The details of the PII entities used in the sensitive policy assessment for the Guardrail.
', ], ], 'GuardrailPiiEntityType' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$type' => 'The type of PII the Guardrail filter has identified and removed.
', ], ], 'GuardrailRegexFilter' => [ 'base' => 'The details for the regex filter used in the Guardrail.
', 'refs' => [ 'GuardrailRegexFilterList$member' => NULL, ], ], 'GuardrailRegexFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$regexes' => 'The details of the regexes used in the sensitive policy assessment for the Guardrail.
', ], ], 'GuardrailSensitiveInformationPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$action' => 'The action of the Guardrail filter to identify and remove PII.
', 'GuardrailRegexFilter$action' => 'The action details for the regex filter used in the Guardrail.
', ], ], 'GuardrailSensitiveInformationPolicyAssessment' => [ 'base' => 'The details of the sensitive policy assessment used in the Guardrail.
', 'refs' => [ 'GuardrailAssessment$sensitiveInformationPolicy' => 'Sensitive Information policy details of Guardrail.
', ], ], 'GuardrailTopic' => [ 'base' => 'The details for a specific topic defined in the Guardrail.
', 'refs' => [ 'GuardrailTopicList$member' => NULL, ], ], 'GuardrailTopicList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopicPolicyAssessment$topics' => 'The topic details of the policy assessment used in the Guardrail.
', ], ], 'GuardrailTopicPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$action' => 'The action details on a specific topic in the Guardrail.
', ], ], 'GuardrailTopicPolicyAssessment' => [ 'base' => 'The details of the policy assessment used in the Guardrail.
', 'refs' => [ 'GuardrailAssessment$topicPolicy' => 'Topic policy details of the Guardrail.
', ], ], 'GuardrailTopicType' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$type' => 'The type details on a specific topic in the Guardrail.
', ], ], 'GuardrailTrace' => [ 'base' => 'The trace details used in the Guardrail.
', 'refs' => [ 'Trace$guardrailTrace' => 'The trace details for a trace defined in the Guardrail filter.
', ], ], 'GuardrailWordPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailCustomWord$action' => 'The action details for the custom word filter in the Guardrail.
', 'GuardrailManagedWord$action' => 'The action details for the managed word filter in the Guardrail.
', ], ], 'GuardrailWordPolicyAssessment' => [ 'base' => 'The assessment details for words defined in the Guardrail filter.
', 'refs' => [ 'GuardrailAssessment$wordPolicy' => 'Word policy details of the Guardrail.
', ], ], 'Identifier' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$identifier' => 'The file name of the document contained in the wrapper object.
', ], ], 'InferenceConfig' => [ 'base' => 'The configuration for inference settings when generating responses using RetrieveAndGenerate.
', 'refs' => [ 'ExternalSourcesGenerationConfiguration$inferenceConfig' => 'Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
', 'GenerationConfiguration$inferenceConfig' => 'Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
', ], ], 'InferenceConfiguration' => [ 'base' => 'Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
', 'refs' => [ 'ModelInvocationInput$inferenceConfiguration' => 'Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
', ], ], 'InputText' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$inputText' => 'The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
http status code from API execution response (for example: 200, 400, 500).
', ], ], 'InternalServerException' => [ 'base' => 'An internal server error occurred. Retry your request.
', 'refs' => [ 'ResponseStream$internalServerException' => 'An internal server error occurred. Retry your request.
', ], ], 'InvocationInput' => [ 'base' => 'Contains information pertaining to the action group or knowledge base that is being invoked.
', 'refs' => [ 'OrchestrationTrace$invocationInput' => 'Contains information pertaining to the action group or knowledge base that is being invoked.
', ], ], 'InvocationInputMember' => [ 'base' => 'Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
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.
', ], ], 'InvocationResultMember' => [ 'base' => 'A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.
This data type is used in the following API operations:
', 'refs' => [ 'ReturnControlInvocationResults$member' => NULL, ], ], 'InvocationType' => [ 'base' => NULL, 'refs' => [ 'InvocationInput$invocationType' => 'Specifies whether the agent is invoking an action group or a knowledge base.
', ], ], 'InvokeAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateSessionConfiguration$kmsKeyArn' => 'The ARN of the KMS key encrypting the session.
', ], ], 'KnowledgeBaseId' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrieveAndGenerateConfiguration$knowledgeBaseId' => 'The unique identifier of the knowledge base that is queried and the foundation model used for generation.
', 'RetrieveRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to query.
', ], ], 'KnowledgeBaseLookupInput' => [ 'base' => 'Contains details about the knowledge base to look up and the query to be made.
', 'refs' => [ 'InvocationInput$knowledgeBaseLookupInput' => 'Contains details about the knowledge base to look up and the query to be made.
', ], ], 'KnowledgeBaseLookupInputString' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseLookupInput$text' => 'The query made to the knowledge base.
', ], ], 'KnowledgeBaseLookupOutput' => [ 'base' => 'Contains details about the results from looking up the knowledge base.
', 'refs' => [ 'Observation$knowledgeBaseLookupOutput' => 'Contains details about the results from looking up the knowledge base.
', ], ], 'KnowledgeBaseQuery' => [ 'base' => 'Contains the query made to the knowledge base.
This data type is used in the following API operations:
Retrieve request – in the retrievalQuery field
Contains the query to send the knowledge base.
', ], ], 'KnowledgeBaseQueryTextString' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseQuery$text' => 'The text of the query made to the knowledge base.
', ], ], 'KnowledgeBaseRetrievalConfiguration' => [ 'base' => 'Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the retrievalConfiguration field
RetrieveAndGenerate request – in the retrievalConfiguration field
Contains configurations for how to retrieve and return the knowledge base query.
', 'RetrieveRequest$retrievalConfiguration' => 'Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
', ], ], 'KnowledgeBaseRetrievalResult' => [ 'base' => 'Details about a result from querying the knowledge base.
This data type is used in the following API operations:
Retrieve response – in the retrievalResults field
A list of results from querying the knowledge base.
', ], ], 'KnowledgeBaseRetrieveAndGenerateConfiguration' => [ 'base' => 'Contains details about the resource being queried.
This data type is used in the following API operations:
Retrieve request – in the knowledgeBaseConfiguration field
RetrieveAndGenerate request – in the knowledgeBaseConfiguration field
Contains details about the resource being queried.
', ], ], 'KnowledgeBaseVectorSearchConfiguration' => [ 'base' => 'Configurations for how to perform the search query and return results. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the vectorSearchConfiguration field
RetrieveAndGenerate request – in the vectorSearchConfiguration field
Contains details about how the results from the vector search should be returned. For more information, see Query configurations.
', ], ], 'KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$numberOfResults' => 'The number of source chunks to retrieve.
', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$overrideLambda' => 'The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
', ], ], 'MaxTokens' => [ 'base' => NULL, 'refs' => [ 'TextInferenceConfig$maxTokens' => 'The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
', ], ], 'MaximumLength' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$maximumLength' => 'The maximum number of tokens allowed in the generated response.
', ], ], 'MimeType' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentResponse$contentType' => 'The MIME type of the input data in the request. The default value is application/json.
The input for the pre-processing step.
The type matches the agent step.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the orchestration step.
The type is ORCHESTRATION.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the post-processing step.
The type is POST_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the pre-processing step.
The type is PRE_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
', 'ConflictException$message' => NULL, 'DependencyFailedException$message' => NULL, 'DependencyFailedException$resourceName' => 'The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
', 'InternalServerException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'Observation' => [ 'base' => 'Contains the result or output of an action group or knowledge base, or the response to the user.
', 'refs' => [ 'OrchestrationTrace$observation' => 'Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
', ], ], 'OrchestrationTrace' => [ 'base' => 'Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
', 'refs' => [ 'Trace$orchestrationTrace' => 'Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
', ], ], 'OutputString' => [ 'base' => NULL, 'refs' => [ 'PostProcessingParsedResponse$text' => 'The text returned by the parser.
', ], ], 'Parameter' => [ 'base' => 'A parameter for the API request or function.
', 'refs' => [ 'ParameterList$member' => NULL, 'Parameters$member' => NULL, ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'PropertyParameters$properties' => 'A list of parameters in the request body.
', ], ], 'Parameters' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$parameters' => 'The parameters in the Lambda input event.
', 'ContentMap$value' => NULL, ], ], 'PartBody' => [ 'base' => NULL, 'refs' => [ 'PayloadPart$bytes' => 'A part of the agent response in bytes.
', ], ], 'PayloadPart' => [ 'base' => 'Contains a part of an agent response and citations for it.
', 'refs' => [ 'ResponseStream$chunk' => 'Contains a part of an agent response and citations for it.
', ], ], 'PostProcessingModelInvocationOutput' => [ 'base' => 'The foundation model output from the post-processing step.
', 'refs' => [ 'PostProcessingTrace$modelInvocationOutput' => 'The foundation model output from the post-processing step.
', ], ], 'PostProcessingParsedResponse' => [ 'base' => 'Details about the response from the Lambda parsing of the output from the post-processing step.
', 'refs' => [ 'PostProcessingModelInvocationOutput$parsedResponse' => 'Details about the response from the Lambda parsing of the output of the post-processing step.
', ], ], 'PostProcessingTrace' => [ 'base' => 'Details about the post-processing step, in which the agent shapes the response.
', 'refs' => [ 'Trace$postProcessingTrace' => 'Details about the post-processing step, in which the agent shapes the response..
', ], ], 'PreProcessingModelInvocationOutput' => [ 'base' => 'The foundation model output from the pre-processing step.
', 'refs' => [ 'PreProcessingTrace$modelInvocationOutput' => 'The foundation model output from the pre-processing step.
', ], ], 'PreProcessingParsedResponse' => [ 'base' => 'Details about the response from the Lambda parsing of the output from the pre-processing step.
', 'refs' => [ 'PreProcessingModelInvocationOutput$parsedResponse' => 'Details about the response from the Lambda parsing of the output of the pre-processing step.
', ], ], 'PreProcessingTrace' => [ 'base' => 'Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
', 'refs' => [ 'Trace$preProcessingTrace' => 'Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
', ], ], 'PromptSessionAttributesMap' => [ 'base' => NULL, 'refs' => [ 'SessionState$promptSessionAttributes' => 'Contains 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.
', ], ], 'PromptTemplate' => [ 'base' => 'Contains the template for the prompt that\'s sent to the model for response generation. For more information, see Knowledge base prompt templates.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the filter field
Contain the textPromptTemplate string for the external source wrapper object.
', 'GenerationConfiguration$promptTemplate' => 'Contains the template for the prompt that\'s sent to the model for response generation.
', ], ], 'PromptText' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$text' => 'The text that prompted the agent at this step.
', ], ], 'PromptType' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$type' => 'The step in the agent sequence.
', ], ], 'PropertyParameters' => [ 'base' => 'Contains the parameters in the request body.
', 'refs' => [ 'ApiContentMap$value' => NULL, ], ], 'RAGStopSequences' => [ 'base' => NULL, 'refs' => [ 'TextInferenceConfig$stopSequences' => 'A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
', ], ], 'RAGStopSequencesMemberString' => [ 'base' => NULL, 'refs' => [ 'RAGStopSequences$member' => NULL, ], ], 'Rationale' => [ 'base' => 'Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
', 'refs' => [ 'OrchestrationTrace$rationale' => 'Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
', ], ], 'RationaleString' => [ 'base' => NULL, 'refs' => [ 'PreProcessingParsedResponse$rationale' => 'The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.
', 'Rationale$text' => 'The reasoning or thought process of the agent, based on the input.
', ], ], 'RepromptResponse' => [ 'base' => 'Contains details about the agent\'s response to reprompt the input.
', 'refs' => [ 'Observation$repromptResponse' => 'Contains details about the response to reprompt the input.
', ], ], 'RequestBody' => [ 'base' => 'The parameters in the API request body.
', 'refs' => [ 'ActionGroupInvocationInput$requestBody' => 'The parameters in the request body for the Lambda input event.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
', 'refs' => [ 'ResponseStream$resourceNotFoundException' => 'The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
', ], ], 'ResponseBody' => [ 'base' => NULL, 'refs' => [ 'ApiResult$responseBody' => 'The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
The response from the function call using the parameters. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
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
', 'FunctionResult$responseState' => '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
', ], ], 'ResponseStream' => [ 'base' => 'The response from invoking the agent and associated citations and trace information.
', 'refs' => [ 'InvokeAgentResponse$completion' => 'The agent\'s response to the user prompt.
', ], ], 'RetrievalFilter' => [ 'base' => 'Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.
This data type is used in the following API operations:
Retrieve request – in the filter field
RetrieveAndGenerate request – in the filter field
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
', 'RetrievalFilterList$member' => NULL, ], ], 'RetrievalFilterList' => [ 'base' => NULL, 'refs' => [ 'RetrievalFilter$andAll' => 'Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
', 'RetrievalFilter$orAll' => 'Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
', ], ], 'RetrievalResultContent' => [ 'base' => 'Contains the cited text from the data source.
This data type is used in the following API operations:
Retrieve response – in the content field
RetrieveAndGenerate response – in the content field
InvokeAgent response – in the content field
Contains a chunk of text from a data source in the knowledge base.
', 'RetrievedReference$content' => 'Contains the cited text from the data source.
', ], ], 'RetrievalResultLocation' => [ 'base' => 'Contains information about the location of the data source.
This data type is used in the following API operations:
Retrieve response – in the location field
RetrieveAndGenerate response – in the location field
InvokeAgent response – in the locatino field
Contains information about the location of the data source.
', 'RetrievedReference$location' => 'Contains information about the location of the data source.
', ], ], 'RetrievalResultLocationType' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultLocation$type' => 'The type of the location of the data source.
', ], ], 'RetrievalResultMetadata' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrievalResult$metadata' => 'Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
', 'RetrievedReference$metadata' => 'Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
', ], ], 'RetrievalResultMetadataKey' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultMetadata$key' => NULL, ], ], 'RetrievalResultMetadataValue' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultMetadata$value' => NULL, ], ], 'RetrievalResultS3Location' => [ 'base' => 'Contains the S3 location of the data source.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
InvokeAgent response – in the s3Location field
Contains the S3 location of the data source.
', ], ], 'RetrieveAndGenerateConfiguration' => [ 'base' => 'Contains details about the resource being queried.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the retrieveAndGenerateConfiguration field
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
', ], ], 'RetrieveAndGenerateInput' => [ 'base' => 'Contains the query made to the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the input field
Contains the query to be made to the knowledge base.
', ], ], 'RetrieveAndGenerateInputTextString' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateInput$text' => 'The query made to the knowledge base.
', ], ], 'RetrieveAndGenerateOutput' => [ 'base' => 'Contains the response generated from querying the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the output field
Contains the response generated from querying the knowledge base.
', ], ], 'RetrieveAndGenerateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveAndGenerateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveAndGenerateSessionConfiguration' => [ 'base' => 'Contains configuration about the session with the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the sessionConfiguration field
Contains details about the session with the knowledge base.
', ], ], 'RetrieveAndGenerateType' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateConfiguration$type' => 'The type of resource that is queried by the request.
', ], ], 'RetrieveRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetrievedReference' => [ 'base' => 'Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the retrievedReferences field
InvokeAgent response – in the retrievedReferences field
Contains metadata about the sources cited for the generated response.
', 'KnowledgeBaseLookupOutput$retrievedReferences' => 'Contains metadata about the sources cited for the generated response.
', ], ], 'ReturnControlInvocationResults' => [ 'base' => NULL, 'refs' => [ 'SessionState$returnControlInvocationResults' => 'Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
If you include this field, the inputText field will be ignored.
Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
', 'refs' => [ 'ResponseStream$returnControl' => '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.
', ], ], 'S3ObjectDoc' => [ 'base' => 'The unique wrapper object of the document from the S3 location.
', 'refs' => [ 'ExternalSource$s3Location' => 'The S3 location of the external source wrapper object.
', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'S3ObjectDoc$uri' => 'The file location of the S3 wrapper object.
', ], ], 'SearchType' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$overrideSearchType' => 'By default, Amazon Bedrock decides a search strategy for you. If you\'re using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
The number of requests exceeds the service quota. Resubmit your request later.
', 'refs' => [ 'ResponseStream$serviceQuotaExceededException' => 'The number of requests exceeds the service quota. Resubmit your request later.
', ], ], 'SessionAttributesMap' => [ 'base' => NULL, 'refs' => [ 'SessionState$sessionAttributes' => 'Contains attributes that persist across a session and the values of those attributes.
', ], ], 'SessionId' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$sessionId' => 'The unique identifier of the session. Use the same value across requests to continue the same conversation.
', 'InvokeAgentResponse$sessionId' => 'The unique identifier of the session with the agent.
', 'RetrieveAndGenerateRequest$sessionId' => 'The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.
', 'RetrieveAndGenerateResponse$sessionId' => 'The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.
', 'TracePart$sessionId' => 'The unique identifier of the session with the agent.
', ], ], 'SessionState' => [ 'base' => 'Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent\'s behavior. For more information, see Control session context.
', 'refs' => [ 'InvokeAgentRequest$sessionState' => 'Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Specifies what output is prompting the agent to reprompt the input.
', ], ], 'Span' => [ 'base' => 'Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the span field
InvokeAgent response – in the span field
Contains information about where the text with a citation begins and ends in the generated output.
', ], ], 'SpanEndInteger' => [ 'base' => NULL, 'refs' => [ 'Span$end' => 'Where the text with a citation ends in the generated output.
', ], ], 'SpanStartInteger' => [ 'base' => NULL, 'refs' => [ 'Span$start' => 'Where the text with a citation starts in the generated output.
', ], ], 'StopSequences' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$stopSequences' => 'A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ApiContentMap$key' => NULL, 'ApiInvocationInput$actionGroup' => 'The action group that the API operation belongs to.
', 'ApiInvocationInput$httpMethod' => 'The HTTP method of the API operation.
', 'ApiParameter$name' => 'The name of the parameter.
', 'ApiParameter$type' => 'The data type for the parameter.
', 'ApiParameter$value' => 'The value of the parameter.
', 'ApiResult$actionGroup' => 'The action group that the API operation belongs to.
', 'ApiResult$httpMethod' => 'The HTTP method for the API operation.
', 'ContentBody$body' => 'The body of the API response.
', 'ContentMap$key' => NULL, 'FunctionInvocationInput$actionGroup' => 'The action group that the function belongs to.
', 'FunctionInvocationInput$function' => 'The name of the function.
', 'FunctionParameter$name' => 'The name of the parameter.
', 'FunctionParameter$type' => 'The data type of the parameter.
', 'FunctionParameter$value' => 'The value of the parameter.
', 'FunctionResult$actionGroup' => 'The action group that the function belongs to.
', 'FunctionResult$function' => 'The name of the function that was called.
', 'GuardrailCustomWord$match' => 'The match details for the custom word filter in the Guardrail.
', 'GuardrailManagedWord$match' => 'The match details for the managed word filter in the Guardrail.
', 'GuardrailPiiEntityFilter$match' => 'The match to settings in the Guardrail filter to identify and remove PII.
', 'GuardrailRegexFilter$match' => 'The match details for the regex filter used in the Guardrail.
', 'GuardrailRegexFilter$name' => 'The name details for the regex filter used in the Guardrail.
', 'GuardrailRegexFilter$regex' => 'The regex details for the regex filter used in the Guardrail.
', 'GuardrailTopic$name' => 'The name details on a specific topic in the Guardrail.
', 'Parameter$name' => 'The name of the parameter.
', 'Parameter$type' => 'The type of the parameter.
', 'Parameter$value' => 'The value of the parameter.
', 'PromptSessionAttributesMap$key' => NULL, 'PromptSessionAttributesMap$value' => NULL, 'RepromptResponse$text' => 'The text reprompting the input.
', 'ResponseBody$key' => NULL, 'RetrievalResultContent$text' => 'The cited text from the data source.
', 'RetrievalResultS3Location$uri' => 'The S3 URI of the data source.
', 'RetrieveAndGenerateOutput$text' => 'The response generated from querying the knowledge base.
', 'ReturnControlPayload$invocationId' => 'The identifier of the action group invocation.
', 'SessionAttributesMap$key' => NULL, 'SessionAttributesMap$value' => NULL, 'SessionState$invocationId' => 'The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
The part of the generated text that contains a citation.
', ], ], 'Temperature' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$temperature' => 'The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
', 'TextInferenceConfig$temperature' => 'Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
', ], ], 'TextInferenceConfig' => [ 'base' => 'Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
The valid range of maxTokens depends on the accepted values for your chosen model\'s inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.
Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.
', ], ], 'TextPromptTemplate' => [ 'base' => NULL, 'refs' => [ 'PromptTemplate$textPromptTemplate' => 'The template for the prompt that\'s sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see the following resources:
', ], ], 'TextResponsePart' => [ 'base' => 'Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the textResponsePart field
InvokeAgent response – in the textResponsePart field
Contains metadata about a textual part of the generated response that is accompanied by a citation.
', ], ], 'ThrottlingException' => [ 'base' => 'The number of requests exceeds the limit. Resubmit your request later.
', 'refs' => [ 'ResponseStream$throttlingException' => 'The number of requests exceeds the limit. Resubmit your request later.
', ], ], 'TopK' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topK' => 'While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
', ], ], 'Trace' => [ 'base' => 'Contains one part of the agent\'s reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
', 'refs' => [ 'TracePart$trace' => 'Contains one part of the agent\'s reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
', ], ], 'TraceId' => [ 'base' => NULL, 'refs' => [ 'FailureTrace$traceId' => 'The unique identifier of the trace.
', 'GuardrailTrace$traceId' => 'The details of the trace Id used in the Guardrail Trace.
', 'InvocationInput$traceId' => 'The unique identifier of the trace.
', 'ModelInvocationInput$traceId' => 'The unique identifier of the trace.
', 'Observation$traceId' => 'The unique identifier of the trace.
', 'PostProcessingModelInvocationOutput$traceId' => 'The unique identifier of the trace.
', 'PreProcessingModelInvocationOutput$traceId' => 'The unique identifier of the trace.
', 'Rationale$traceId' => 'The unique identifier of the trace step.
', ], ], 'TraceKnowledgeBaseId' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseLookupInput$knowledgeBaseId' => 'The unique identifier of the knowledge base to look up.
', ], ], 'TracePart' => [ 'base' => '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 enablement.
', 'refs' => [ 'ResponseStream$trace' => '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.
', ], ], 'Type' => [ 'base' => NULL, 'refs' => [ 'Observation$type' => 'Specifies what kind of information the agent returns in the observation. The following values are possible.
ACTION_GROUP – The agent returns the result of an action group.
KNOWLEDGE_BASE – The agent returns information from a knowledge base.
FINISH – The agent returns a final response to the user with no follow-up.
ASK_USER – The agent asks the user a question.
REPROMPT – The agent prompts the user again for the same information.
Input validation failed. Check your request parameters and retry the request.
', 'refs' => [ 'ResponseStream$validationException' => 'Input validation failed. Check your request parameters and retry the request.
', ], ], 'Verb' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$verb' => 'The API method being used, based off the action group.
', ], ], ],]; diff --git a/src/data/bedrock-agent/2023-06-05/api-2.json b/src/data/bedrock-agent/2023-06-05/api-2.json index 584409003e..2a2de7c824 100644 --- a/src/data/bedrock-agent/2023-06-05/api-2.json +++ b/src/data/bedrock-agent/2023-06-05/api-2.json @@ -829,6 +829,7 @@ "description":{"shape":"Description"}, "failureReasons":{"shape":"FailureReasons"}, "foundationModel":{"shape":"ModelIdentifier"}, + "guardrailConfiguration":{"shape":"GuardrailConfiguration"}, "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, "instruction":{"shape":"Instruction"}, "preparedAt":{"shape":"DateTimestamp"}, @@ -1016,7 +1017,7 @@ "type":"string", "max":2048, "min":0, - "pattern":"^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents_.+$" + "pattern":"^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" }, "AgentStatus":{ "type":"string", @@ -1050,6 +1051,7 @@ "agentName":{"shape":"Name"}, "agentStatus":{"shape":"AgentStatus"}, "description":{"shape":"Description"}, + "guardrailConfiguration":{"shape":"GuardrailConfiguration"}, "latestAgentVersion":{"shape":"Version"}, "updatedAt":{"shape":"DateTimestamp"} } @@ -1078,6 +1080,7 @@ "description":{"shape":"Description"}, "failureReasons":{"shape":"FailureReasons"}, "foundationModel":{"shape":"ModelIdentifier"}, + "guardrailConfiguration":{"shape":"GuardrailConfiguration"}, "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, "instruction":{"shape":"Instruction"}, "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"}, @@ -1107,6 +1110,7 @@ "agentVersion":{"shape":"Version"}, "createdAt":{"shape":"DateTimestamp"}, "description":{"shape":"Description"}, + "guardrailConfiguration":{"shape":"GuardrailConfiguration"}, "updatedAt":{"shape":"DateTimestamp"} } }, @@ -1148,9 +1152,9 @@ }, "BedrockEmbeddingModelArn":{ "type":"string", - "max":1011, + "max":2048, "min":20, - "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$" + "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" }, "Boolean":{ "type":"boolean", @@ -1280,6 +1284,7 @@ "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, "description":{"shape":"Description"}, "foundationModel":{"shape":"ModelIdentifier"}, + "guardrailConfiguration":{"shape":"GuardrailConfiguration"}, "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, "instruction":{"shape":"Instruction"}, "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"}, @@ -1943,6 +1948,23 @@ "knowledgeBase":{"shape":"KnowledgeBase"} } }, + "GuardrailConfiguration":{ + "type":"structure", + "members":{ + "guardrailIdentifier":{"shape":"GuardrailIdentifier"}, + "guardrailVersion":{"shape":"GuardrailVersion"} + } + }, + "GuardrailIdentifier":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + }, + "GuardrailVersion":{ + "type":"string", + "pattern":"^(([0-9]{1,8})|(DRAFT))$" + }, "Id":{ "type":"string", "pattern":"^[0-9a-zA-Z]{10}$" @@ -2084,7 +2106,7 @@ }, "Instruction":{ "type":"string", - "max":1200, + "max":4000, "min":40, "sensitive":true }, @@ -3153,6 +3175,7 @@ "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, "description":{"shape":"Description"}, "foundationModel":{"shape":"ModelIdentifier"}, + "guardrailConfiguration":{"shape":"GuardrailConfiguration"}, "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, "instruction":{"shape":"Instruction"}, "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"} diff --git a/src/data/bedrock-agent/2023-06-05/api-2.json.php b/src/data/bedrock-agent/2023-06-05/api-2.json.php index b083261e65..21c64f4606 100644 --- a/src/data/bedrock-agent/2023-06-05/api-2.json.php +++ b/src/data/bedrock-agent/2023-06-05/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2023-06-05', 'endpointPrefix' => 'bedrock-agent', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'Agents for Amazon Bedrock', 'serviceId' => 'Bedrock Agent', 'signatureVersion' => 'v4', 'signingName' => 'bedrock', 'uid' => 'bedrock-agent-2023-06-05', ], 'operations' => [ 'AssociateAgentKnowledgeBase' => [ 'name' => 'AssociateAgentKnowledgeBase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociateAgentKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'AssociateAgentKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateAgent' => [ 'name' => 'CreateAgent', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CreateAgentRequest', ], 'output' => [ 'shape' => 'CreateAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateAgentActionGroup' => [ 'name' => 'CreateAgentActionGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAgentActionGroupRequest', ], 'output' => [ 'shape' => 'CreateAgentActionGroupResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateAgentAlias' => [ 'name' => 'CreateAgentAlias', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentaliases/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CreateAgentAliasRequest', ], 'output' => [ 'shape' => 'CreateAgentAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateDataSource' => [ 'name' => 'CreateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDataSourceRequest', ], 'output' => [ 'shape' => 'CreateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateKnowledgeBase' => [ 'name' => 'CreateKnowledgeBase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CreateKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'CreateKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'DeleteAgent' => [ 'name' => 'DeleteAgent', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteAgentRequest', ], 'output' => [ 'shape' => 'DeleteAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DeleteAgentActionGroup' => [ 'name' => 'DeleteAgentActionGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteAgentActionGroupRequest', ], 'output' => [ 'shape' => 'DeleteAgentActionGroupResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DeleteAgentAlias' => [ 'name' => 'DeleteAgentAlias', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentaliases/{agentAliasId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteAgentAliasRequest', ], 'output' => [ 'shape' => 'DeleteAgentAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DeleteAgentVersion' => [ 'name' => 'DeleteAgentVersion', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteAgentVersionRequest', ], 'output' => [ 'shape' => 'DeleteAgentVersionResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DeleteKnowledgeBase' => [ 'name' => 'DeleteKnowledgeBase', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/knowledgebases/{knowledgeBaseId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'DeleteKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DisassociateAgentKnowledgeBase' => [ 'name' => 'DisassociateAgentKnowledgeBase', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DisassociateAgentKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'DisassociateAgentKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'GetAgent' => [ 'name' => 'GetAgent', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentRequest', ], 'output' => [ 'shape' => 'GetAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAgentActionGroup' => [ 'name' => 'GetAgentActionGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentActionGroupRequest', ], 'output' => [ 'shape' => 'GetAgentActionGroupResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAgentAlias' => [ 'name' => 'GetAgentAlias', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentaliases/{agentAliasId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentAliasRequest', ], 'output' => [ 'shape' => 'GetAgentAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAgentKnowledgeBase' => [ 'name' => 'GetAgentKnowledgeBase', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'GetAgentKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAgentVersion' => [ 'name' => 'GetAgentVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentVersionRequest', ], 'output' => [ 'shape' => 'GetAgentVersionResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetDataSource' => [ 'name' => 'GetDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDataSourceRequest', ], 'output' => [ 'shape' => 'GetDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetIngestionJob' => [ 'name' => 'GetIngestionJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetIngestionJobRequest', ], 'output' => [ 'shape' => 'GetIngestionJobResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetKnowledgeBase' => [ 'name' => 'GetKnowledgeBase', 'http' => [ 'method' => 'GET', 'requestUri' => '/knowledgebases/{knowledgeBaseId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'GetKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgentActionGroups' => [ 'name' => 'ListAgentActionGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentActionGroupsRequest', ], 'output' => [ 'shape' => 'ListAgentActionGroupsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgentAliases' => [ 'name' => 'ListAgentAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentaliases/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentAliasesRequest', ], 'output' => [ 'shape' => 'ListAgentAliasesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgentKnowledgeBases' => [ 'name' => 'ListAgentKnowledgeBases', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentKnowledgeBasesRequest', ], 'output' => [ 'shape' => 'ListAgentKnowledgeBasesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgentVersions' => [ 'name' => 'ListAgentVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentversions/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentVersionsRequest', ], 'output' => [ 'shape' => 'ListAgentVersionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgents' => [ 'name' => 'ListAgents', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentsRequest', ], 'output' => [ 'shape' => 'ListAgentsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'POST', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListIngestionJobs' => [ 'name' => 'ListIngestionJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListIngestionJobsRequest', ], 'output' => [ 'shape' => 'ListIngestionJobsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListKnowledgeBases' => [ 'name' => 'ListKnowledgeBases', 'http' => [ 'method' => 'POST', 'requestUri' => '/knowledgebases/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListKnowledgeBasesRequest', ], 'output' => [ 'shape' => 'ListKnowledgeBasesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'PrepareAgent' => [ 'name' => 'PrepareAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'PrepareAgentRequest', ], 'output' => [ 'shape' => 'PrepareAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'StartIngestionJob' => [ 'name' => 'StartIngestionJob', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'StartIngestionJobRequest', ], 'output' => [ 'shape' => 'StartIngestionJobResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'UpdateAgent' => [ 'name' => 'UpdateAgent', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateAgentRequest', ], 'output' => [ 'shape' => 'UpdateAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateAgentActionGroup' => [ 'name' => 'UpdateAgentActionGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAgentActionGroupRequest', ], 'output' => [ 'shape' => 'UpdateAgentActionGroupResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateAgentAlias' => [ 'name' => 'UpdateAgentAlias', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentaliases/{agentAliasId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateAgentAliasRequest', ], 'output' => [ 'shape' => 'UpdateAgentAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateAgentKnowledgeBase' => [ 'name' => 'UpdateAgentKnowledgeBase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAgentKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'UpdateAgentKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'UpdateKnowledgeBase' => [ 'name' => 'UpdateKnowledgeBase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/{knowledgeBaseId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'UpdateKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], ], 'shapes' => [ 'APISchema' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'Payload', ], 's3' => [ 'shape' => 'S3Identifier', ], ], 'union' => true, ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'ActionGroupExecutor' => [ 'type' => 'structure', 'members' => [ 'customControl' => [ 'shape' => 'CustomControlMethod', ], 'lambda' => [ 'shape' => 'LambdaArn', ], ], 'union' => true, ], 'ActionGroupSignature' => [ 'type' => 'string', 'enum' => [ 'AMAZON.UserInput', ], ], 'ActionGroupState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'ActionGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionGroupSummary', ], 'max' => 10, 'min' => 0, ], 'ActionGroupSummary' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'actionGroupName', 'actionGroupState', 'updatedAt', ], 'members' => [ 'actionGroupId' => [ 'shape' => 'Id', ], 'actionGroupName' => [ 'shape' => 'Name', ], 'actionGroupState' => [ 'shape' => 'ActionGroupState', ], 'description' => [ 'shape' => 'Description', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'Agent' => [ 'type' => 'structure', 'required' => [ 'agentArn', 'agentId', 'agentName', 'agentResourceRoleArn', 'agentStatus', 'agentVersion', 'createdAt', 'idleSessionTTLInSeconds', 'updatedAt', ], 'members' => [ 'agentArn' => [ 'shape' => 'AgentArn', ], 'agentId' => [ 'shape' => 'Id', ], 'agentName' => [ 'shape' => 'Name', ], 'agentResourceRoleArn' => [ 'shape' => 'AgentRoleArn', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'agentVersion' => [ 'shape' => 'DraftVersion', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'customerEncryptionKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'foundationModel' => [ 'shape' => 'ModelIdentifier', ], 'idleSessionTTLInSeconds' => [ 'shape' => 'SessionTTL', ], 'instruction' => [ 'shape' => 'Instruction', ], 'preparedAt' => [ 'shape' => 'DateTimestamp', ], 'promptOverrideConfiguration' => [ 'shape' => 'PromptOverrideConfiguration', ], 'recommendedActions' => [ 'shape' => 'RecommendedActions', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentActionGroup' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'actionGroupName', 'actionGroupState', 'agentId', 'agentVersion', 'createdAt', 'updatedAt', ], 'members' => [ 'actionGroupExecutor' => [ 'shape' => 'ActionGroupExecutor', ], 'actionGroupId' => [ 'shape' => 'Id', ], 'actionGroupName' => [ 'shape' => 'Name', ], 'actionGroupState' => [ 'shape' => 'ActionGroupState', ], 'agentId' => [ 'shape' => 'Id', ], 'agentVersion' => [ 'shape' => 'Version', ], 'apiSchema' => [ 'shape' => 'APISchema', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'functionSchema' => [ 'shape' => 'FunctionSchema', ], 'parentActionSignature' => [ 'shape' => 'ActionGroupSignature', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentAlias' => [ 'type' => 'structure', 'required' => [ 'agentAliasArn', 'agentAliasId', 'agentAliasName', 'agentAliasStatus', 'agentId', 'createdAt', 'routingConfiguration', 'updatedAt', ], 'members' => [ 'agentAliasArn' => [ 'shape' => 'AgentAliasArn', ], 'agentAliasHistoryEvents' => [ 'shape' => 'AgentAliasHistoryEvents', ], 'agentAliasId' => [ 'shape' => 'AgentAliasId', ], 'agentAliasName' => [ 'shape' => 'Name', ], 'agentAliasStatus' => [ 'shape' => 'AgentAliasStatus', ], 'agentId' => [ 'shape' => 'Id', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentAliasArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$', ], 'AgentAliasHistoryEvent' => [ 'type' => 'structure', 'members' => [ 'endDate' => [ 'shape' => 'DateTimestamp', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], 'startDate' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentAliasHistoryEvents' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentAliasHistoryEvent', ], 'max' => 10, 'min' => 0, ], 'AgentAliasId' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$', ], 'AgentAliasRoutingConfiguration' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentAliasRoutingConfigurationListItem', ], 'max' => 1, 'min' => 0, ], 'AgentAliasRoutingConfigurationListItem' => [ 'type' => 'structure', 'members' => [ 'agentVersion' => [ 'shape' => 'Version', ], 'provisionedThroughput' => [ 'shape' => 'ProvisionedModelIdentifier', ], ], ], 'AgentAliasStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'PREPARED', 'FAILED', 'UPDATING', 'DELETING', ], ], 'AgentAliasSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentAliasSummary', ], 'max' => 10, 'min' => 0, ], 'AgentAliasSummary' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentAliasName', 'agentAliasStatus', 'createdAt', 'updatedAt', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', ], 'agentAliasName' => [ 'shape' => 'Name', ], 'agentAliasStatus' => [ 'shape' => 'AgentAliasStatus', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$', ], 'AgentKnowledgeBase' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'createdAt', 'description', 'knowledgeBaseId', 'knowledgeBaseState', 'updatedAt', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentVersion' => [ 'shape' => 'Version', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'knowledgeBaseState' => [ 'shape' => 'KnowledgeBaseState', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentKnowledgeBaseSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentKnowledgeBaseSummary', ], 'max' => 10, 'min' => 0, ], 'AgentKnowledgeBaseSummary' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'knowledgeBaseState', 'updatedAt', ], 'members' => [ 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'knowledgeBaseState' => [ 'shape' => 'KnowledgeBaseState', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentRoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents_.+$', ], 'AgentStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'PREPARING', 'PREPARED', 'NOT_PREPARED', 'DELETING', 'FAILED', 'VERSIONING', 'UPDATING', ], ], 'AgentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentSummary', ], 'max' => 10, 'min' => 0, ], 'AgentSummary' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentName', 'agentStatus', 'updatedAt', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentName' => [ 'shape' => 'Name', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'description' => [ 'shape' => 'Description', ], 'latestAgentVersion' => [ 'shape' => 'Version', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentVersion' => [ 'type' => 'structure', 'required' => [ 'agentArn', 'agentId', 'agentName', 'agentResourceRoleArn', 'agentStatus', 'createdAt', 'idleSessionTTLInSeconds', 'updatedAt', 'version', ], 'members' => [ 'agentArn' => [ 'shape' => 'AgentArn', ], 'agentId' => [ 'shape' => 'Id', ], 'agentName' => [ 'shape' => 'Name', ], 'agentResourceRoleArn' => [ 'shape' => 'AgentRoleArn', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'customerEncryptionKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'foundationModel' => [ 'shape' => 'ModelIdentifier', ], 'idleSessionTTLInSeconds' => [ 'shape' => 'SessionTTL', ], 'instruction' => [ 'shape' => 'Instruction', ], 'promptOverrideConfiguration' => [ 'shape' => 'PromptOverrideConfiguration', ], 'recommendedActions' => [ 'shape' => 'RecommendedActions', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], 'version' => [ 'shape' => 'NumericalVersion', ], ], ], 'AgentVersionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentVersionSummary', ], 'max' => 10, 'min' => 0, ], 'AgentVersionSummary' => [ 'type' => 'structure', 'required' => [ 'agentName', 'agentStatus', 'agentVersion', 'createdAt', 'updatedAt', ], 'members' => [ 'agentName' => [ 'shape' => 'Name', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'agentVersion' => [ 'shape' => 'Version', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AssociateAgentKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'description', 'knowledgeBaseId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'knowledgeBaseState' => [ 'shape' => 'KnowledgeBaseState', ], ], ], 'AssociateAgentKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'agentKnowledgeBase', ], 'members' => [ 'agentKnowledgeBase' => [ 'shape' => 'AgentKnowledgeBase', ], ], ], 'BasePromptTemplate' => [ 'type' => 'string', 'max' => 100000, 'min' => 1, ], 'BedrockEmbeddingModelArn' => [ 'type' => 'string', 'max' => 1011, 'min' => 20, 'pattern' => '^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$', ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'BucketOwnerAccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^[0-9]{12}$', ], 'ChunkingConfiguration' => [ 'type' => 'structure', 'required' => [ 'chunkingStrategy', ], 'members' => [ 'chunkingStrategy' => [ 'shape' => 'ChunkingStrategy', ], 'fixedSizeChunkingConfiguration' => [ 'shape' => 'FixedSizeChunkingConfiguration', ], ], ], 'ChunkingStrategy' => [ 'type' => 'string', 'enum' => [ 'FIXED_SIZE', 'NONE', ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 256, 'min' => 33, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ColumnName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^[a-zA-Z0-9_\\-]+$', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'CreateAgentActionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'actionGroupName', 'agentId', 'agentVersion', ], 'members' => [ 'actionGroupExecutor' => [ 'shape' => 'ActionGroupExecutor', ], 'actionGroupName' => [ 'shape' => 'Name', ], 'actionGroupState' => [ 'shape' => 'ActionGroupState', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'apiSchema' => [ 'shape' => 'APISchema', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'Description', ], 'functionSchema' => [ 'shape' => 'FunctionSchema', ], 'parentActionGroupSignature' => [ 'shape' => 'ActionGroupSignature', ], ], ], 'CreateAgentActionGroupResponse' => [ 'type' => 'structure', 'required' => [ 'agentActionGroup', ], 'members' => [ 'agentActionGroup' => [ 'shape' => 'AgentActionGroup', ], ], ], 'CreateAgentAliasRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasName', 'agentId', ], 'members' => [ 'agentAliasName' => [ 'shape' => 'Name', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'Description', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'CreateAgentAliasResponse' => [ 'type' => 'structure', 'required' => [ 'agentAlias', ], 'members' => [ 'agentAlias' => [ 'shape' => 'AgentAlias', ], ], ], 'CreateAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentName', ], 'members' => [ 'agentName' => [ 'shape' => 'Name', ], 'agentResourceRoleArn' => [ 'shape' => 'AgentRoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'customerEncryptionKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'description' => [ 'shape' => 'Description', ], 'foundationModel' => [ 'shape' => 'ModelIdentifier', ], 'idleSessionTTLInSeconds' => [ 'shape' => 'SessionTTL', ], 'instruction' => [ 'shape' => 'Instruction', ], 'promptOverrideConfiguration' => [ 'shape' => 'PromptOverrideConfiguration', ], 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'CreateAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agent', ], 'members' => [ 'agent' => [ 'shape' => 'Agent', ], ], ], 'CreateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceConfiguration', 'knowledgeBaseId', 'name', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'dataDeletionPolicy' => [ 'shape' => 'DataDeletionPolicy', ], 'dataSourceConfiguration' => [ 'shape' => 'DataSourceConfiguration', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'name' => [ 'shape' => 'Name', ], 'serverSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'vectorIngestionConfiguration' => [ 'shape' => 'VectorIngestionConfiguration', ], ], ], 'CreateDataSourceResponse' => [ 'type' => 'structure', 'required' => [ 'dataSource', ], 'members' => [ 'dataSource' => [ 'shape' => 'DataSource', ], ], ], 'CreateKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseConfiguration', 'name', 'roleArn', 'storageConfiguration', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseConfiguration' => [ 'shape' => 'KnowledgeBaseConfiguration', ], 'name' => [ 'shape' => 'Name', ], 'roleArn' => [ 'shape' => 'KnowledgeBaseRoleArn', ], 'storageConfiguration' => [ 'shape' => 'StorageConfiguration', ], 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'CreateKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBase', ], 'members' => [ 'knowledgeBase' => [ 'shape' => 'KnowledgeBase', ], ], ], 'CreationMode' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'OVERRIDDEN', ], ], 'CustomControlMethod' => [ 'type' => 'string', 'enum' => [ 'RETURN_CONTROL', ], ], 'DataDeletionPolicy' => [ 'type' => 'string', 'enum' => [ 'RETAIN', 'DELETE', ], ], 'DataSource' => [ 'type' => 'structure', 'required' => [ 'createdAt', 'dataSourceConfiguration', 'dataSourceId', 'knowledgeBaseId', 'name', 'status', 'updatedAt', ], 'members' => [ 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'dataDeletionPolicy' => [ 'shape' => 'DataDeletionPolicy', ], 'dataSourceConfiguration' => [ 'shape' => 'DataSourceConfiguration', ], 'dataSourceId' => [ 'shape' => 'Id', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'name' => [ 'shape' => 'Name', ], 'serverSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'status' => [ 'shape' => 'DataSourceStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], 'vectorIngestionConfiguration' => [ 'shape' => 'VectorIngestionConfiguration', ], ], ], 'DataSourceConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 's3Configuration' => [ 'shape' => 'S3DataSourceConfiguration', ], 'type' => [ 'shape' => 'DataSourceType', ], ], ], 'DataSourceStatus' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'DELETING', 'DELETE_UNSUCCESSFUL', ], ], 'DataSourceSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceSummary', ], ], 'DataSourceSummary' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', 'name', 'status', 'updatedAt', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'DataSourceStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'DataSourceType' => [ 'type' => 'string', 'enum' => [ 'S3', ], ], 'DateTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'DeleteAgentActionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'agentId', 'agentVersion', ], 'members' => [ 'actionGroupId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'actionGroupId', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'skipResourceInUseCheck' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'skipResourceInUseCheck', ], ], ], 'DeleteAgentActionGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteAgentAliasRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], ], ], 'DeleteAgentAliasResponse' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentAliasStatus', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', ], 'agentAliasStatus' => [ 'shape' => 'AgentAliasStatus', ], 'agentId' => [ 'shape' => 'Id', ], ], ], 'DeleteAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'skipResourceInUseCheck' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'skipResourceInUseCheck', ], ], ], 'DeleteAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentStatus', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], ], ], 'DeleteAgentVersionRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'NumericalVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'skipResourceInUseCheck' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'skipResourceInUseCheck', ], ], ], 'DeleteAgentVersionResponse' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentStatus', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'agentVersion' => [ 'shape' => 'NumericalVersion', ], ], ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', 'status', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'status' => [ 'shape' => 'DataSourceStatus', ], ], ], 'DeleteKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'DeleteKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'status', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'status' => [ 'shape' => 'KnowledgeBaseStatus', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'DisassociateAgentKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'knowledgeBaseId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'DisassociateAgentKnowledgeBaseResponse' => [ 'type' => 'structure', 'members' => [], ], 'DraftVersion' => [ 'type' => 'string', 'max' => 5, 'min' => 5, 'pattern' => '^DRAFT$', ], 'FailureReason' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'FailureReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureReason', ], 'max' => 2048, 'min' => 0, ], 'FieldName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'FixedSizeChunkingConfiguration' => [ 'type' => 'structure', 'required' => [ 'maxTokens', 'overlapPercentage', ], 'members' => [ 'maxTokens' => [ 'shape' => 'FixedSizeChunkingConfigurationMaxTokensInteger', ], 'overlapPercentage' => [ 'shape' => 'FixedSizeChunkingConfigurationOverlapPercentageInteger', ], ], ], 'FixedSizeChunkingConfigurationMaxTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'FixedSizeChunkingConfigurationOverlapPercentageInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 99, 'min' => 1, ], 'Function' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'description' => [ 'shape' => 'FunctionDescription', ], 'name' => [ 'shape' => 'Name', ], 'parameters' => [ 'shape' => 'ParameterMap', ], ], ], 'FunctionDescription' => [ 'type' => 'string', 'max' => 1200, 'min' => 1, ], 'FunctionSchema' => [ 'type' => 'structure', 'members' => [ 'functions' => [ 'shape' => 'Functions', ], ], 'union' => true, ], 'Functions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Function', ], ], 'GetAgentActionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'agentId', 'agentVersion', ], 'members' => [ 'actionGroupId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'actionGroupId', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'Version', 'location' => 'uri', 'locationName' => 'agentVersion', ], ], ], 'GetAgentActionGroupResponse' => [ 'type' => 'structure', 'required' => [ 'agentActionGroup', ], 'members' => [ 'agentActionGroup' => [ 'shape' => 'AgentActionGroup', ], ], ], 'GetAgentAliasRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], ], ], 'GetAgentAliasResponse' => [ 'type' => 'structure', 'required' => [ 'agentAlias', ], 'members' => [ 'agentAlias' => [ 'shape' => 'AgentAlias', ], ], ], 'GetAgentKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'knowledgeBaseId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'Version', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'GetAgentKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'agentKnowledgeBase', ], 'members' => [ 'agentKnowledgeBase' => [ 'shape' => 'AgentKnowledgeBase', ], ], ], 'GetAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], ], ], 'GetAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agent', ], 'members' => [ 'agent' => [ 'shape' => 'Agent', ], ], ], 'GetAgentVersionRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'NumericalVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], ], ], 'GetAgentVersionResponse' => [ 'type' => 'structure', 'required' => [ 'agentVersion', ], 'members' => [ 'agentVersion' => [ 'shape' => 'AgentVersion', ], ], ], 'GetDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'GetDataSourceResponse' => [ 'type' => 'structure', 'required' => [ 'dataSource', ], 'members' => [ 'dataSource' => [ 'shape' => 'DataSource', ], ], ], 'GetIngestionJobRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'ingestionJobId', 'knowledgeBaseId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'ingestionJobId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'ingestionJobId', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'GetIngestionJobResponse' => [ 'type' => 'structure', 'required' => [ 'ingestionJob', ], 'members' => [ 'ingestionJob' => [ 'shape' => 'IngestionJob', ], ], ], 'GetKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'GetKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBase', ], 'members' => [ 'knowledgeBase' => [ 'shape' => 'KnowledgeBase', ], ], ], 'Id' => [ 'type' => 'string', 'pattern' => '^[0-9a-zA-Z]{10}$', ], 'InferenceConfiguration' => [ 'type' => 'structure', 'members' => [ 'maximumLength' => [ 'shape' => 'MaximumLength', ], 'stopSequences' => [ 'shape' => 'StopSequences', ], 'temperature' => [ 'shape' => 'Temperature', ], 'topK' => [ 'shape' => 'TopK', ], 'topP' => [ 'shape' => 'TopP', ], ], ], 'IngestionJob' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'ingestionJobId', 'knowledgeBaseId', 'startedAt', 'status', 'updatedAt', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'ingestionJobId' => [ 'shape' => 'Id', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'startedAt' => [ 'shape' => 'DateTimestamp', ], 'statistics' => [ 'shape' => 'IngestionJobStatistics', ], 'status' => [ 'shape' => 'IngestionJobStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'IngestionJobFilter' => [ 'type' => 'structure', 'required' => [ 'attribute', 'operator', 'values', ], 'members' => [ 'attribute' => [ 'shape' => 'IngestionJobFilterAttribute', ], 'operator' => [ 'shape' => 'IngestionJobFilterOperator', ], 'values' => [ 'shape' => 'IngestionJobFilterValues', ], ], ], 'IngestionJobFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'STATUS', ], ], 'IngestionJobFilterOperator' => [ 'type' => 'string', 'enum' => [ 'EQ', ], ], 'IngestionJobFilterValue' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'pattern' => '^.*$', ], 'IngestionJobFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'IngestionJobFilterValue', ], 'max' => 10, 'min' => 0, ], 'IngestionJobFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'IngestionJobFilter', ], 'max' => 1, 'min' => 1, ], 'IngestionJobSortBy' => [ 'type' => 'structure', 'required' => [ 'attribute', 'order', ], 'members' => [ 'attribute' => [ 'shape' => 'IngestionJobSortByAttribute', ], 'order' => [ 'shape' => 'SortOrder', ], ], ], 'IngestionJobSortByAttribute' => [ 'type' => 'string', 'enum' => [ 'STATUS', 'STARTED_AT', ], ], 'IngestionJobStatistics' => [ 'type' => 'structure', 'members' => [ 'numberOfDocumentsDeleted' => [ 'shape' => 'PrimitiveLong', ], 'numberOfDocumentsFailed' => [ 'shape' => 'PrimitiveLong', ], 'numberOfDocumentsScanned' => [ 'shape' => 'PrimitiveLong', ], 'numberOfMetadataDocumentsModified' => [ 'shape' => 'PrimitiveLong', ], 'numberOfMetadataDocumentsScanned' => [ 'shape' => 'PrimitiveLong', ], 'numberOfModifiedDocumentsIndexed' => [ 'shape' => 'PrimitiveLong', ], 'numberOfNewDocumentsIndexed' => [ 'shape' => 'PrimitiveLong', ], ], ], 'IngestionJobStatus' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'IN_PROGRESS', 'COMPLETE', 'FAILED', ], ], 'IngestionJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'IngestionJobSummary', ], ], 'IngestionJobSummary' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'ingestionJobId', 'knowledgeBaseId', 'startedAt', 'status', 'updatedAt', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', ], 'description' => [ 'shape' => 'Description', ], 'ingestionJobId' => [ 'shape' => 'Id', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'startedAt' => [ 'shape' => 'DateTimestamp', ], 'statistics' => [ 'shape' => 'IngestionJobStatistics', ], 'status' => [ 'shape' => 'IngestionJobStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'Instruction' => [ 'type' => 'string', 'max' => 1200, 'min' => 40, 'sensitive' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$', ], 'KnowledgeBase' => [ 'type' => 'structure', 'required' => [ 'createdAt', 'knowledgeBaseArn', 'knowledgeBaseConfiguration', 'knowledgeBaseId', 'name', 'roleArn', 'status', 'storageConfiguration', 'updatedAt', ], 'members' => [ 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'knowledgeBaseArn' => [ 'shape' => 'KnowledgeBaseArn', ], 'knowledgeBaseConfiguration' => [ 'shape' => 'KnowledgeBaseConfiguration', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'name' => [ 'shape' => 'Name', ], 'roleArn' => [ 'shape' => 'KnowledgeBaseRoleArn', ], 'status' => [ 'shape' => 'KnowledgeBaseStatus', ], 'storageConfiguration' => [ 'shape' => 'StorageConfiguration', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'KnowledgeBaseArn' => [ 'type' => 'string', 'max' => 128, 'min' => 0, 'pattern' => '^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$', ], 'KnowledgeBaseConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'KnowledgeBaseType', ], 'vectorKnowledgeBaseConfiguration' => [ 'shape' => 'VectorKnowledgeBaseConfiguration', ], ], ], 'KnowledgeBaseRoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$', ], 'KnowledgeBaseState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'KnowledgeBaseStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', 'UPDATING', 'FAILED', 'DELETE_UNSUCCESSFUL', ], ], 'KnowledgeBaseStorageType' => [ 'type' => 'string', 'enum' => [ 'OPENSEARCH_SERVERLESS', 'PINECONE', 'REDIS_ENTERPRISE_CLOUD', 'RDS', 'MONGO_DB_ATLAS', ], ], 'KnowledgeBaseSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'KnowledgeBaseSummary', ], ], 'KnowledgeBaseSummary' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'name', 'status', 'updatedAt', ], 'members' => [ 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'KnowledgeBaseStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'KnowledgeBaseType' => [ 'type' => 'string', 'enum' => [ 'VECTOR', ], ], 'LambdaArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$', ], 'ListAgentActionGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'Version', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentActionGroupsResponse' => [ 'type' => 'structure', 'required' => [ 'actionGroupSummaries', ], 'members' => [ 'actionGroupSummaries' => [ 'shape' => 'ActionGroupSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentAliasesResponse' => [ 'type' => 'structure', 'required' => [ 'agentAliasSummaries', ], 'members' => [ 'agentAliasSummaries' => [ 'shape' => 'AgentAliasSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentKnowledgeBasesRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'Version', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentKnowledgeBasesResponse' => [ 'type' => 'structure', 'required' => [ 'agentKnowledgeBaseSummaries', ], 'members' => [ 'agentKnowledgeBaseSummaries' => [ 'shape' => 'AgentKnowledgeBaseSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'agentVersionSummaries', ], 'members' => [ 'agentVersionSummaries' => [ 'shape' => 'AgentVersionSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentsResponse' => [ 'type' => 'structure', 'required' => [ 'agentSummaries', ], 'members' => [ 'agentSummaries' => [ 'shape' => 'AgentSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'required' => [ 'dataSourceSummaries', ], 'members' => [ 'dataSourceSummaries' => [ 'shape' => 'DataSourceSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListIngestionJobsRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'filters' => [ 'shape' => 'IngestionJobFilters', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'sortBy' => [ 'shape' => 'IngestionJobSortBy', ], ], ], 'ListIngestionJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ingestionJobSummaries', ], 'members' => [ 'ingestionJobSummaries' => [ 'shape' => 'IngestionJobSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListKnowledgeBasesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListKnowledgeBasesResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseSummaries', ], 'members' => [ 'knowledgeBaseSummaries' => [ 'shape' => 'KnowledgeBaseSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TaggableResourcesArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 1000, 'min' => 1, ], 'MaximumLength' => [ 'type' => 'integer', 'box' => true, 'max' => 4096, 'min' => 0, ], 'ModelIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$', ], 'MongoDbAtlasCollectionName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^.*$', ], 'MongoDbAtlasConfiguration' => [ 'type' => 'structure', 'required' => [ 'collectionName', 'credentialsSecretArn', 'databaseName', 'endpoint', 'fieldMapping', 'vectorIndexName', ], 'members' => [ 'collectionName' => [ 'shape' => 'MongoDbAtlasCollectionName', ], 'credentialsSecretArn' => [ 'shape' => 'SecretArn', ], 'databaseName' => [ 'shape' => 'MongoDbAtlasDatabaseName', ], 'endpoint' => [ 'shape' => 'MongoDbAtlasEndpoint', ], 'endpointServiceName' => [ 'shape' => 'MongoDbAtlasEndpointServiceName', ], 'fieldMapping' => [ 'shape' => 'MongoDbAtlasFieldMapping', ], 'vectorIndexName' => [ 'shape' => 'MongoDbAtlasIndexName', ], ], ], 'MongoDbAtlasDatabaseName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^.*$', ], 'MongoDbAtlasEndpoint' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'MongoDbAtlasEndpointServiceName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$', ], 'MongoDbAtlasFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'textField', 'vectorField', ], 'members' => [ 'metadataField' => [ 'shape' => 'FieldName', ], 'textField' => [ 'shape' => 'FieldName', ], 'vectorField' => [ 'shape' => 'FieldName', ], ], ], 'MongoDbAtlasIndexName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'Name' => [ 'type' => 'string', 'pattern' => '^([0-9a-zA-Z][_-]?){1,100}$', ], 'NextToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^\\S*$', ], 'NonBlankString' => [ 'type' => 'string', 'pattern' => '^[\\s\\S]+$', ], 'NumericalVersion' => [ 'type' => 'string', 'pattern' => '^[0-9]{1,5}$', ], 'OpenSearchServerlessCollectionArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$', ], 'OpenSearchServerlessConfiguration' => [ 'type' => 'structure', 'required' => [ 'collectionArn', 'fieldMapping', 'vectorIndexName', ], 'members' => [ 'collectionArn' => [ 'shape' => 'OpenSearchServerlessCollectionArn', ], 'fieldMapping' => [ 'shape' => 'OpenSearchServerlessFieldMapping', ], 'vectorIndexName' => [ 'shape' => 'OpenSearchServerlessIndexName', ], ], ], 'OpenSearchServerlessFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'textField', 'vectorField', ], 'members' => [ 'metadataField' => [ 'shape' => 'FieldName', ], 'textField' => [ 'shape' => 'FieldName', ], 'vectorField' => [ 'shape' => 'FieldName', ], ], ], 'OpenSearchServerlessIndexName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'ParameterDescription' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'ParameterDetail' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'description' => [ 'shape' => 'ParameterDescription', ], 'required' => [ 'shape' => 'Boolean', ], 'type' => [ 'shape' => 'Type', ], ], ], 'ParameterMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'Name', ], 'value' => [ 'shape' => 'ParameterDetail', ], ], 'Payload' => [ 'type' => 'string', 'sensitive' => true, ], 'PineconeConfiguration' => [ 'type' => 'structure', 'required' => [ 'connectionString', 'credentialsSecretArn', 'fieldMapping', ], 'members' => [ 'connectionString' => [ 'shape' => 'PineconeConnectionString', ], 'credentialsSecretArn' => [ 'shape' => 'SecretArn', ], 'fieldMapping' => [ 'shape' => 'PineconeFieldMapping', ], 'namespace' => [ 'shape' => 'PineconeNamespace', ], ], ], 'PineconeConnectionString' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'PineconeFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'textField', ], 'members' => [ 'metadataField' => [ 'shape' => 'FieldName', ], 'textField' => [ 'shape' => 'FieldName', ], ], ], 'PineconeNamespace' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'PrepareAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], ], ], 'PrepareAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentStatus', 'agentVersion', 'preparedAt', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'agentVersion' => [ 'shape' => 'Version', ], 'preparedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'PrimitiveLong' => [ 'type' => 'long', ], 'PromptConfiguration' => [ 'type' => 'structure', 'members' => [ 'basePromptTemplate' => [ 'shape' => 'BasePromptTemplate', ], 'inferenceConfiguration' => [ 'shape' => 'InferenceConfiguration', ], 'parserMode' => [ 'shape' => 'CreationMode', ], 'promptCreationMode' => [ 'shape' => 'CreationMode', ], 'promptState' => [ 'shape' => 'PromptState', ], 'promptType' => [ 'shape' => 'PromptType', ], ], ], 'PromptConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'PromptConfiguration', ], 'max' => 10, 'min' => 0, ], 'PromptOverrideConfiguration' => [ 'type' => 'structure', 'required' => [ 'promptConfigurations', ], 'members' => [ 'overrideLambda' => [ 'shape' => 'LambdaArn', ], 'promptConfigurations' => [ 'shape' => 'PromptConfigurations', ], ], 'sensitive' => true, ], 'PromptState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'PromptType' => [ 'type' => 'string', 'enum' => [ 'PRE_PROCESSING', 'ORCHESTRATION', 'POST_PROCESSING', 'KNOWLEDGE_BASE_RESPONSE_GENERATION', ], ], 'ProvisionedModelIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^((([0-9a-zA-Z][_-]?){1,63})|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$', ], 'RdsArn' => [ 'type' => 'string', 'pattern' => '^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$', ], 'RdsConfiguration' => [ 'type' => 'structure', 'required' => [ 'credentialsSecretArn', 'databaseName', 'fieldMapping', 'resourceArn', 'tableName', ], 'members' => [ 'credentialsSecretArn' => [ 'shape' => 'SecretArn', ], 'databaseName' => [ 'shape' => 'RdsDatabaseName', ], 'fieldMapping' => [ 'shape' => 'RdsFieldMapping', ], 'resourceArn' => [ 'shape' => 'RdsArn', ], 'tableName' => [ 'shape' => 'RdsTableName', ], ], ], 'RdsDatabaseName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^[a-zA-Z0-9_\\-]+$', ], 'RdsFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'primaryKeyField', 'textField', 'vectorField', ], 'members' => [ 'metadataField' => [ 'shape' => 'ColumnName', ], 'primaryKeyField' => [ 'shape' => 'ColumnName', ], 'textField' => [ 'shape' => 'ColumnName', ], 'vectorField' => [ 'shape' => 'ColumnName', ], ], ], 'RdsTableName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^[a-zA-Z0-9_\\.\\-]+$', ], 'RecommendedAction' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'RecommendedActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendedAction', ], 'max' => 2048, 'min' => 0, ], 'RedisEnterpriseCloudConfiguration' => [ 'type' => 'structure', 'required' => [ 'credentialsSecretArn', 'endpoint', 'fieldMapping', 'vectorIndexName', ], 'members' => [ 'credentialsSecretArn' => [ 'shape' => 'SecretArn', ], 'endpoint' => [ 'shape' => 'RedisEnterpriseCloudEndpoint', ], 'fieldMapping' => [ 'shape' => 'RedisEnterpriseCloudFieldMapping', ], 'vectorIndexName' => [ 'shape' => 'RedisEnterpriseCloudIndexName', ], ], ], 'RedisEnterpriseCloudEndpoint' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'RedisEnterpriseCloudFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'textField', 'vectorField', ], 'members' => [ 'metadataField' => [ 'shape' => 'FieldName', ], 'textField' => [ 'shape' => 'FieldName', ], 'vectorField' => [ 'shape' => 'FieldName', ], ], ], 'RedisEnterpriseCloudIndexName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'S3BucketArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$', ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$', ], 'S3DataSourceConfiguration' => [ 'type' => 'structure', 'required' => [ 'bucketArn', ], 'members' => [ 'bucketArn' => [ 'shape' => 'S3BucketArn', ], 'bucketOwnerAccountId' => [ 'shape' => 'BucketOwnerAccountId', ], 'inclusionPrefixes' => [ 'shape' => 'S3Prefixes', ], ], ], 'S3Identifier' => [ 'type' => 'structure', 'members' => [ 's3BucketName' => [ 'shape' => 'S3BucketName', ], 's3ObjectKey' => [ 'shape' => 'S3ObjectKey', ], ], ], 'S3ObjectKey' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[\\.\\-\\!\\*\\_\\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\\'\\(\\)\\/a-zA-Z0-9]*$', ], 'S3Prefix' => [ 'type' => 'string', 'max' => 300, 'min' => 1, ], 'S3Prefixes' => [ 'type' => 'list', 'member' => [ 'shape' => 'S3Prefix', ], 'max' => 1, 'min' => 1, ], 'SecretArn' => [ 'type' => 'string', 'pattern' => '^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$', ], 'ServerSideEncryptionConfiguration' => [ 'type' => 'structure', 'members' => [ 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'SessionTTL' => [ 'type' => 'integer', 'box' => true, 'max' => 3600, 'min' => 60, ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'StartIngestionJobRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'StartIngestionJobResponse' => [ 'type' => 'structure', 'required' => [ 'ingestionJob', ], 'members' => [ 'ingestionJob' => [ 'shape' => 'IngestionJob', ], ], ], 'StopSequences' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 4, 'min' => 0, ], 'StorageConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'mongoDbAtlasConfiguration' => [ 'shape' => 'MongoDbAtlasConfiguration', ], 'opensearchServerlessConfiguration' => [ 'shape' => 'OpenSearchServerlessConfiguration', ], 'pineconeConfiguration' => [ 'shape' => 'PineconeConfiguration', ], 'rdsConfiguration' => [ 'shape' => 'RdsConfiguration', ], 'redisEnterpriseCloudConfiguration' => [ 'shape' => 'RedisEnterpriseCloudConfiguration', ], 'type' => [ 'shape' => 'KnowledgeBaseStorageType', ], ], ], 'String' => [ 'type' => 'string', ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\s._:/=+@-]*$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TaggableResourcesArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^[a-zA-Z0-9\\s._:/=+@-]*$', ], 'TaggableResourcesArn' => [ 'type' => 'string', 'max' => 1011, 'min' => 20, 'pattern' => '(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$)', ], 'TagsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], 'Temperature' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'TopK' => [ 'type' => 'integer', 'box' => true, 'max' => 500, 'min' => 0, ], 'TopP' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'Type' => [ 'type' => 'string', 'enum' => [ 'string', 'number', 'integer', 'boolean', 'array', ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TaggableResourcesArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAgentActionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'actionGroupName', 'agentId', 'agentVersion', ], 'members' => [ 'actionGroupExecutor' => [ 'shape' => 'ActionGroupExecutor', ], 'actionGroupId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'actionGroupId', ], 'actionGroupName' => [ 'shape' => 'Name', ], 'actionGroupState' => [ 'shape' => 'ActionGroupState', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'apiSchema' => [ 'shape' => 'APISchema', ], 'description' => [ 'shape' => 'Description', ], 'functionSchema' => [ 'shape' => 'FunctionSchema', ], 'parentActionGroupSignature' => [ 'shape' => 'ActionGroupSignature', ], ], ], 'UpdateAgentActionGroupResponse' => [ 'type' => 'structure', 'required' => [ 'agentActionGroup', ], 'members' => [ 'agentActionGroup' => [ 'shape' => 'AgentActionGroup', ], ], ], 'UpdateAgentAliasRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentAliasName', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentAliasName' => [ 'shape' => 'Name', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'description' => [ 'shape' => 'Description', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], ], ], 'UpdateAgentAliasResponse' => [ 'type' => 'structure', 'required' => [ 'agentAlias', ], 'members' => [ 'agentAlias' => [ 'shape' => 'AgentAlias', ], ], ], 'UpdateAgentKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'knowledgeBaseId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'knowledgeBaseState' => [ 'shape' => 'KnowledgeBaseState', ], ], ], 'UpdateAgentKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'agentKnowledgeBase', ], 'members' => [ 'agentKnowledgeBase' => [ 'shape' => 'AgentKnowledgeBase', ], ], ], 'UpdateAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentName', 'agentResourceRoleArn', 'foundationModel', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentName' => [ 'shape' => 'Name', ], 'agentResourceRoleArn' => [ 'shape' => 'AgentRoleArn', ], 'customerEncryptionKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'description' => [ 'shape' => 'Description', ], 'foundationModel' => [ 'shape' => 'ModelIdentifier', ], 'idleSessionTTLInSeconds' => [ 'shape' => 'SessionTTL', ], 'instruction' => [ 'shape' => 'Instruction', ], 'promptOverrideConfiguration' => [ 'shape' => 'PromptOverrideConfiguration', ], ], ], 'UpdateAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agent', ], 'members' => [ 'agent' => [ 'shape' => 'Agent', ], ], ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceConfiguration', 'dataSourceId', 'knowledgeBaseId', 'name', ], 'members' => [ 'dataDeletionPolicy' => [ 'shape' => 'DataDeletionPolicy', ], 'dataSourceConfiguration' => [ 'shape' => 'DataSourceConfiguration', ], 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'name' => [ 'shape' => 'Name', ], 'serverSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'vectorIngestionConfiguration' => [ 'shape' => 'VectorIngestionConfiguration', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'required' => [ 'dataSource', ], 'members' => [ 'dataSource' => [ 'shape' => 'DataSource', ], ], ], 'UpdateKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseConfiguration', 'knowledgeBaseId', 'name', 'roleArn', 'storageConfiguration', ], 'members' => [ 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseConfiguration' => [ 'shape' => 'KnowledgeBaseConfiguration', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'name' => [ 'shape' => 'Name', ], 'roleArn' => [ 'shape' => 'KnowledgeBaseRoleArn', ], 'storageConfiguration' => [ 'shape' => 'StorageConfiguration', ], ], ], 'UpdateKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBase', ], 'members' => [ 'knowledgeBase' => [ 'shape' => 'KnowledgeBase', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'fieldList' => [ 'shape' => 'ValidationExceptionFieldList', ], 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'message', 'name', ], 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'name' => [ 'shape' => 'NonBlankString', ], ], ], 'ValidationExceptionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'VectorIngestionConfiguration' => [ 'type' => 'structure', 'members' => [ 'chunkingConfiguration' => [ 'shape' => 'ChunkingConfiguration', ], ], ], 'VectorKnowledgeBaseConfiguration' => [ 'type' => 'structure', 'required' => [ 'embeddingModelArn', ], 'members' => [ 'embeddingModelArn' => [ 'shape' => 'BedrockEmbeddingModelArn', ], ], ], 'Version' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2023-06-05', 'endpointPrefix' => 'bedrock-agent', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'Agents for Amazon Bedrock', 'serviceId' => 'Bedrock Agent', 'signatureVersion' => 'v4', 'signingName' => 'bedrock', 'uid' => 'bedrock-agent-2023-06-05', ], 'operations' => [ 'AssociateAgentKnowledgeBase' => [ 'name' => 'AssociateAgentKnowledgeBase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociateAgentKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'AssociateAgentKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateAgent' => [ 'name' => 'CreateAgent', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CreateAgentRequest', ], 'output' => [ 'shape' => 'CreateAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateAgentActionGroup' => [ 'name' => 'CreateAgentActionGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateAgentActionGroupRequest', ], 'output' => [ 'shape' => 'CreateAgentActionGroupResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateAgentAlias' => [ 'name' => 'CreateAgentAlias', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentaliases/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CreateAgentAliasRequest', ], 'output' => [ 'shape' => 'CreateAgentAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateDataSource' => [ 'name' => 'CreateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDataSourceRequest', ], 'output' => [ 'shape' => 'CreateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'CreateKnowledgeBase' => [ 'name' => 'CreateKnowledgeBase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CreateKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'CreateKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'DeleteAgent' => [ 'name' => 'DeleteAgent', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteAgentRequest', ], 'output' => [ 'shape' => 'DeleteAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DeleteAgentActionGroup' => [ 'name' => 'DeleteAgentActionGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteAgentActionGroupRequest', ], 'output' => [ 'shape' => 'DeleteAgentActionGroupResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DeleteAgentAlias' => [ 'name' => 'DeleteAgentAlias', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentaliases/{agentAliasId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteAgentAliasRequest', ], 'output' => [ 'shape' => 'DeleteAgentAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DeleteAgentVersion' => [ 'name' => 'DeleteAgentVersion', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteAgentVersionRequest', ], 'output' => [ 'shape' => 'DeleteAgentVersionResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DeleteKnowledgeBase' => [ 'name' => 'DeleteKnowledgeBase', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/knowledgebases/{knowledgeBaseId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'DeleteKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'DisassociateAgentKnowledgeBase' => [ 'name' => 'DisassociateAgentKnowledgeBase', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DisassociateAgentKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'DisassociateAgentKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'GetAgent' => [ 'name' => 'GetAgent', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentRequest', ], 'output' => [ 'shape' => 'GetAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAgentActionGroup' => [ 'name' => 'GetAgentActionGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentActionGroupRequest', ], 'output' => [ 'shape' => 'GetAgentActionGroupResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAgentAlias' => [ 'name' => 'GetAgentAlias', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentaliases/{agentAliasId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentAliasRequest', ], 'output' => [ 'shape' => 'GetAgentAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAgentKnowledgeBase' => [ 'name' => 'GetAgentKnowledgeBase', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'GetAgentKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetAgentVersion' => [ 'name' => 'GetAgentVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentVersionRequest', ], 'output' => [ 'shape' => 'GetAgentVersionResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetDataSource' => [ 'name' => 'GetDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDataSourceRequest', ], 'output' => [ 'shape' => 'GetDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetIngestionJob' => [ 'name' => 'GetIngestionJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetIngestionJobRequest', ], 'output' => [ 'shape' => 'GetIngestionJobResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetKnowledgeBase' => [ 'name' => 'GetKnowledgeBase', 'http' => [ 'method' => 'GET', 'requestUri' => '/knowledgebases/{knowledgeBaseId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'GetKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgentActionGroups' => [ 'name' => 'ListAgentActionGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentActionGroupsRequest', ], 'output' => [ 'shape' => 'ListAgentActionGroupsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgentAliases' => [ 'name' => 'ListAgentAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentaliases/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentAliasesRequest', ], 'output' => [ 'shape' => 'ListAgentAliasesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgentKnowledgeBases' => [ 'name' => 'ListAgentKnowledgeBases', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentKnowledgeBasesRequest', ], 'output' => [ 'shape' => 'ListAgentKnowledgeBasesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgentVersions' => [ 'name' => 'ListAgentVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentversions/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentVersionsRequest', ], 'output' => [ 'shape' => 'ListAgentVersionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAgents' => [ 'name' => 'ListAgents', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAgentsRequest', ], 'output' => [ 'shape' => 'ListAgentsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'POST', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListIngestionJobs' => [ 'name' => 'ListIngestionJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListIngestionJobsRequest', ], 'output' => [ 'shape' => 'ListIngestionJobsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListKnowledgeBases' => [ 'name' => 'ListKnowledgeBases', 'http' => [ 'method' => 'POST', 'requestUri' => '/knowledgebases/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListKnowledgeBasesRequest', ], 'output' => [ 'shape' => 'ListKnowledgeBasesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'PrepareAgent' => [ 'name' => 'PrepareAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'PrepareAgentRequest', ], 'output' => [ 'shape' => 'PrepareAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'StartIngestionJob' => [ 'name' => 'StartIngestionJob', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'StartIngestionJobRequest', ], 'output' => [ 'shape' => 'StartIngestionJobResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'UpdateAgent' => [ 'name' => 'UpdateAgent', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateAgentRequest', ], 'output' => [ 'shape' => 'UpdateAgentResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateAgentActionGroup' => [ 'name' => 'UpdateAgentActionGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAgentActionGroupRequest', ], 'output' => [ 'shape' => 'UpdateAgentActionGroupResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateAgentAlias' => [ 'name' => 'UpdateAgentAlias', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentaliases/{agentAliasId}/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateAgentAliasRequest', ], 'output' => [ 'shape' => 'UpdateAgentAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'UpdateAgentKnowledgeBase' => [ 'name' => 'UpdateAgentKnowledgeBase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAgentKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'UpdateAgentKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], 'UpdateKnowledgeBase' => [ 'name' => 'UpdateKnowledgeBase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/knowledgebases/{knowledgeBaseId}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateKnowledgeBaseRequest', ], 'output' => [ 'shape' => 'UpdateKnowledgeBaseResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], 'idempotent' => true, ], ], 'shapes' => [ 'APISchema' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'Payload', ], 's3' => [ 'shape' => 'S3Identifier', ], ], 'union' => true, ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'ActionGroupExecutor' => [ 'type' => 'structure', 'members' => [ 'customControl' => [ 'shape' => 'CustomControlMethod', ], 'lambda' => [ 'shape' => 'LambdaArn', ], ], 'union' => true, ], 'ActionGroupSignature' => [ 'type' => 'string', 'enum' => [ 'AMAZON.UserInput', ], ], 'ActionGroupState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'ActionGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionGroupSummary', ], 'max' => 10, 'min' => 0, ], 'ActionGroupSummary' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'actionGroupName', 'actionGroupState', 'updatedAt', ], 'members' => [ 'actionGroupId' => [ 'shape' => 'Id', ], 'actionGroupName' => [ 'shape' => 'Name', ], 'actionGroupState' => [ 'shape' => 'ActionGroupState', ], 'description' => [ 'shape' => 'Description', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'Agent' => [ 'type' => 'structure', 'required' => [ 'agentArn', 'agentId', 'agentName', 'agentResourceRoleArn', 'agentStatus', 'agentVersion', 'createdAt', 'idleSessionTTLInSeconds', 'updatedAt', ], 'members' => [ 'agentArn' => [ 'shape' => 'AgentArn', ], 'agentId' => [ 'shape' => 'Id', ], 'agentName' => [ 'shape' => 'Name', ], 'agentResourceRoleArn' => [ 'shape' => 'AgentRoleArn', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'agentVersion' => [ 'shape' => 'DraftVersion', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'customerEncryptionKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'foundationModel' => [ 'shape' => 'ModelIdentifier', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'idleSessionTTLInSeconds' => [ 'shape' => 'SessionTTL', ], 'instruction' => [ 'shape' => 'Instruction', ], 'preparedAt' => [ 'shape' => 'DateTimestamp', ], 'promptOverrideConfiguration' => [ 'shape' => 'PromptOverrideConfiguration', ], 'recommendedActions' => [ 'shape' => 'RecommendedActions', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentActionGroup' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'actionGroupName', 'actionGroupState', 'agentId', 'agentVersion', 'createdAt', 'updatedAt', ], 'members' => [ 'actionGroupExecutor' => [ 'shape' => 'ActionGroupExecutor', ], 'actionGroupId' => [ 'shape' => 'Id', ], 'actionGroupName' => [ 'shape' => 'Name', ], 'actionGroupState' => [ 'shape' => 'ActionGroupState', ], 'agentId' => [ 'shape' => 'Id', ], 'agentVersion' => [ 'shape' => 'Version', ], 'apiSchema' => [ 'shape' => 'APISchema', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'functionSchema' => [ 'shape' => 'FunctionSchema', ], 'parentActionSignature' => [ 'shape' => 'ActionGroupSignature', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentAlias' => [ 'type' => 'structure', 'required' => [ 'agentAliasArn', 'agentAliasId', 'agentAliasName', 'agentAliasStatus', 'agentId', 'createdAt', 'routingConfiguration', 'updatedAt', ], 'members' => [ 'agentAliasArn' => [ 'shape' => 'AgentAliasArn', ], 'agentAliasHistoryEvents' => [ 'shape' => 'AgentAliasHistoryEvents', ], 'agentAliasId' => [ 'shape' => 'AgentAliasId', ], 'agentAliasName' => [ 'shape' => 'Name', ], 'agentAliasStatus' => [ 'shape' => 'AgentAliasStatus', ], 'agentId' => [ 'shape' => 'Id', ], 'clientToken' => [ 'shape' => 'ClientToken', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentAliasArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$', ], 'AgentAliasHistoryEvent' => [ 'type' => 'structure', 'members' => [ 'endDate' => [ 'shape' => 'DateTimestamp', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], 'startDate' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentAliasHistoryEvents' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentAliasHistoryEvent', ], 'max' => 10, 'min' => 0, ], 'AgentAliasId' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$', ], 'AgentAliasRoutingConfiguration' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentAliasRoutingConfigurationListItem', ], 'max' => 1, 'min' => 0, ], 'AgentAliasRoutingConfigurationListItem' => [ 'type' => 'structure', 'members' => [ 'agentVersion' => [ 'shape' => 'Version', ], 'provisionedThroughput' => [ 'shape' => 'ProvisionedModelIdentifier', ], ], ], 'AgentAliasStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'PREPARED', 'FAILED', 'UPDATING', 'DELETING', ], ], 'AgentAliasSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentAliasSummary', ], 'max' => 10, 'min' => 0, ], 'AgentAliasSummary' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentAliasName', 'agentAliasStatus', 'createdAt', 'updatedAt', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', ], 'agentAliasName' => [ 'shape' => 'Name', ], 'agentAliasStatus' => [ 'shape' => 'AgentAliasStatus', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$', ], 'AgentKnowledgeBase' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'createdAt', 'description', 'knowledgeBaseId', 'knowledgeBaseState', 'updatedAt', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentVersion' => [ 'shape' => 'Version', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'knowledgeBaseState' => [ 'shape' => 'KnowledgeBaseState', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentKnowledgeBaseSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentKnowledgeBaseSummary', ], 'max' => 10, 'min' => 0, ], 'AgentKnowledgeBaseSummary' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'knowledgeBaseState', 'updatedAt', ], 'members' => [ 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'knowledgeBaseState' => [ 'shape' => 'KnowledgeBaseState', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentRoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$', ], 'AgentStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'PREPARING', 'PREPARED', 'NOT_PREPARED', 'DELETING', 'FAILED', 'VERSIONING', 'UPDATING', ], ], 'AgentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentSummary', ], 'max' => 10, 'min' => 0, ], 'AgentSummary' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentName', 'agentStatus', 'updatedAt', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentName' => [ 'shape' => 'Name', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'description' => [ 'shape' => 'Description', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'latestAgentVersion' => [ 'shape' => 'Version', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AgentVersion' => [ 'type' => 'structure', 'required' => [ 'agentArn', 'agentId', 'agentName', 'agentResourceRoleArn', 'agentStatus', 'createdAt', 'idleSessionTTLInSeconds', 'updatedAt', 'version', ], 'members' => [ 'agentArn' => [ 'shape' => 'AgentArn', ], 'agentId' => [ 'shape' => 'Id', ], 'agentName' => [ 'shape' => 'Name', ], 'agentResourceRoleArn' => [ 'shape' => 'AgentRoleArn', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'customerEncryptionKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'foundationModel' => [ 'shape' => 'ModelIdentifier', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'idleSessionTTLInSeconds' => [ 'shape' => 'SessionTTL', ], 'instruction' => [ 'shape' => 'Instruction', ], 'promptOverrideConfiguration' => [ 'shape' => 'PromptOverrideConfiguration', ], 'recommendedActions' => [ 'shape' => 'RecommendedActions', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], 'version' => [ 'shape' => 'NumericalVersion', ], ], ], 'AgentVersionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentVersionSummary', ], 'max' => 10, 'min' => 0, ], 'AgentVersionSummary' => [ 'type' => 'structure', 'required' => [ 'agentName', 'agentStatus', 'agentVersion', 'createdAt', 'updatedAt', ], 'members' => [ 'agentName' => [ 'shape' => 'Name', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'agentVersion' => [ 'shape' => 'Version', ], 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'AssociateAgentKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'description', 'knowledgeBaseId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'knowledgeBaseState' => [ 'shape' => 'KnowledgeBaseState', ], ], ], 'AssociateAgentKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'agentKnowledgeBase', ], 'members' => [ 'agentKnowledgeBase' => [ 'shape' => 'AgentKnowledgeBase', ], ], ], 'BasePromptTemplate' => [ 'type' => 'string', 'max' => 100000, 'min' => 1, ], 'BedrockEmbeddingModelArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$', ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'BucketOwnerAccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^[0-9]{12}$', ], 'ChunkingConfiguration' => [ 'type' => 'structure', 'required' => [ 'chunkingStrategy', ], 'members' => [ 'chunkingStrategy' => [ 'shape' => 'ChunkingStrategy', ], 'fixedSizeChunkingConfiguration' => [ 'shape' => 'FixedSizeChunkingConfiguration', ], ], ], 'ChunkingStrategy' => [ 'type' => 'string', 'enum' => [ 'FIXED_SIZE', 'NONE', ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 256, 'min' => 33, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ColumnName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^[a-zA-Z0-9_\\-]+$', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'CreateAgentActionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'actionGroupName', 'agentId', 'agentVersion', ], 'members' => [ 'actionGroupExecutor' => [ 'shape' => 'ActionGroupExecutor', ], 'actionGroupName' => [ 'shape' => 'Name', ], 'actionGroupState' => [ 'shape' => 'ActionGroupState', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'apiSchema' => [ 'shape' => 'APISchema', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'Description', ], 'functionSchema' => [ 'shape' => 'FunctionSchema', ], 'parentActionGroupSignature' => [ 'shape' => 'ActionGroupSignature', ], ], ], 'CreateAgentActionGroupResponse' => [ 'type' => 'structure', 'required' => [ 'agentActionGroup', ], 'members' => [ 'agentActionGroup' => [ 'shape' => 'AgentActionGroup', ], ], ], 'CreateAgentAliasRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasName', 'agentId', ], 'members' => [ 'agentAliasName' => [ 'shape' => 'Name', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'Description', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'CreateAgentAliasResponse' => [ 'type' => 'structure', 'required' => [ 'agentAlias', ], 'members' => [ 'agentAlias' => [ 'shape' => 'AgentAlias', ], ], ], 'CreateAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentName', ], 'members' => [ 'agentName' => [ 'shape' => 'Name', ], 'agentResourceRoleArn' => [ 'shape' => 'AgentRoleArn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'customerEncryptionKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'description' => [ 'shape' => 'Description', ], 'foundationModel' => [ 'shape' => 'ModelIdentifier', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'idleSessionTTLInSeconds' => [ 'shape' => 'SessionTTL', ], 'instruction' => [ 'shape' => 'Instruction', ], 'promptOverrideConfiguration' => [ 'shape' => 'PromptOverrideConfiguration', ], 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'CreateAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agent', ], 'members' => [ 'agent' => [ 'shape' => 'Agent', ], ], ], 'CreateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceConfiguration', 'knowledgeBaseId', 'name', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'dataDeletionPolicy' => [ 'shape' => 'DataDeletionPolicy', ], 'dataSourceConfiguration' => [ 'shape' => 'DataSourceConfiguration', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'name' => [ 'shape' => 'Name', ], 'serverSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'vectorIngestionConfiguration' => [ 'shape' => 'VectorIngestionConfiguration', ], ], ], 'CreateDataSourceResponse' => [ 'type' => 'structure', 'required' => [ 'dataSource', ], 'members' => [ 'dataSource' => [ 'shape' => 'DataSource', ], ], ], 'CreateKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseConfiguration', 'name', 'roleArn', 'storageConfiguration', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseConfiguration' => [ 'shape' => 'KnowledgeBaseConfiguration', ], 'name' => [ 'shape' => 'Name', ], 'roleArn' => [ 'shape' => 'KnowledgeBaseRoleArn', ], 'storageConfiguration' => [ 'shape' => 'StorageConfiguration', ], 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'CreateKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBase', ], 'members' => [ 'knowledgeBase' => [ 'shape' => 'KnowledgeBase', ], ], ], 'CreationMode' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'OVERRIDDEN', ], ], 'CustomControlMethod' => [ 'type' => 'string', 'enum' => [ 'RETURN_CONTROL', ], ], 'DataDeletionPolicy' => [ 'type' => 'string', 'enum' => [ 'RETAIN', 'DELETE', ], ], 'DataSource' => [ 'type' => 'structure', 'required' => [ 'createdAt', 'dataSourceConfiguration', 'dataSourceId', 'knowledgeBaseId', 'name', 'status', 'updatedAt', ], 'members' => [ 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'dataDeletionPolicy' => [ 'shape' => 'DataDeletionPolicy', ], 'dataSourceConfiguration' => [ 'shape' => 'DataSourceConfiguration', ], 'dataSourceId' => [ 'shape' => 'Id', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'name' => [ 'shape' => 'Name', ], 'serverSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'status' => [ 'shape' => 'DataSourceStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], 'vectorIngestionConfiguration' => [ 'shape' => 'VectorIngestionConfiguration', ], ], ], 'DataSourceConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 's3Configuration' => [ 'shape' => 'S3DataSourceConfiguration', ], 'type' => [ 'shape' => 'DataSourceType', ], ], ], 'DataSourceStatus' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'DELETING', 'DELETE_UNSUCCESSFUL', ], ], 'DataSourceSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceSummary', ], ], 'DataSourceSummary' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', 'name', 'status', 'updatedAt', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'DataSourceStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'DataSourceType' => [ 'type' => 'string', 'enum' => [ 'S3', ], ], 'DateTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'DeleteAgentActionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'agentId', 'agentVersion', ], 'members' => [ 'actionGroupId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'actionGroupId', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'skipResourceInUseCheck' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'skipResourceInUseCheck', ], ], ], 'DeleteAgentActionGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteAgentAliasRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], ], ], 'DeleteAgentAliasResponse' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentAliasStatus', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', ], 'agentAliasStatus' => [ 'shape' => 'AgentAliasStatus', ], 'agentId' => [ 'shape' => 'Id', ], ], ], 'DeleteAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'skipResourceInUseCheck' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'skipResourceInUseCheck', ], ], ], 'DeleteAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentStatus', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], ], ], 'DeleteAgentVersionRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'NumericalVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'skipResourceInUseCheck' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'skipResourceInUseCheck', ], ], ], 'DeleteAgentVersionResponse' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentStatus', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'agentVersion' => [ 'shape' => 'NumericalVersion', ], ], ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', 'status', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'status' => [ 'shape' => 'DataSourceStatus', ], ], ], 'DeleteKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'DeleteKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'status', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'status' => [ 'shape' => 'KnowledgeBaseStatus', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'DisassociateAgentKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'knowledgeBaseId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'DisassociateAgentKnowledgeBaseResponse' => [ 'type' => 'structure', 'members' => [], ], 'DraftVersion' => [ 'type' => 'string', 'max' => 5, 'min' => 5, 'pattern' => '^DRAFT$', ], 'FailureReason' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'FailureReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureReason', ], 'max' => 2048, 'min' => 0, ], 'FieldName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'FixedSizeChunkingConfiguration' => [ 'type' => 'structure', 'required' => [ 'maxTokens', 'overlapPercentage', ], 'members' => [ 'maxTokens' => [ 'shape' => 'FixedSizeChunkingConfigurationMaxTokensInteger', ], 'overlapPercentage' => [ 'shape' => 'FixedSizeChunkingConfigurationOverlapPercentageInteger', ], ], ], 'FixedSizeChunkingConfigurationMaxTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'FixedSizeChunkingConfigurationOverlapPercentageInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 99, 'min' => 1, ], 'Function' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'description' => [ 'shape' => 'FunctionDescription', ], 'name' => [ 'shape' => 'Name', ], 'parameters' => [ 'shape' => 'ParameterMap', ], ], ], 'FunctionDescription' => [ 'type' => 'string', 'max' => 1200, 'min' => 1, ], 'FunctionSchema' => [ 'type' => 'structure', 'members' => [ 'functions' => [ 'shape' => 'Functions', ], ], 'union' => true, ], 'Functions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Function', ], ], 'GetAgentActionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'agentId', 'agentVersion', ], 'members' => [ 'actionGroupId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'actionGroupId', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'Version', 'location' => 'uri', 'locationName' => 'agentVersion', ], ], ], 'GetAgentActionGroupResponse' => [ 'type' => 'structure', 'required' => [ 'agentActionGroup', ], 'members' => [ 'agentActionGroup' => [ 'shape' => 'AgentActionGroup', ], ], ], 'GetAgentAliasRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], ], ], 'GetAgentAliasResponse' => [ 'type' => 'structure', 'required' => [ 'agentAlias', ], 'members' => [ 'agentAlias' => [ 'shape' => 'AgentAlias', ], ], ], 'GetAgentKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'knowledgeBaseId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'Version', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'GetAgentKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'agentKnowledgeBase', ], 'members' => [ 'agentKnowledgeBase' => [ 'shape' => 'AgentKnowledgeBase', ], ], ], 'GetAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], ], ], 'GetAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agent', ], 'members' => [ 'agent' => [ 'shape' => 'Agent', ], ], ], 'GetAgentVersionRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'NumericalVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], ], ], 'GetAgentVersionResponse' => [ 'type' => 'structure', 'required' => [ 'agentVersion', ], 'members' => [ 'agentVersion' => [ 'shape' => 'AgentVersion', ], ], ], 'GetDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'GetDataSourceResponse' => [ 'type' => 'structure', 'required' => [ 'dataSource', ], 'members' => [ 'dataSource' => [ 'shape' => 'DataSource', ], ], ], 'GetIngestionJobRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'ingestionJobId', 'knowledgeBaseId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'ingestionJobId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'ingestionJobId', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'GetIngestionJobResponse' => [ 'type' => 'structure', 'required' => [ 'ingestionJob', ], 'members' => [ 'ingestionJob' => [ 'shape' => 'IngestionJob', ], ], ], 'GetKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'GetKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBase', ], 'members' => [ 'knowledgeBase' => [ 'shape' => 'KnowledgeBase', ], ], ], 'GuardrailConfiguration' => [ 'type' => 'structure', 'members' => [ 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', ], ], ], 'GuardrailIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$', ], 'GuardrailVersion' => [ 'type' => 'string', 'pattern' => '^(([0-9]{1,8})|(DRAFT))$', ], 'Id' => [ 'type' => 'string', 'pattern' => '^[0-9a-zA-Z]{10}$', ], 'InferenceConfiguration' => [ 'type' => 'structure', 'members' => [ 'maximumLength' => [ 'shape' => 'MaximumLength', ], 'stopSequences' => [ 'shape' => 'StopSequences', ], 'temperature' => [ 'shape' => 'Temperature', ], 'topK' => [ 'shape' => 'TopK', ], 'topP' => [ 'shape' => 'TopP', ], ], ], 'IngestionJob' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'ingestionJobId', 'knowledgeBaseId', 'startedAt', 'status', 'updatedAt', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'ingestionJobId' => [ 'shape' => 'Id', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'startedAt' => [ 'shape' => 'DateTimestamp', ], 'statistics' => [ 'shape' => 'IngestionJobStatistics', ], 'status' => [ 'shape' => 'IngestionJobStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'IngestionJobFilter' => [ 'type' => 'structure', 'required' => [ 'attribute', 'operator', 'values', ], 'members' => [ 'attribute' => [ 'shape' => 'IngestionJobFilterAttribute', ], 'operator' => [ 'shape' => 'IngestionJobFilterOperator', ], 'values' => [ 'shape' => 'IngestionJobFilterValues', ], ], ], 'IngestionJobFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'STATUS', ], ], 'IngestionJobFilterOperator' => [ 'type' => 'string', 'enum' => [ 'EQ', ], ], 'IngestionJobFilterValue' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'pattern' => '^.*$', ], 'IngestionJobFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'IngestionJobFilterValue', ], 'max' => 10, 'min' => 0, ], 'IngestionJobFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'IngestionJobFilter', ], 'max' => 1, 'min' => 1, ], 'IngestionJobSortBy' => [ 'type' => 'structure', 'required' => [ 'attribute', 'order', ], 'members' => [ 'attribute' => [ 'shape' => 'IngestionJobSortByAttribute', ], 'order' => [ 'shape' => 'SortOrder', ], ], ], 'IngestionJobSortByAttribute' => [ 'type' => 'string', 'enum' => [ 'STATUS', 'STARTED_AT', ], ], 'IngestionJobStatistics' => [ 'type' => 'structure', 'members' => [ 'numberOfDocumentsDeleted' => [ 'shape' => 'PrimitiveLong', ], 'numberOfDocumentsFailed' => [ 'shape' => 'PrimitiveLong', ], 'numberOfDocumentsScanned' => [ 'shape' => 'PrimitiveLong', ], 'numberOfMetadataDocumentsModified' => [ 'shape' => 'PrimitiveLong', ], 'numberOfMetadataDocumentsScanned' => [ 'shape' => 'PrimitiveLong', ], 'numberOfModifiedDocumentsIndexed' => [ 'shape' => 'PrimitiveLong', ], 'numberOfNewDocumentsIndexed' => [ 'shape' => 'PrimitiveLong', ], ], ], 'IngestionJobStatus' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'IN_PROGRESS', 'COMPLETE', 'FAILED', ], ], 'IngestionJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'IngestionJobSummary', ], ], 'IngestionJobSummary' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'ingestionJobId', 'knowledgeBaseId', 'startedAt', 'status', 'updatedAt', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', ], 'description' => [ 'shape' => 'Description', ], 'ingestionJobId' => [ 'shape' => 'Id', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'startedAt' => [ 'shape' => 'DateTimestamp', ], 'statistics' => [ 'shape' => 'IngestionJobStatistics', ], 'status' => [ 'shape' => 'IngestionJobStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'Instruction' => [ 'type' => 'string', 'max' => 4000, 'min' => 40, 'sensitive' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$', ], 'KnowledgeBase' => [ 'type' => 'structure', 'required' => [ 'createdAt', 'knowledgeBaseArn', 'knowledgeBaseConfiguration', 'knowledgeBaseId', 'name', 'roleArn', 'status', 'storageConfiguration', 'updatedAt', ], 'members' => [ 'createdAt' => [ 'shape' => 'DateTimestamp', ], 'description' => [ 'shape' => 'Description', ], 'failureReasons' => [ 'shape' => 'FailureReasons', ], 'knowledgeBaseArn' => [ 'shape' => 'KnowledgeBaseArn', ], 'knowledgeBaseConfiguration' => [ 'shape' => 'KnowledgeBaseConfiguration', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'name' => [ 'shape' => 'Name', ], 'roleArn' => [ 'shape' => 'KnowledgeBaseRoleArn', ], 'status' => [ 'shape' => 'KnowledgeBaseStatus', ], 'storageConfiguration' => [ 'shape' => 'StorageConfiguration', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'KnowledgeBaseArn' => [ 'type' => 'string', 'max' => 128, 'min' => 0, 'pattern' => '^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$', ], 'KnowledgeBaseConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'KnowledgeBaseType', ], 'vectorKnowledgeBaseConfiguration' => [ 'shape' => 'VectorKnowledgeBaseConfiguration', ], ], ], 'KnowledgeBaseRoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$', ], 'KnowledgeBaseState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'KnowledgeBaseStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'DELETING', 'UPDATING', 'FAILED', 'DELETE_UNSUCCESSFUL', ], ], 'KnowledgeBaseStorageType' => [ 'type' => 'string', 'enum' => [ 'OPENSEARCH_SERVERLESS', 'PINECONE', 'REDIS_ENTERPRISE_CLOUD', 'RDS', 'MONGO_DB_ATLAS', ], ], 'KnowledgeBaseSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'KnowledgeBaseSummary', ], ], 'KnowledgeBaseSummary' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'name', 'status', 'updatedAt', ], 'members' => [ 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'KnowledgeBaseStatus', ], 'updatedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'KnowledgeBaseType' => [ 'type' => 'string', 'enum' => [ 'VECTOR', ], ], 'LambdaArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$', ], 'ListAgentActionGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'Version', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentActionGroupsResponse' => [ 'type' => 'structure', 'required' => [ 'actionGroupSummaries', ], 'members' => [ 'actionGroupSummaries' => [ 'shape' => 'ActionGroupSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentAliasesResponse' => [ 'type' => 'structure', 'required' => [ 'agentAliasSummaries', ], 'members' => [ 'agentAliasSummaries' => [ 'shape' => 'AgentAliasSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentKnowledgeBasesRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'Version', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentKnowledgeBasesResponse' => [ 'type' => 'structure', 'required' => [ 'agentKnowledgeBaseSummaries', ], 'members' => [ 'agentKnowledgeBaseSummaries' => [ 'shape' => 'AgentKnowledgeBaseSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'agentVersionSummaries', ], 'members' => [ 'agentVersionSummaries' => [ 'shape' => 'AgentVersionSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAgentsResponse' => [ 'type' => 'structure', 'required' => [ 'agentSummaries', ], 'members' => [ 'agentSummaries' => [ 'shape' => 'AgentSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'required' => [ 'dataSourceSummaries', ], 'members' => [ 'dataSourceSummaries' => [ 'shape' => 'DataSourceSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListIngestionJobsRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', ], 'members' => [ 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'filters' => [ 'shape' => 'IngestionJobFilters', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'sortBy' => [ 'shape' => 'IngestionJobSortBy', ], ], ], 'ListIngestionJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ingestionJobSummaries', ], 'members' => [ 'ingestionJobSummaries' => [ 'shape' => 'IngestionJobSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListKnowledgeBasesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListKnowledgeBasesResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseSummaries', ], 'members' => [ 'knowledgeBaseSummaries' => [ 'shape' => 'KnowledgeBaseSummaries', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TaggableResourcesArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 1000, 'min' => 1, ], 'MaximumLength' => [ 'type' => 'integer', 'box' => true, 'max' => 4096, 'min' => 0, ], 'ModelIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$', ], 'MongoDbAtlasCollectionName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^.*$', ], 'MongoDbAtlasConfiguration' => [ 'type' => 'structure', 'required' => [ 'collectionName', 'credentialsSecretArn', 'databaseName', 'endpoint', 'fieldMapping', 'vectorIndexName', ], 'members' => [ 'collectionName' => [ 'shape' => 'MongoDbAtlasCollectionName', ], 'credentialsSecretArn' => [ 'shape' => 'SecretArn', ], 'databaseName' => [ 'shape' => 'MongoDbAtlasDatabaseName', ], 'endpoint' => [ 'shape' => 'MongoDbAtlasEndpoint', ], 'endpointServiceName' => [ 'shape' => 'MongoDbAtlasEndpointServiceName', ], 'fieldMapping' => [ 'shape' => 'MongoDbAtlasFieldMapping', ], 'vectorIndexName' => [ 'shape' => 'MongoDbAtlasIndexName', ], ], ], 'MongoDbAtlasDatabaseName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^.*$', ], 'MongoDbAtlasEndpoint' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'MongoDbAtlasEndpointServiceName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$', ], 'MongoDbAtlasFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'textField', 'vectorField', ], 'members' => [ 'metadataField' => [ 'shape' => 'FieldName', ], 'textField' => [ 'shape' => 'FieldName', ], 'vectorField' => [ 'shape' => 'FieldName', ], ], ], 'MongoDbAtlasIndexName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'Name' => [ 'type' => 'string', 'pattern' => '^([0-9a-zA-Z][_-]?){1,100}$', ], 'NextToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^\\S*$', ], 'NonBlankString' => [ 'type' => 'string', 'pattern' => '^[\\s\\S]+$', ], 'NumericalVersion' => [ 'type' => 'string', 'pattern' => '^[0-9]{1,5}$', ], 'OpenSearchServerlessCollectionArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$', ], 'OpenSearchServerlessConfiguration' => [ 'type' => 'structure', 'required' => [ 'collectionArn', 'fieldMapping', 'vectorIndexName', ], 'members' => [ 'collectionArn' => [ 'shape' => 'OpenSearchServerlessCollectionArn', ], 'fieldMapping' => [ 'shape' => 'OpenSearchServerlessFieldMapping', ], 'vectorIndexName' => [ 'shape' => 'OpenSearchServerlessIndexName', ], ], ], 'OpenSearchServerlessFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'textField', 'vectorField', ], 'members' => [ 'metadataField' => [ 'shape' => 'FieldName', ], 'textField' => [ 'shape' => 'FieldName', ], 'vectorField' => [ 'shape' => 'FieldName', ], ], ], 'OpenSearchServerlessIndexName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'ParameterDescription' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'ParameterDetail' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'description' => [ 'shape' => 'ParameterDescription', ], 'required' => [ 'shape' => 'Boolean', ], 'type' => [ 'shape' => 'Type', ], ], ], 'ParameterMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'Name', ], 'value' => [ 'shape' => 'ParameterDetail', ], ], 'Payload' => [ 'type' => 'string', 'sensitive' => true, ], 'PineconeConfiguration' => [ 'type' => 'structure', 'required' => [ 'connectionString', 'credentialsSecretArn', 'fieldMapping', ], 'members' => [ 'connectionString' => [ 'shape' => 'PineconeConnectionString', ], 'credentialsSecretArn' => [ 'shape' => 'SecretArn', ], 'fieldMapping' => [ 'shape' => 'PineconeFieldMapping', ], 'namespace' => [ 'shape' => 'PineconeNamespace', ], ], ], 'PineconeConnectionString' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'PineconeFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'textField', ], 'members' => [ 'metadataField' => [ 'shape' => 'FieldName', ], 'textField' => [ 'shape' => 'FieldName', ], ], ], 'PineconeNamespace' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'PrepareAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], ], ], 'PrepareAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentStatus', 'agentVersion', 'preparedAt', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', ], 'agentStatus' => [ 'shape' => 'AgentStatus', ], 'agentVersion' => [ 'shape' => 'Version', ], 'preparedAt' => [ 'shape' => 'DateTimestamp', ], ], ], 'PrimitiveLong' => [ 'type' => 'long', ], 'PromptConfiguration' => [ 'type' => 'structure', 'members' => [ 'basePromptTemplate' => [ 'shape' => 'BasePromptTemplate', ], 'inferenceConfiguration' => [ 'shape' => 'InferenceConfiguration', ], 'parserMode' => [ 'shape' => 'CreationMode', ], 'promptCreationMode' => [ 'shape' => 'CreationMode', ], 'promptState' => [ 'shape' => 'PromptState', ], 'promptType' => [ 'shape' => 'PromptType', ], ], ], 'PromptConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'PromptConfiguration', ], 'max' => 10, 'min' => 0, ], 'PromptOverrideConfiguration' => [ 'type' => 'structure', 'required' => [ 'promptConfigurations', ], 'members' => [ 'overrideLambda' => [ 'shape' => 'LambdaArn', ], 'promptConfigurations' => [ 'shape' => 'PromptConfigurations', ], ], 'sensitive' => true, ], 'PromptState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'PromptType' => [ 'type' => 'string', 'enum' => [ 'PRE_PROCESSING', 'ORCHESTRATION', 'POST_PROCESSING', 'KNOWLEDGE_BASE_RESPONSE_GENERATION', ], ], 'ProvisionedModelIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^((([0-9a-zA-Z][_-]?){1,63})|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$', ], 'RdsArn' => [ 'type' => 'string', 'pattern' => '^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$', ], 'RdsConfiguration' => [ 'type' => 'structure', 'required' => [ 'credentialsSecretArn', 'databaseName', 'fieldMapping', 'resourceArn', 'tableName', ], 'members' => [ 'credentialsSecretArn' => [ 'shape' => 'SecretArn', ], 'databaseName' => [ 'shape' => 'RdsDatabaseName', ], 'fieldMapping' => [ 'shape' => 'RdsFieldMapping', ], 'resourceArn' => [ 'shape' => 'RdsArn', ], 'tableName' => [ 'shape' => 'RdsTableName', ], ], ], 'RdsDatabaseName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^[a-zA-Z0-9_\\-]+$', ], 'RdsFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'primaryKeyField', 'textField', 'vectorField', ], 'members' => [ 'metadataField' => [ 'shape' => 'ColumnName', ], 'primaryKeyField' => [ 'shape' => 'ColumnName', ], 'textField' => [ 'shape' => 'ColumnName', ], 'vectorField' => [ 'shape' => 'ColumnName', ], ], ], 'RdsTableName' => [ 'type' => 'string', 'max' => 63, 'min' => 0, 'pattern' => '^[a-zA-Z0-9_\\.\\-]+$', ], 'RecommendedAction' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'RecommendedActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendedAction', ], 'max' => 2048, 'min' => 0, ], 'RedisEnterpriseCloudConfiguration' => [ 'type' => 'structure', 'required' => [ 'credentialsSecretArn', 'endpoint', 'fieldMapping', 'vectorIndexName', ], 'members' => [ 'credentialsSecretArn' => [ 'shape' => 'SecretArn', ], 'endpoint' => [ 'shape' => 'RedisEnterpriseCloudEndpoint', ], 'fieldMapping' => [ 'shape' => 'RedisEnterpriseCloudFieldMapping', ], 'vectorIndexName' => [ 'shape' => 'RedisEnterpriseCloudIndexName', ], ], ], 'RedisEnterpriseCloudEndpoint' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'RedisEnterpriseCloudFieldMapping' => [ 'type' => 'structure', 'required' => [ 'metadataField', 'textField', 'vectorField', ], 'members' => [ 'metadataField' => [ 'shape' => 'FieldName', ], 'textField' => [ 'shape' => 'FieldName', ], 'vectorField' => [ 'shape' => 'FieldName', ], ], ], 'RedisEnterpriseCloudIndexName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^.*$', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'S3BucketArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$', ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$', ], 'S3DataSourceConfiguration' => [ 'type' => 'structure', 'required' => [ 'bucketArn', ], 'members' => [ 'bucketArn' => [ 'shape' => 'S3BucketArn', ], 'bucketOwnerAccountId' => [ 'shape' => 'BucketOwnerAccountId', ], 'inclusionPrefixes' => [ 'shape' => 'S3Prefixes', ], ], ], 'S3Identifier' => [ 'type' => 'structure', 'members' => [ 's3BucketName' => [ 'shape' => 'S3BucketName', ], 's3ObjectKey' => [ 'shape' => 'S3ObjectKey', ], ], ], 'S3ObjectKey' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[\\.\\-\\!\\*\\_\\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\\'\\(\\)\\/a-zA-Z0-9]*$', ], 'S3Prefix' => [ 'type' => 'string', 'max' => 300, 'min' => 1, ], 'S3Prefixes' => [ 'type' => 'list', 'member' => [ 'shape' => 'S3Prefix', ], 'max' => 1, 'min' => 1, ], 'SecretArn' => [ 'type' => 'string', 'pattern' => '^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$', ], 'ServerSideEncryptionConfiguration' => [ 'type' => 'structure', 'members' => [ 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'SessionTTL' => [ 'type' => 'integer', 'box' => true, 'max' => 3600, 'min' => 60, ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'StartIngestionJobRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceId', 'knowledgeBaseId', ], 'members' => [ 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], ], ], 'StartIngestionJobResponse' => [ 'type' => 'structure', 'required' => [ 'ingestionJob', ], 'members' => [ 'ingestionJob' => [ 'shape' => 'IngestionJob', ], ], ], 'StopSequences' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 4, 'min' => 0, ], 'StorageConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'mongoDbAtlasConfiguration' => [ 'shape' => 'MongoDbAtlasConfiguration', ], 'opensearchServerlessConfiguration' => [ 'shape' => 'OpenSearchServerlessConfiguration', ], 'pineconeConfiguration' => [ 'shape' => 'PineconeConfiguration', ], 'rdsConfiguration' => [ 'shape' => 'RdsConfiguration', ], 'redisEnterpriseCloudConfiguration' => [ 'shape' => 'RedisEnterpriseCloudConfiguration', ], 'type' => [ 'shape' => 'KnowledgeBaseStorageType', ], ], ], 'String' => [ 'type' => 'string', ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\s._:/=+@-]*$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TaggableResourcesArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagsMap', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^[a-zA-Z0-9\\s._:/=+@-]*$', ], 'TaggableResourcesArn' => [ 'type' => 'string', 'max' => 1011, 'min' => 20, 'pattern' => '(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$)', ], 'TagsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], 'Temperature' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'TopK' => [ 'type' => 'integer', 'box' => true, 'max' => 500, 'min' => 0, ], 'TopP' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'Type' => [ 'type' => 'string', 'enum' => [ 'string', 'number', 'integer', 'boolean', 'array', ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'TaggableResourcesArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAgentActionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'actionGroupId', 'actionGroupName', 'agentId', 'agentVersion', ], 'members' => [ 'actionGroupExecutor' => [ 'shape' => 'ActionGroupExecutor', ], 'actionGroupId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'actionGroupId', ], 'actionGroupName' => [ 'shape' => 'Name', ], 'actionGroupState' => [ 'shape' => 'ActionGroupState', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'apiSchema' => [ 'shape' => 'APISchema', ], 'description' => [ 'shape' => 'Description', ], 'functionSchema' => [ 'shape' => 'FunctionSchema', ], 'parentActionGroupSignature' => [ 'shape' => 'ActionGroupSignature', ], ], ], 'UpdateAgentActionGroupResponse' => [ 'type' => 'structure', 'required' => [ 'agentActionGroup', ], 'members' => [ 'agentActionGroup' => [ 'shape' => 'AgentActionGroup', ], ], ], 'UpdateAgentAliasRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentAliasName', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentAliasName' => [ 'shape' => 'Name', ], 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'description' => [ 'shape' => 'Description', ], 'routingConfiguration' => [ 'shape' => 'AgentAliasRoutingConfiguration', ], ], ], 'UpdateAgentAliasResponse' => [ 'type' => 'structure', 'required' => [ 'agentAlias', ], 'members' => [ 'agentAlias' => [ 'shape' => 'AgentAlias', ], ], ], 'UpdateAgentKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentVersion', 'knowledgeBaseId', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentVersion' => [ 'shape' => 'DraftVersion', 'location' => 'uri', 'locationName' => 'agentVersion', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'knowledgeBaseState' => [ 'shape' => 'KnowledgeBaseState', ], ], ], 'UpdateAgentKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'agentKnowledgeBase', ], 'members' => [ 'agentKnowledgeBase' => [ 'shape' => 'AgentKnowledgeBase', ], ], ], 'UpdateAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentId', 'agentName', 'agentResourceRoleArn', 'foundationModel', ], 'members' => [ 'agentId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'agentId', ], 'agentName' => [ 'shape' => 'Name', ], 'agentResourceRoleArn' => [ 'shape' => 'AgentRoleArn', ], 'customerEncryptionKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'description' => [ 'shape' => 'Description', ], 'foundationModel' => [ 'shape' => 'ModelIdentifier', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'idleSessionTTLInSeconds' => [ 'shape' => 'SessionTTL', ], 'instruction' => [ 'shape' => 'Instruction', ], 'promptOverrideConfiguration' => [ 'shape' => 'PromptOverrideConfiguration', ], ], ], 'UpdateAgentResponse' => [ 'type' => 'structure', 'required' => [ 'agent', ], 'members' => [ 'agent' => [ 'shape' => 'Agent', ], ], ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'dataSourceConfiguration', 'dataSourceId', 'knowledgeBaseId', 'name', ], 'members' => [ 'dataDeletionPolicy' => [ 'shape' => 'DataDeletionPolicy', ], 'dataSourceConfiguration' => [ 'shape' => 'DataSourceConfiguration', ], 'dataSourceId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'dataSourceId', ], 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'name' => [ 'shape' => 'Name', ], 'serverSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], 'vectorIngestionConfiguration' => [ 'shape' => 'VectorIngestionConfiguration', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'required' => [ 'dataSource', ], 'members' => [ 'dataSource' => [ 'shape' => 'DataSource', ], ], ], 'UpdateKnowledgeBaseRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseConfiguration', 'knowledgeBaseId', 'name', 'roleArn', 'storageConfiguration', ], 'members' => [ 'description' => [ 'shape' => 'Description', ], 'knowledgeBaseConfiguration' => [ 'shape' => 'KnowledgeBaseConfiguration', ], 'knowledgeBaseId' => [ 'shape' => 'Id', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'name' => [ 'shape' => 'Name', ], 'roleArn' => [ 'shape' => 'KnowledgeBaseRoleArn', ], 'storageConfiguration' => [ 'shape' => 'StorageConfiguration', ], ], ], 'UpdateKnowledgeBaseResponse' => [ 'type' => 'structure', 'required' => [ 'knowledgeBase', ], 'members' => [ 'knowledgeBase' => [ 'shape' => 'KnowledgeBase', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'fieldList' => [ 'shape' => 'ValidationExceptionFieldList', ], 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'message', 'name', ], 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'name' => [ 'shape' => 'NonBlankString', ], ], ], 'ValidationExceptionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'VectorIngestionConfiguration' => [ 'type' => 'structure', 'members' => [ 'chunkingConfiguration' => [ 'shape' => 'ChunkingConfiguration', ], ], ], 'VectorKnowledgeBaseConfiguration' => [ 'type' => 'structure', 'required' => [ 'embeddingModelArn', ], 'members' => [ 'embeddingModelArn' => [ 'shape' => 'BedrockEmbeddingModelArn', ], ], ], 'Version' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$', ], ],]; diff --git a/src/data/bedrock-agent/2023-06-05/docs-2.json b/src/data/bedrock-agent/2023-06-05/docs-2.json index f425500080..3db0377b57 100644 --- a/src/data/bedrock-agent/2023-06-05/docs-2.json +++ b/src/data/bedrock-agent/2023-06-05/docs-2.json @@ -274,7 +274,7 @@ "BasePromptTemplate": { "base": null, "refs": { - "PromptConfiguration$basePromptTemplate": "Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.
" + "PromptConfiguration$basePromptTemplate": "Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" } }, "BedrockEmbeddingModelArn": { @@ -760,6 +760,29 @@ "refs": { } }, + "GuardrailConfiguration": { + "base": "The details of the guardrails configuration.
", + "refs": { + "Agent$guardrailConfiguration": "The guardrails configuration assigned to the agent.
", + "AgentSummary$guardrailConfiguration": "The details of the guardrails configuration in the agent summary.
", + "AgentVersion$guardrailConfiguration": "The guardrails configuration assigned to the agent version.
", + "AgentVersionSummary$guardrailConfiguration": "The details of the guardrails configuration in the agent version summary.
", + "CreateAgentRequest$guardrailConfiguration": "The unique Guardrail configuration assigned to the agent when it is created.
", + "UpdateAgentRequest$guardrailConfiguration": "The unique Guardrail configuration assigned to the agent when it is updated.
" + } + }, + "GuardrailIdentifier": { + "base": null, + "refs": { + "GuardrailConfiguration$guardrailIdentifier": "The guardrails identifier assigned to the guardrails configuration.
" + } + }, + "GuardrailVersion": { + "base": null, + "refs": { + "GuardrailConfiguration$guardrailVersion": "The guardrails version assigned to the guardrails configuration.
" + } + }, "Id": { "base": null, "refs": { @@ -1027,7 +1050,7 @@ "base": null, "refs": { "ActionGroupExecutor$lambda": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
", - "PromptOverrideConfiguration$overrideLambda": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Agents for Amazon Bedrock.
Describes the API operations for creating and managing Amazon Bedrock agents.
', 'operations' => [ 'AssociateAgentKnowledgeBase' => 'Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
Specify the following fields for security purposes.
agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn\'t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
Creates an alias of an agent that can be used to deploy the agent.
', 'CreateDataSource' => 'Sets up a data source to be added to a knowledge base.
You can\'t change the chunkingConfiguration after you create the data source.
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
Provide the name and an optional description.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
Provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
Deletes an agent.
', 'DeleteAgentActionGroup' => 'Deletes an action group in an agent.
', 'DeleteAgentAlias' => 'Deletes an alias of an agent.
', 'DeleteAgentVersion' => 'Deletes a version of an agent.
', 'DeleteDataSource' => 'Deletes a data source from a knowledge base.
', 'DeleteKnowledgeBase' => 'Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
', 'DisassociateAgentKnowledgeBase' => 'Disassociates a knowledge base from an agent.
', 'GetAgent' => 'Gets information about an agent.
', 'GetAgentActionGroup' => 'Gets information about an action group for an agent.
', 'GetAgentAlias' => 'Gets information about an alias of an agent.
', 'GetAgentKnowledgeBase' => 'Gets information about a knowledge base associated with an agent.
', 'GetAgentVersion' => 'Gets details about a version of an agent.
', 'GetDataSource' => 'Gets information about a data source.
', 'GetIngestionJob' => 'Gets information about a ingestion job, in which a data source is added to a knowledge base.
', 'GetKnowledgeBase' => 'Gets information about a knoweldge base.
', 'ListAgentActionGroups' => 'Lists the action groups for an agent and information about each one.
', 'ListAgentAliases' => 'Lists the aliases of an agent and information about each one.
', 'ListAgentKnowledgeBases' => 'Lists knowledge bases associated with an agent and information about each one.
', 'ListAgentVersions' => 'Lists the versions of an agent and information about each version.
', 'ListAgents' => 'Lists the agents belonging to an account and information about each agent.
', 'ListDataSources' => 'Lists the data sources in a knowledge base and information about each one.
', 'ListIngestionJobs' => 'Lists the ingestion jobs for a data source and information about each of them.
', 'ListKnowledgeBases' => 'Lists the knowledge bases in an account and information about each of them.
', 'ListTagsForResource' => 'List all the tags for the resource you specify.
', 'PrepareAgent' => 'Creates a DRAFT version of the agent that can be used for internal testing.
Begins an ingestion job, in which a data source is added to a knowledge base.
', 'TagResource' => 'Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
', 'UntagResource' => 'Remove tags from a resource.
', 'UpdateAgent' => 'Updates the configuration of an agent.
', 'UpdateAgentActionGroup' => 'Updates the configuration for an action group for an agent.
', 'UpdateAgentAlias' => 'Updates configurations for an alias of an agent.
', 'UpdateAgentKnowledgeBase' => 'Updates the configuration for a knowledge base that has been associated with an agent.
', 'UpdateDataSource' => 'Updates configurations for a data source.
You can\'t change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
You can change the following fields:
name
description
roleArn
You can\'t change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
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.
', 'CreateAgentActionGroupRequest$apiSchema' => '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.
', 'UpdateAgentActionGroupRequest$apiSchema' => '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.
', ], ], 'AccessDeniedException' => [ 'base' => 'The request is denied because of missing access permissions.
', 'refs' => [], ], 'ActionGroupExecutor' => [ 'base' => 'Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
', 'refs' => [ 'AgentActionGroup$actionGroupExecutor' => 'The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
', 'CreateAgentActionGroupRequest$actionGroupExecutor' => 'The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
', 'UpdateAgentActionGroupRequest$actionGroupExecutor' => 'The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
', ], ], 'ActionGroupSignature' => [ 'base' => NULL, 'refs' => [ 'AgentActionGroup$parentActionSignature' => 'If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn\'t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
', 'CreateAgentActionGroupRequest$parentActionGroupSignature' => 'To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn\'t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
', 'UpdateAgentActionGroupRequest$parentActionGroupSignature' => 'To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn\'t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
', ], ], 'ActionGroupState' => [ 'base' => NULL, 'refs' => [ 'ActionGroupSummary$actionGroupState' => 'Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
', 'AgentActionGroup$actionGroupState' => 'Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
', 'CreateAgentActionGroupRequest$actionGroupState' => 'Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
', 'UpdateAgentActionGroupRequest$actionGroupState' => 'Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
', ], ], 'ActionGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAgentActionGroupsResponse$actionGroupSummaries' => 'A list of objects, each of which contains information about an action group.
', ], ], 'ActionGroupSummary' => [ 'base' => 'Contains details about an action group.
', 'refs' => [ 'ActionGroupSummaries$member' => NULL, ], ], 'Agent' => [ 'base' => 'Contains details about an agent.
', 'refs' => [ 'CreateAgentResponse$agent' => 'Contains details about the agent created.
', 'GetAgentResponse$agent' => 'Contains details about the agent.
', 'UpdateAgentResponse$agent' => 'Contains details about the agent that was updated.
', ], ], 'AgentActionGroup' => [ 'base' => 'Contains details about an action group.
', 'refs' => [ 'CreateAgentActionGroupResponse$agentActionGroup' => 'Contains details about the action group that was created.
', 'GetAgentActionGroupResponse$agentActionGroup' => 'Contains details about the action group.
', 'UpdateAgentActionGroupResponse$agentActionGroup' => 'Contains details about the action group that was updated.
', ], ], 'AgentAlias' => [ 'base' => 'Contains details about an alias of an agent.
', 'refs' => [ 'CreateAgentAliasResponse$agentAlias' => 'Contains details about the alias that was created.
', 'GetAgentAliasResponse$agentAlias' => 'Contains information about the alias.
', 'UpdateAgentAliasResponse$agentAlias' => 'Contains details about the alias that was updated.
', ], ], 'AgentAliasArn' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$agentAliasArn' => 'The Amazon Resource Name (ARN) of the alias of the agent.
', ], ], 'AgentAliasHistoryEvent' => [ 'base' => 'Contains details about the history of the alias.
', 'refs' => [ 'AgentAliasHistoryEvents$member' => NULL, ], ], 'AgentAliasHistoryEvents' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$agentAliasHistoryEvents' => 'Contains details about the history of the alias.
', ], ], 'AgentAliasId' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$agentAliasId' => 'The unique identifier of the alias of the agent.
', 'AgentAliasSummary$agentAliasId' => 'Contains details about
', 'DeleteAgentAliasRequest$agentAliasId' => 'The unique identifier of the alias to delete.
', 'DeleteAgentAliasResponse$agentAliasId' => 'The unique identifier of the alias that was deleted.
', 'GetAgentAliasRequest$agentAliasId' => 'The unique identifier of the alias for which to get information.
', 'UpdateAgentAliasRequest$agentAliasId' => 'The unique identifier of the alias.
', ], ], 'AgentAliasRoutingConfiguration' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$routingConfiguration' => 'Contains details about the routing configuration of the alias.
', 'AgentAliasHistoryEvent$routingConfiguration' => 'Contains details about the version of the agent with which the alias is associated.
', 'AgentAliasSummary$routingConfiguration' => 'Contains details about the version of the agent with which the alias is associated.
', 'CreateAgentAliasRequest$routingConfiguration' => 'Contains details about the routing configuration of the alias.
', 'UpdateAgentAliasRequest$routingConfiguration' => 'Contains details about the routing configuration of the alias.
', ], ], 'AgentAliasRoutingConfigurationListItem' => [ 'base' => 'Contains details about the routing configuration of the alias.
', 'refs' => [ 'AgentAliasRoutingConfiguration$member' => NULL, ], ], 'AgentAliasStatus' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$agentAliasStatus' => 'The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent alias is being created.
PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
FAILED – The agent alias API operation failed.
UPDATING – The agent alias is being updated.
DELETING – The agent alias is being deleted.
The status of the alias.
', 'DeleteAgentAliasResponse$agentAliasStatus' => 'The status of the alias.
', ], ], 'AgentAliasSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAgentAliasesResponse$agentAliasSummaries' => 'A list of objects, each of which contains information about an alias of the agent.
', ], ], 'AgentAliasSummary' => [ 'base' => 'Contains details about an alias of an agent.
', 'refs' => [ 'AgentAliasSummaries$member' => NULL, ], ], 'AgentArn' => [ 'base' => NULL, 'refs' => [ 'Agent$agentArn' => 'The Amazon Resource Name (ARN) of the agent.
', 'AgentVersion$agentArn' => 'The Amazon Resource Name (ARN) of the agent that the version belongs to.
', ], ], 'AgentKnowledgeBase' => [ 'base' => 'Contains details about a knowledge base that is associated with an agent.
', 'refs' => [ 'AssociateAgentKnowledgeBaseResponse$agentKnowledgeBase' => 'Contains details about the knowledge base that has been associated with the agent.
', 'GetAgentKnowledgeBaseResponse$agentKnowledgeBase' => 'Contains details about a knowledge base attached to an agent.
', 'UpdateAgentKnowledgeBaseResponse$agentKnowledgeBase' => 'Contains details about the knowledge base that has been associated with an agent.
', ], ], 'AgentKnowledgeBaseSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAgentKnowledgeBasesResponse$agentKnowledgeBaseSummaries' => 'A list of objects, each of which contains information about a knowledge base associated with the agent.
', ], ], 'AgentKnowledgeBaseSummary' => [ 'base' => 'Contains details about a knowledge base associated with an agent.
', 'refs' => [ 'AgentKnowledgeBaseSummaries$member' => NULL, ], ], 'AgentRoleArn' => [ 'base' => NULL, 'refs' => [ 'Agent$agentResourceRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
', 'AgentVersion$agentResourceRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
', 'CreateAgentRequest$agentResourceRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
', 'UpdateAgentRequest$agentResourceRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
', ], ], 'AgentStatus' => [ 'base' => NULL, 'refs' => [ 'Agent$agentStatus' => 'The status of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent is being created.
PREPARING – The agent is being prepared.
PREPARED – The agent is prepared and ready to be invoked.
NOT_PREPARED – The agent has been created but not yet prepared.
FAILED – The agent API operation failed.
UPDATING – The agent is being updated.
DELETING – The agent is being deleted.
The status of the agent.
', 'AgentVersion$agentStatus' => 'The status of the agent that the version belongs to.
', 'AgentVersionSummary$agentStatus' => 'The status of the agent to which the version belongs.
', 'DeleteAgentResponse$agentStatus' => 'The status of the agent.
', 'DeleteAgentVersionResponse$agentStatus' => 'The status of the agent version.
', 'PrepareAgentResponse$agentStatus' => 'The status of the DRAFT version and whether it is ready for use.
A list of objects, each of which contains information about an agent.
', ], ], 'AgentSummary' => [ 'base' => 'Contains details about an agent.
', 'refs' => [ 'AgentSummaries$member' => NULL, ], ], 'AgentVersion' => [ 'base' => 'Contains details about a version of an agent.
', 'refs' => [ 'GetAgentVersionResponse$agentVersion' => 'Contains details about the version of the agent.
', ], ], 'AgentVersionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAgentVersionsResponse$agentVersionSummaries' => 'A list of objects, each of which contains information about a version of the agent.
', ], ], 'AgentVersionSummary' => [ 'base' => 'Contains details about a version of an agent.
', 'refs' => [ 'AgentVersionSummaries$member' => NULL, ], ], 'AssociateAgentKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateAgentKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'BasePromptTemplate' => [ 'base' => NULL, 'refs' => [ 'PromptConfiguration$basePromptTemplate' => 'Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.
', ], ], 'BedrockEmbeddingModelArn' => [ 'base' => NULL, 'refs' => [ 'VectorKnowledgeBaseConfiguration$embeddingModelArn' => 'The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'DeleteAgentActionGroupRequest$skipResourceInUseCheck' => 'By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
Whether the parameter is required for the agent to complete the function for action group invocation.
', ], ], 'BucketOwnerAccountId' => [ 'base' => NULL, 'refs' => [ 'S3DataSourceConfiguration$bucketOwnerAccountId' => 'The bucket account owner ID for the S3 bucket.
', ], ], 'ChunkingConfiguration' => [ 'base' => 'Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
', 'refs' => [ 'VectorIngestionConfiguration$chunkingConfiguration' => 'Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
', ], ], 'ChunkingStrategy' => [ 'base' => NULL, 'refs' => [ 'ChunkingConfiguration$chunkingStrategy' => 'Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.
NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'AgentActionGroup$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'AgentAlias$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateAgentActionGroupRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateAgentAliasRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateAgentRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateDataSourceRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateKnowledgeBaseRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'StartIngestionJobRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', ], ], 'ColumnName' => [ 'base' => NULL, 'refs' => [ 'RdsFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'RdsFieldMapping$primaryKeyField' => 'The name of the field in which Amazon Bedrock stores the ID for each entry.
', 'RdsFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'RdsFieldMapping$vectorField' => 'The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
', ], ], 'ConflictException' => [ 'base' => 'There was a conflict performing an operation.
', 'refs' => [], ], 'CreateAgentActionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentActionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationMode' => [ 'base' => NULL, 'refs' => [ 'PromptConfiguration$parserMode' => 'Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
The data deletion policy assigned to the data source.
', 'DataSource$dataDeletionPolicy' => 'The data deletion policy for a data source.
', 'UpdateDataSourceRequest$dataDeletionPolicy' => 'The data deletion policy of the updated data source.
', ], ], 'DataSource' => [ 'base' => 'Contains details about a data source.
', 'refs' => [ 'CreateDataSourceResponse$dataSource' => 'Contains details about the data source.
', 'GetDataSourceResponse$dataSource' => 'Contains details about the data source.
', 'UpdateDataSourceResponse$dataSource' => 'Contains details about the data source.
', ], ], 'DataSourceConfiguration' => [ 'base' => 'Contains details about how a data source is stored.
', 'refs' => [ 'CreateDataSourceRequest$dataSourceConfiguration' => 'Contains metadata about where the data source is stored.
', 'DataSource$dataSourceConfiguration' => 'Contains details about how the data source is stored.
', 'UpdateDataSourceRequest$dataSourceConfiguration' => 'Contains details about the storage configuration of the data source.
', ], ], 'DataSourceStatus' => [ 'base' => NULL, 'refs' => [ 'DataSource$status' => 'The status of the data source. The following statuses are possible:
Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.
The status of the data source.
', 'DeleteDataSourceResponse$status' => 'The status of the data source.
', ], ], 'DataSourceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$dataSourceSummaries' => 'A list of objects, each of which contains information about a data source.
', ], ], 'DataSourceSummary' => [ 'base' => 'Contains details about a data source.
', 'refs' => [ 'DataSourceSummaries$member' => NULL, ], ], 'DataSourceType' => [ 'base' => NULL, 'refs' => [ 'DataSourceConfiguration$type' => 'The type of storage for the data source.
', ], ], 'DateTimestamp' => [ 'base' => NULL, 'refs' => [ 'ActionGroupSummary$updatedAt' => 'The time at which the action group was last updated.
', 'Agent$createdAt' => 'The time at which the agent was created.
', 'Agent$preparedAt' => 'The time at which the agent was last prepared.
', 'Agent$updatedAt' => 'The time at which the agent was last updated.
', 'AgentActionGroup$createdAt' => 'The time at which the action group was created.
', 'AgentActionGroup$updatedAt' => 'The time at which the action group was last updated.
', 'AgentAlias$createdAt' => 'The time at which the alias of the agent was created.
', 'AgentAlias$updatedAt' => 'The time at which the alias was last updated.
', 'AgentAliasHistoryEvent$endDate' => 'The date that the alias stopped being associated to the version in the routingConfiguration object
The date that the alias began being associated to the version in the routingConfiguration object.
The time at which the alias of the agent was created.
', 'AgentAliasSummary$updatedAt' => 'The time at which the alias was last updated.
', 'AgentKnowledgeBase$createdAt' => 'The time at which the association between the agent and the knowledge base was created.
', 'AgentKnowledgeBase$updatedAt' => 'The time at which the association between the agent and the knowledge base was last updated.
', 'AgentKnowledgeBaseSummary$updatedAt' => 'The time at which the knowledge base associated with an agent was last updated.
', 'AgentSummary$updatedAt' => 'The time at which the agent was last updated.
', 'AgentVersion$createdAt' => 'The time at which the version was created.
', 'AgentVersion$updatedAt' => 'The time at which the version was last updated.
', 'AgentVersionSummary$createdAt' => 'The time at which the version was created.
', 'AgentVersionSummary$updatedAt' => 'The time at which the version was last updated.
', 'DataSource$createdAt' => 'The time at which the data source was created.
', 'DataSource$updatedAt' => 'The time at which the data source was last updated.
', 'DataSourceSummary$updatedAt' => 'The time at which the data source was last updated.
', 'IngestionJob$startedAt' => 'The time at which the ingestion job started.
', 'IngestionJob$updatedAt' => 'The time at which the ingestion job was last updated.
', 'IngestionJobSummary$startedAt' => 'The time at which the ingestion job was started.
', 'IngestionJobSummary$updatedAt' => 'The time at which the ingestion job was last updated.
', 'KnowledgeBase$createdAt' => 'The time at which the knowledge base was created.
', 'KnowledgeBase$updatedAt' => 'The time at which the knowledge base was last updated.
', 'KnowledgeBaseSummary$updatedAt' => 'The time at which the knowledge base was last updated.
', 'PrepareAgentResponse$preparedAt' => 'The time at which the DRAFT version of the agent was last prepared.
The description of the action group.
', 'Agent$description' => 'The description of the agent.
', 'AgentActionGroup$description' => 'The description of the action group.
', 'AgentAlias$description' => 'The description of the alias of the agent.
', 'AgentAliasSummary$description' => 'The description of the alias.
', 'AgentKnowledgeBase$description' => 'The description of the association between the agent and the knowledge base.
', 'AgentKnowledgeBaseSummary$description' => 'The description of the knowledge base associated with an agent.
', 'AgentSummary$description' => 'The description of the agent.
', 'AgentVersion$description' => 'The description of the version.
', 'AgentVersionSummary$description' => 'The description of the version of the agent.
', 'AssociateAgentKnowledgeBaseRequest$description' => 'A description of what the agent should use the knowledge base for.
', 'CreateAgentActionGroupRequest$description' => 'A description of the action group.
', 'CreateAgentAliasRequest$description' => 'A description of the alias of the agent.
', 'CreateAgentRequest$description' => 'A description of the agent.
', 'CreateDataSourceRequest$description' => 'A description of the data source.
', 'CreateKnowledgeBaseRequest$description' => 'A description of the knowledge base.
', 'DataSource$description' => 'The description of the data source.
', 'DataSourceSummary$description' => 'The description of the data source.
', 'IngestionJob$description' => 'The description of the ingestion job.
', 'IngestionJobSummary$description' => 'The description of the ingestion job.
', 'KnowledgeBase$description' => 'The description of the knowledge base.
', 'KnowledgeBaseSummary$description' => 'The description of the knowledge base.
', 'StartIngestionJobRequest$description' => 'A description of the ingestion job.
', 'UpdateAgentActionGroupRequest$description' => 'Specifies a new name for the action group.
', 'UpdateAgentAliasRequest$description' => 'Specifies a new description for the alias.
', 'UpdateAgentKnowledgeBaseRequest$description' => 'Specifies a new description for the knowledge base associated with an agent.
', 'UpdateAgentRequest$description' => 'Specifies a new description of the agent.
', 'UpdateDataSourceRequest$description' => 'Specifies a new description for the data source.
', 'UpdateKnowledgeBaseRequest$description' => 'Specifies a new description for the knowledge base.
', ], ], 'DisassociateAgentKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateAgentKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'DraftVersion' => [ 'base' => NULL, 'refs' => [ 'Agent$agentVersion' => 'The version of the agent.
', 'AssociateAgentKnowledgeBaseRequest$agentVersion' => 'The version of the agent with which you want to associate the knowledge base.
', 'CreateAgentActionGroupRequest$agentVersion' => 'The version of the agent for which to create the action group.
', 'DeleteAgentActionGroupRequest$agentVersion' => 'The version of the agent that the action group belongs to.
', 'DisassociateAgentKnowledgeBaseRequest$agentVersion' => 'The version of the agent from which to disassociate the knowledge base.
', 'UpdateAgentActionGroupRequest$agentVersion' => 'The unique identifier of the agent version for which to update the action group.
', 'UpdateAgentKnowledgeBaseRequest$agentVersion' => 'The version of the agent associated with the knowledge base that you want to update.
', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'FailureReasons$member' => NULL, ], ], 'FailureReasons' => [ 'base' => NULL, 'refs' => [ 'Agent$failureReasons' => 'Contains reasons that the agent-related API that you invoked failed.
', 'AgentAlias$failureReasons' => 'Information on the failure of Provisioned Throughput assigned to an agent alias.
', 'AgentVersion$failureReasons' => 'A list of reasons that the API operation on the version failed.
', 'DataSource$failureReasons' => 'The detailed reasons on the failure to delete a data source.
', 'IngestionJob$failureReasons' => 'A list of reasons that the ingestion job failed.
', 'KnowledgeBase$failureReasons' => 'A list of reasons that the API operation on the knowledge base failed.
', ], ], 'FieldName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'MongoDbAtlasFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'MongoDbAtlasFieldMapping$vectorField' => 'The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
', 'OpenSearchServerlessFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'OpenSearchServerlessFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'OpenSearchServerlessFieldMapping$vectorField' => 'The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
', 'PineconeFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'PineconeFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'RedisEnterpriseCloudFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'RedisEnterpriseCloudFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'RedisEnterpriseCloudFieldMapping$vectorField' => 'The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
', ], ], 'FixedSizeChunkingConfiguration' => [ 'base' => 'Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The maximum number of tokens to include in a chunk.
', ], ], 'FixedSizeChunkingConfigurationOverlapPercentageInteger' => [ 'base' => NULL, 'refs' => [ 'FixedSizeChunkingConfiguration$overlapPercentage' => 'The percentage of overlap between adjacent chunks of a data source.
', ], ], 'Function' => [ 'base' => 'Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
This data type is used in the following API operations:
A description of the function and its purpose.
', ], ], 'FunctionSchema' => [ 'base' => 'Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
This data type is used in the following API operations:
Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
', 'CreateAgentActionGroupRequest$functionSchema' => 'Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
', 'UpdateAgentActionGroupRequest$functionSchema' => 'Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
', ], ], 'Functions' => [ 'base' => NULL, 'refs' => [ 'FunctionSchema$functions' => 'A list of functions that each define an action in the action group.
', ], ], 'GetAgentActionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentActionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIngestionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIngestionJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'Id' => [ 'base' => NULL, 'refs' => [ 'ActionGroupSummary$actionGroupId' => 'The unique identifier of the action group.
', 'Agent$agentId' => 'The unique identifier of the agent.
', 'AgentActionGroup$actionGroupId' => 'The unique identifier of the action group.
', 'AgentActionGroup$agentId' => 'The unique identifier of the agent to which the action group belongs.
', 'AgentAlias$agentId' => 'The unique identifier of the agent.
', 'AgentKnowledgeBase$agentId' => 'The unique identifier of the agent with which the knowledge base is associated.
', 'AgentKnowledgeBase$knowledgeBaseId' => 'The unique identifier of the association between the agent and the knowledge base.
', 'AgentKnowledgeBaseSummary$knowledgeBaseId' => 'The unique identifier of the knowledge base associated with an agent.
', 'AgentSummary$agentId' => 'The unique identifier of the agent.
', 'AgentVersion$agentId' => 'The unique identifier of the agent that the version belongs to.
', 'AssociateAgentKnowledgeBaseRequest$agentId' => 'The unique identifier of the agent with which you want to associate the knowledge base.
', 'AssociateAgentKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to associate with the agent.
', 'CreateAgentActionGroupRequest$agentId' => 'The unique identifier of the agent for which to create the action group.
', 'CreateAgentAliasRequest$agentId' => 'The unique identifier of the agent.
', 'CreateDataSourceRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to which to add the data source.
', 'DataSource$dataSourceId' => 'The unique identifier of the data source.
', 'DataSource$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source belongs.
', 'DataSourceSummary$dataSourceId' => 'The unique identifier of the data source.
', 'DataSourceSummary$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source belongs.
', 'DeleteAgentActionGroupRequest$actionGroupId' => 'The unique identifier of the action group to delete.
', 'DeleteAgentActionGroupRequest$agentId' => 'The unique identifier of the agent that the action group belongs to.
', 'DeleteAgentAliasRequest$agentId' => 'The unique identifier of the agent that the alias belongs to.
', 'DeleteAgentAliasResponse$agentId' => 'The unique identifier of the agent that the alias belongs to.
', 'DeleteAgentRequest$agentId' => 'The unique identifier of the agent to delete.
', 'DeleteAgentResponse$agentId' => 'The unique identifier of the agent that was deleted.
', 'DeleteAgentVersionRequest$agentId' => 'The unique identifier of the agent that the version belongs to.
', 'DeleteAgentVersionResponse$agentId' => 'The unique identifier of the agent that the version belongs to.
', 'DeleteDataSourceRequest$dataSourceId' => 'The unique identifier of the data source to delete.
', 'DeleteDataSourceRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base from which to delete the data source.
', 'DeleteDataSourceResponse$dataSourceId' => 'The unique identifier of the data source that was deleted.
', 'DeleteDataSourceResponse$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source that was deleted belonged.
', 'DeleteKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to delete.
', 'DeleteKnowledgeBaseResponse$knowledgeBaseId' => 'The unique identifier of the knowledge base that was deleted.
', 'DisassociateAgentKnowledgeBaseRequest$agentId' => 'The unique identifier of the agent from which to disassociate the knowledge base.
', 'DisassociateAgentKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to disassociate.
', 'GetAgentActionGroupRequest$actionGroupId' => 'The unique identifier of the action group for which to get information.
', 'GetAgentActionGroupRequest$agentId' => 'The unique identifier of the agent that the action group belongs to.
', 'GetAgentAliasRequest$agentId' => 'The unique identifier of the agent to which the alias to get information belongs.
', 'GetAgentKnowledgeBaseRequest$agentId' => 'The unique identifier of the agent with which the knowledge base is associated.
', 'GetAgentKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base associated with the agent.
', 'GetAgentRequest$agentId' => 'The unique identifier of the agent.
', 'GetAgentVersionRequest$agentId' => 'The unique identifier of the agent.
', 'GetDataSourceRequest$dataSourceId' => 'The unique identifier of the data source.
', 'GetDataSourceRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base that the data source was added to.
', 'GetIngestionJobRequest$dataSourceId' => 'The unique identifier of the data source in the ingestion job.
', 'GetIngestionJobRequest$ingestionJobId' => 'The unique identifier of the ingestion job.
', 'GetIngestionJobRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base for which the ingestion job applies.
', 'GetKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base for which to get information.
', 'IngestionJob$dataSourceId' => 'The unique identifier of the ingested data source.
', 'IngestionJob$ingestionJobId' => 'The unique identifier of the ingestion job.
', 'IngestionJob$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source is being added.
', 'IngestionJobSummary$dataSourceId' => 'The unique identifier of the data source in the ingestion job.
', 'IngestionJobSummary$ingestionJobId' => 'The unique identifier of the ingestion job.
', 'IngestionJobSummary$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source is added.
', 'KnowledgeBase$knowledgeBaseId' => 'The unique identifier of the knowledge base.
', 'KnowledgeBaseSummary$knowledgeBaseId' => 'The unique identifier of the knowledge base.
', 'ListAgentActionGroupsRequest$agentId' => 'The unique identifier of the agent.
', 'ListAgentAliasesRequest$agentId' => 'The unique identifier of the agent.
', 'ListAgentKnowledgeBasesRequest$agentId' => 'The unique identifier of the agent for which to return information about knowledge bases associated with it.
', 'ListAgentVersionsRequest$agentId' => 'The unique identifier of the agent.
', 'ListDataSourcesRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base for which to return a list of information.
', 'ListIngestionJobsRequest$dataSourceId' => 'The unique identifier of the data source for which to return ingestion jobs.
', 'ListIngestionJobsRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base for which to return ingestion jobs.
', 'PrepareAgentRequest$agentId' => 'The unique identifier of the agent for which to create a DRAFT version.
The unique identifier of the agent for which the DRAFT version was created.
The unique identifier of the data source to ingest.
', 'StartIngestionJobRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to which to add the data source.
', 'UpdateAgentActionGroupRequest$actionGroupId' => 'The unique identifier of the action group.
', 'UpdateAgentActionGroupRequest$agentId' => 'The unique identifier of the agent for which to update the action group.
', 'UpdateAgentAliasRequest$agentId' => 'The unique identifier of the agent.
', 'UpdateAgentKnowledgeBaseRequest$agentId' => 'The unique identifier of the agent associated with the knowledge base that you want to update.
', 'UpdateAgentKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base that has been associated with an agent.
', 'UpdateAgentRequest$agentId' => 'The unique identifier of the agent.
', 'UpdateDataSourceRequest$dataSourceId' => 'The unique identifier of the data source.
', 'UpdateDataSourceRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source belongs.
', 'UpdateKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to update.
', ], ], 'InferenceConfiguration' => [ 'base' => 'Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
This data type is used in the following API operations:
', 'refs' => [ 'GetIngestionJobResponse$ingestionJob' => 'Contains details about the ingestion job.
', 'StartIngestionJobResponse$ingestionJob' => 'An object containing information about the ingestion job.
', ], ], 'IngestionJobFilter' => [ 'base' => 'Defines a filter by which to filter the results.
', 'refs' => [ 'IngestionJobFilters$member' => NULL, ], ], 'IngestionJobFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'IngestionJobFilter$attribute' => 'The attribute by which to filter the results.
', ], ], 'IngestionJobFilterOperator' => [ 'base' => NULL, 'refs' => [ 'IngestionJobFilter$operator' => 'The operation to carry out between the attribute and the values.
', ], ], 'IngestionJobFilterValue' => [ 'base' => NULL, 'refs' => [ 'IngestionJobFilterValues$member' => NULL, ], ], 'IngestionJobFilterValues' => [ 'base' => NULL, 'refs' => [ 'IngestionJobFilter$values' => 'A list of values for the attribute.
', ], ], 'IngestionJobFilters' => [ 'base' => NULL, 'refs' => [ 'ListIngestionJobsRequest$filters' => 'Contains a definition of a filter for which to filter the results.
', ], ], 'IngestionJobSortBy' => [ 'base' => 'Parameters by which to sort the results.
', 'refs' => [ 'ListIngestionJobsRequest$sortBy' => 'Contains details about how to sort the results.
', ], ], 'IngestionJobSortByAttribute' => [ 'base' => NULL, 'refs' => [ 'IngestionJobSortBy$attribute' => 'The attribute by which to sort the results.
', ], ], 'IngestionJobStatistics' => [ 'base' => 'Contains the statistics for the ingestion job.
', 'refs' => [ 'IngestionJob$statistics' => 'Contains statistics about the ingestion job.
', 'IngestionJobSummary$statistics' => 'Contains statistics for the ingestion job.
', ], ], 'IngestionJobStatus' => [ 'base' => NULL, 'refs' => [ 'IngestionJob$status' => 'The status of the ingestion job.
', 'IngestionJobSummary$status' => 'The status of the ingestion job.
', ], ], 'IngestionJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListIngestionJobsResponse$ingestionJobSummaries' => 'A list of objects, each of which contains information about an ingestion job.
', ], ], 'IngestionJobSummary' => [ 'base' => 'Contains details about an ingestion job.
', 'refs' => [ 'IngestionJobSummaries$member' => NULL, ], ], 'Instruction' => [ 'base' => NULL, 'refs' => [ 'Agent$instruction' => 'Instructions that tell the agent what it should do and how it should interact with users.
', 'AgentVersion$instruction' => 'The instructions provided to the agent.
', 'CreateAgentRequest$instruction' => 'Instructions that tell the agent what it should do and how it should interact with users.
', 'UpdateAgentRequest$instruction' => 'Specifies new instructions that tell the agent what it should do and how it should interact with users.
', ], ], 'InternalServerException' => [ 'base' => 'An internal server error occurred. Retry your request.
', 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'Agent$customerEncryptionKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
', 'AgentVersion$customerEncryptionKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
', 'CreateAgentRequest$customerEncryptionKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
', 'ServerSideEncryptionConfiguration$kmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
', 'UpdateAgentRequest$customerEncryptionKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
', ], ], 'KnowledgeBase' => [ 'base' => 'Contains information about a knowledge base.
', 'refs' => [ 'CreateKnowledgeBaseResponse$knowledgeBase' => 'Contains details about the knowledge base.
', 'GetKnowledgeBaseResponse$knowledgeBase' => 'Contains details about the knowledge base.
', 'UpdateKnowledgeBaseResponse$knowledgeBase' => 'Contains details about the knowledge base.
', ], ], 'KnowledgeBaseArn' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBase$knowledgeBaseArn' => 'The Amazon Resource Name (ARN) of the knowledge base.
', ], ], 'KnowledgeBaseConfiguration' => [ 'base' => 'Contains details about the embeddings configuration of the knowledge base.
', 'refs' => [ 'CreateKnowledgeBaseRequest$knowledgeBaseConfiguration' => 'Contains details about the embeddings model used for the knowledge base.
', 'KnowledgeBase$knowledgeBaseConfiguration' => 'Contains details about the embeddings configuration of the knowledge base.
', 'UpdateKnowledgeBaseRequest$knowledgeBaseConfiguration' => 'Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
', ], ], 'KnowledgeBaseRoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateKnowledgeBaseRequest$roleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
', 'KnowledgeBase$roleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
', 'UpdateKnowledgeBaseRequest$roleArn' => 'Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
', ], ], 'KnowledgeBaseState' => [ 'base' => NULL, 'refs' => [ 'AgentKnowledgeBase$knowledgeBaseState' => 'Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
', 'AgentKnowledgeBaseSummary$knowledgeBaseState' => 'Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
', 'AssociateAgentKnowledgeBaseRequest$knowledgeBaseState' => 'Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
', 'UpdateAgentKnowledgeBaseRequest$knowledgeBaseState' => 'Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
', ], ], 'KnowledgeBaseStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteKnowledgeBaseResponse$status' => 'The status of the knowledge base and whether it has been successfully deleted.
', 'KnowledgeBase$status' => 'The status of the knowledge base. The following statuses are possible:
CREATING – The knowledge base is being created.
ACTIVE – The knowledge base is ready to be queried.
DELETING – The knowledge base is being deleted.
UPDATING – The knowledge base is being updated.
FAILED – The knowledge base API operation failed.
The status of the knowledge base.
', ], ], 'KnowledgeBaseStorageType' => [ 'base' => NULL, 'refs' => [ 'StorageConfiguration$type' => 'The vector store service in which the knowledge base is stored.
', ], ], 'KnowledgeBaseSummaries' => [ 'base' => NULL, 'refs' => [ 'ListKnowledgeBasesResponse$knowledgeBaseSummaries' => 'A list of objects, each of which contains information about a knowledge base.
', ], ], 'KnowledgeBaseSummary' => [ 'base' => 'Contains details about a knowledge base.
', 'refs' => [ 'KnowledgeBaseSummaries$member' => NULL, ], ], 'KnowledgeBaseType' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseConfiguration$type' => 'The type of data that the data source is converted into for the knowledge base.
', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'ActionGroupExecutor$lambda' => 'The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
', 'PromptOverrideConfiguration$overrideLambda' => 'The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of tokens to allow in the generated response.
', ], ], 'ModelIdentifier' => [ 'base' => NULL, 'refs' => [ 'Agent$foundationModel' => 'The foundation model used for orchestration by the agent.
', 'AgentVersion$foundationModel' => 'The foundation model that the version invokes.
', 'CreateAgentRequest$foundationModel' => 'The foundation model to be used for orchestration by the agent you create.
', 'UpdateAgentRequest$foundationModel' => 'Specifies a new foundation model to be used for orchestration by the agent.
', ], ], 'MongoDbAtlasCollectionName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$collectionName' => 'The collection name of the knowledge base in MongoDB Atlas.
', ], ], 'MongoDbAtlasConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
', 'refs' => [ 'StorageConfiguration$mongoDbAtlasConfiguration' => 'Contains the storage configuration of the knowledge base in MongoDB Atlas.
', ], ], 'MongoDbAtlasDatabaseName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$databaseName' => 'The database name in your MongoDB Atlas cluster for your knowledge base.
', ], ], 'MongoDbAtlasEndpoint' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$endpoint' => 'The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
', ], ], 'MongoDbAtlasEndpointServiceName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$endpointServiceName' => 'The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
', ], ], 'MongoDbAtlasFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'MongoDbAtlasConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'MongoDbAtlasIndexName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$vectorIndexName' => 'The name of the MongoDB Atlas vector search index.
', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'ActionGroupSummary$actionGroupName' => 'The name of the action group.
', 'Agent$agentName' => 'The name of the agent.
', 'AgentActionGroup$actionGroupName' => 'The name of the action group.
', 'AgentAlias$agentAliasName' => 'The name of the alias of the agent.
', 'AgentAliasSummary$agentAliasName' => 'The name of the alias.
', 'AgentSummary$agentName' => 'The name of the agent.
', 'AgentVersion$agentName' => 'The name of the agent that the version belongs to.
', 'AgentVersionSummary$agentName' => 'The name of the agent to which the version belongs.
', 'CreateAgentActionGroupRequest$actionGroupName' => 'The name to give the action group.
', 'CreateAgentAliasRequest$agentAliasName' => 'The name of the alias.
', 'CreateAgentRequest$agentName' => 'A name for the agent that you create.
', 'CreateDataSourceRequest$name' => 'The name of the data source.
', 'CreateKnowledgeBaseRequest$name' => 'A name for the knowledge base.
', 'DataSource$name' => 'The name of the data source.
', 'DataSourceSummary$name' => 'The name of the data source.
', 'Function$name' => 'A name for the function.
', 'KnowledgeBase$name' => 'The name of the knowledge base.
', 'KnowledgeBaseSummary$name' => 'The name of the knowledge base.
', 'ParameterMap$key' => NULL, 'UpdateAgentActionGroupRequest$actionGroupName' => 'Specifies a new name for the action group.
', 'UpdateAgentAliasRequest$agentAliasName' => 'Specifies a new name for the alias.
', 'UpdateAgentRequest$agentName' => 'Specifies a new name for the agent.
', 'UpdateDataSourceRequest$name' => 'Specifies a new name for the data source.
', 'UpdateKnowledgeBaseRequest$name' => 'Specifies a new name for the knowledge base.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListAgentActionGroupsRequest$nextToken' => 'If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
A message describing why this field failed validation.
', 'ValidationExceptionField$name' => 'The name of the field.
', ], ], 'NumericalVersion' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$version' => 'The version number.
', 'DeleteAgentVersionRequest$agentVersion' => 'The version of the agent to delete.
', 'DeleteAgentVersionResponse$agentVersion' => 'The version that was deleted.
', 'GetAgentVersionRequest$agentVersion' => 'The version of the agent.
', ], ], 'OpenSearchServerlessCollectionArn' => [ 'base' => NULL, 'refs' => [ 'OpenSearchServerlessConfiguration$collectionArn' => 'The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
', ], ], 'OpenSearchServerlessConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
', 'refs' => [ 'StorageConfiguration$opensearchServerlessConfiguration' => 'Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
', ], ], 'OpenSearchServerlessFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'OpenSearchServerlessConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'OpenSearchServerlessIndexName' => [ 'base' => NULL, 'refs' => [ 'OpenSearchServerlessConfiguration$vectorIndexName' => 'The name of the vector store.
', ], ], 'ParameterDescription' => [ 'base' => NULL, 'refs' => [ 'ParameterDetail$description' => 'A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
', ], ], 'ParameterDetail' => [ 'base' => 'Contains details about a parameter in a function for an action group.
This data type is used in the following API operations:
The parameters that the agent elicits from the user to fulfill the function.
', ], ], 'Payload' => [ 'base' => NULL, 'refs' => [ 'APISchema$payload' => 'The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
', ], ], 'PineconeConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
', 'refs' => [ 'StorageConfiguration$pineconeConfiguration' => 'Contains the storage configuration of the knowledge base in Pinecone.
', ], ], 'PineconeConnectionString' => [ 'base' => NULL, 'refs' => [ 'PineconeConfiguration$connectionString' => 'The endpoint URL for your index management page.
', ], ], 'PineconeFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'PineconeConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'PineconeNamespace' => [ 'base' => NULL, 'refs' => [ 'PineconeConfiguration$namespace' => 'The namespace to be used to write new data to your database.
', ], ], 'PrepareAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'PrepareAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'PrimitiveLong' => [ 'base' => NULL, 'refs' => [ 'IngestionJobStatistics$numberOfDocumentsDeleted' => 'The number of source documents that was deleted.
', 'IngestionJobStatistics$numberOfDocumentsFailed' => 'The number of source documents that failed to be ingested.
', 'IngestionJobStatistics$numberOfDocumentsScanned' => 'The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
', 'IngestionJobStatistics$numberOfMetadataDocumentsModified' => 'The number of metadata files that were updated or deleted.
', 'IngestionJobStatistics$numberOfMetadataDocumentsScanned' => 'The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
', 'IngestionJobStatistics$numberOfModifiedDocumentsIndexed' => 'The number of modified source documents in the data source that were successfully indexed.
', 'IngestionJobStatistics$numberOfNewDocumentsIndexed' => 'The number of new source documents in the data source that were successfully indexed.
', ], ], 'PromptConfiguration' => [ 'base' => 'Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
', 'refs' => [ 'PromptConfigurations$member' => NULL, ], ], 'PromptConfigurations' => [ 'base' => NULL, 'refs' => [ 'PromptOverrideConfiguration$promptConfigurations' => 'Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
', ], ], 'PromptOverrideConfiguration' => [ 'base' => 'Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
', 'refs' => [ 'Agent$promptOverrideConfiguration' => 'Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
', 'AgentVersion$promptOverrideConfiguration' => 'Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
', 'CreateAgentRequest$promptOverrideConfiguration' => 'Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
', 'UpdateAgentRequest$promptOverrideConfiguration' => 'Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
', ], ], 'PromptState' => [ 'base' => NULL, 'refs' => [ 'PromptConfiguration$promptState' => 'Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
PRE_PROCESSING – ENABLED
ORCHESTRATION – ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
POST_PROCESSING – DISABLED
The step in the agent sequence that this prompt configuration applies to.
', ], ], 'ProvisionedModelIdentifier' => [ 'base' => NULL, 'refs' => [ 'AgentAliasRoutingConfigurationListItem$provisionedThroughput' => 'Information on the Provisioned Throughput assigned to an agent alias.
', ], ], 'RdsArn' => [ 'base' => NULL, 'refs' => [ 'RdsConfiguration$resourceArn' => 'The Amazon Resource Name (ARN) of the vector store.
', ], ], 'RdsConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
', 'refs' => [ 'StorageConfiguration$rdsConfiguration' => 'Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
', ], ], 'RdsDatabaseName' => [ 'base' => NULL, 'refs' => [ 'RdsConfiguration$databaseName' => 'The name of your Amazon RDS database.
', ], ], 'RdsFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'RdsConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'RdsTableName' => [ 'base' => NULL, 'refs' => [ 'RdsConfiguration$tableName' => 'The name of the table in the database.
', ], ], 'RecommendedAction' => [ 'base' => NULL, 'refs' => [ 'RecommendedActions$member' => NULL, ], ], 'RecommendedActions' => [ 'base' => NULL, 'refs' => [ 'Agent$recommendedActions' => 'Contains recommended actions to take for the agent-related API that you invoked to succeed.
', 'AgentVersion$recommendedActions' => 'A list of recommended actions to take for the failed API operation on the version to succeed.
', ], ], 'RedisEnterpriseCloudConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
', 'refs' => [ 'StorageConfiguration$redisEnterpriseCloudConfiguration' => 'Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
', ], ], 'RedisEnterpriseCloudEndpoint' => [ 'base' => NULL, 'refs' => [ 'RedisEnterpriseCloudConfiguration$endpoint' => 'The endpoint URL of the Redis Enterprise Cloud database.
', ], ], 'RedisEnterpriseCloudFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'RedisEnterpriseCloudConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'RedisEnterpriseCloudIndexName' => [ 'base' => NULL, 'refs' => [ 'RedisEnterpriseCloudConfiguration$vectorIndexName' => 'The name of the vector index.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
', 'refs' => [], ], 'S3BucketArn' => [ 'base' => NULL, 'refs' => [ 'S3DataSourceConfiguration$bucketArn' => 'The Amazon Resource Name (ARN) of the bucket that contains the data source.
', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'S3Identifier$s3BucketName' => 'The name of the S3 bucket.
', ], ], 'S3DataSourceConfiguration' => [ 'base' => 'Contains information about the S3 configuration of the data source.
', 'refs' => [ 'DataSourceConfiguration$s3Configuration' => 'Contains details about the configuration of the S3 object containing the data source.
', ], ], 'S3Identifier' => [ 'base' => 'Contains information about the S3 object containing the resource.
', 'refs' => [ 'APISchema$s3' => 'Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
', ], ], 'S3ObjectKey' => [ 'base' => NULL, 'refs' => [ 'S3Identifier$s3ObjectKey' => 'The S3 object key containing the resource.
', ], ], 'S3Prefix' => [ 'base' => NULL, 'refs' => [ 'S3Prefixes$member' => NULL, ], ], 'S3Prefixes' => [ 'base' => NULL, 'refs' => [ 'S3DataSourceConfiguration$inclusionPrefixes' => 'A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$credentialsSecretArn' => 'The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
', 'PineconeConfiguration$credentialsSecretArn' => 'The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
', 'RdsConfiguration$credentialsSecretArn' => 'The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
', 'RedisEnterpriseCloudConfiguration$credentialsSecretArn' => 'The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
', ], ], 'ServerSideEncryptionConfiguration' => [ 'base' => 'Contains the configuration for server-side encryption.
', 'refs' => [ 'CreateDataSourceRequest$serverSideEncryptionConfiguration' => 'Contains details about the server-side encryption for the data source.
', 'DataSource$serverSideEncryptionConfiguration' => 'Contains details about the configuration of the server-side encryption.
', 'UpdateDataSourceRequest$serverSideEncryptionConfiguration' => 'Contains details about server-side encryption of the data source.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'The number of requests exceeds the service quota. Resubmit your request later.
', 'refs' => [], ], 'SessionTTL' => [ 'base' => NULL, 'refs' => [ 'Agent$idleSessionTTLInSeconds' => 'The number of seconds for which Amazon Bedrock keeps information about a user\'s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
', 'AgentVersion$idleSessionTTLInSeconds' => 'The number of seconds for which Amazon Bedrock keeps information about a user\'s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
', 'CreateAgentRequest$idleSessionTTLInSeconds' => 'The number of seconds for which Amazon Bedrock keeps information about a user\'s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
', 'UpdateAgentRequest$idleSessionTTLInSeconds' => 'The number of seconds for which Amazon Bedrock keeps information about a user\'s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'IngestionJobSortBy$order' => 'The order by which to sort the results.
', ], ], 'StartIngestionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartIngestionJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSequences' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$stopSequences' => 'A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
', ], ], 'StorageConfiguration' => [ 'base' => 'Contains the storage configuration of the knowledge base.
', 'refs' => [ 'CreateKnowledgeBaseRequest$storageConfiguration' => 'Contains details about the configuration of the vector database used for the knowledge base.
', 'KnowledgeBase$storageConfiguration' => 'Contains details about the storage configuration of the knowledge base.
', 'UpdateKnowledgeBaseRequest$storageConfiguration' => 'Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'StopSequences$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagsMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'A list of keys of the tags to remove from the resource.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagsMap$value' => NULL, ], ], 'TaggableResourcesArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource for which to list tags.
', 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource to tag.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource from which to remove tags.
', ], ], 'TagsMap' => [ 'base' => NULL, 'refs' => [ 'CreateAgentAliasRequest$tags' => 'Any tags that you want to attach to the alias of the agent.
', 'CreateAgentRequest$tags' => 'Any tags that you want to attach to the agent.
', 'CreateKnowledgeBaseRequest$tags' => 'Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
', 'ListTagsForResourceResponse$tags' => 'The key-value pairs for the tags associated with the resource.
', 'TagResourceRequest$tags' => 'An object containing key-value pairs that define the tags to attach to the resource.
', ], ], 'Temperature' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$temperature' => 'The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
', ], ], 'ThrottlingException' => [ 'base' => 'The number of requests exceeds the limit. Resubmit your request later.
', 'refs' => [], ], 'TopK' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topK' => 'While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
The data type of the parameter.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentActionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentActionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'Input validation failed. Check your request parameters and retry the request.
', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => 'Stores information about a field passed inside a request that resulted in an validation error.
', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fieldList' => 'A list of objects containing fields that caused validation errors and their corresponding validation error messages.
', ], ], 'VectorIngestionConfiguration' => [ 'base' => 'Contains details about how to ingest the documents in a data source.
', 'refs' => [ 'CreateDataSourceRequest$vectorIngestionConfiguration' => 'Contains details about how to ingest the documents in the data source.
', 'DataSource$vectorIngestionConfiguration' => 'Contains details about how to ingest the documents in the data source.
', 'UpdateDataSourceRequest$vectorIngestionConfiguration' => 'Contains details about how to ingest the documents in the data source.
', ], ], 'VectorKnowledgeBaseConfiguration' => [ 'base' => 'Contains details about the model used to create vector embeddings for the knowledge base.
', 'refs' => [ 'KnowledgeBaseConfiguration$vectorKnowledgeBaseConfiguration' => 'Contains details about the embeddings model that\'sused to convert the data source.
', ], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'AgentActionGroup$agentVersion' => 'The version of the agent to which the action group belongs.
', 'AgentAliasRoutingConfigurationListItem$agentVersion' => 'The version of the agent with which the alias is associated.
', 'AgentKnowledgeBase$agentVersion' => 'The version of the agent with which the knowledge base is associated.
', 'AgentSummary$latestAgentVersion' => 'The latest version of the agent.
', 'AgentVersionSummary$agentVersion' => 'The version of the agent.
', 'GetAgentActionGroupRequest$agentVersion' => 'The version of the agent that the action group belongs to.
', 'GetAgentKnowledgeBaseRequest$agentVersion' => 'The version of the agent with which the knowledge base is associated.
', 'ListAgentActionGroupsRequest$agentVersion' => 'The version of the agent.
', 'ListAgentKnowledgeBasesRequest$agentVersion' => 'The version of the agent for which to return information about knowledge bases associated with it.
', 'PrepareAgentResponse$agentVersion' => 'The version of the agent.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Describes the API operations for creating and managing Amazon Bedrock agents.
', 'operations' => [ 'AssociateAgentKnowledgeBase' => 'Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
Specify the following fields for security purposes.
agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn\'t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
Creates an alias of an agent that can be used to deploy the agent.
', 'CreateDataSource' => 'Sets up a data source to be added to a knowledge base.
You can\'t change the chunkingConfiguration after you create the data source.
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
Provide the name and an optional description.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
Provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
Deletes an agent.
', 'DeleteAgentActionGroup' => 'Deletes an action group in an agent.
', 'DeleteAgentAlias' => 'Deletes an alias of an agent.
', 'DeleteAgentVersion' => 'Deletes a version of an agent.
', 'DeleteDataSource' => 'Deletes a data source from a knowledge base.
', 'DeleteKnowledgeBase' => 'Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
', 'DisassociateAgentKnowledgeBase' => 'Disassociates a knowledge base from an agent.
', 'GetAgent' => 'Gets information about an agent.
', 'GetAgentActionGroup' => 'Gets information about an action group for an agent.
', 'GetAgentAlias' => 'Gets information about an alias of an agent.
', 'GetAgentKnowledgeBase' => 'Gets information about a knowledge base associated with an agent.
', 'GetAgentVersion' => 'Gets details about a version of an agent.
', 'GetDataSource' => 'Gets information about a data source.
', 'GetIngestionJob' => 'Gets information about a ingestion job, in which a data source is added to a knowledge base.
', 'GetKnowledgeBase' => 'Gets information about a knoweldge base.
', 'ListAgentActionGroups' => 'Lists the action groups for an agent and information about each one.
', 'ListAgentAliases' => 'Lists the aliases of an agent and information about each one.
', 'ListAgentKnowledgeBases' => 'Lists knowledge bases associated with an agent and information about each one.
', 'ListAgentVersions' => 'Lists the versions of an agent and information about each version.
', 'ListAgents' => 'Lists the agents belonging to an account and information about each agent.
', 'ListDataSources' => 'Lists the data sources in a knowledge base and information about each one.
', 'ListIngestionJobs' => 'Lists the ingestion jobs for a data source and information about each of them.
', 'ListKnowledgeBases' => 'Lists the knowledge bases in an account and information about each of them.
', 'ListTagsForResource' => 'List all the tags for the resource you specify.
', 'PrepareAgent' => 'Creates a DRAFT version of the agent that can be used for internal testing.
Begins an ingestion job, in which a data source is added to a knowledge base.
', 'TagResource' => 'Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
', 'UntagResource' => 'Remove tags from a resource.
', 'UpdateAgent' => 'Updates the configuration of an agent.
', 'UpdateAgentActionGroup' => 'Updates the configuration for an action group for an agent.
', 'UpdateAgentAlias' => 'Updates configurations for an alias of an agent.
', 'UpdateAgentKnowledgeBase' => 'Updates the configuration for a knowledge base that has been associated with an agent.
', 'UpdateDataSource' => 'Updates configurations for a data source.
You can\'t change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
You can change the following fields:
name
description
roleArn
You can\'t change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
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.
', 'CreateAgentActionGroupRequest$apiSchema' => '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.
', 'UpdateAgentActionGroupRequest$apiSchema' => '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.
', ], ], 'AccessDeniedException' => [ 'base' => 'The request is denied because of missing access permissions.
', 'refs' => [], ], 'ActionGroupExecutor' => [ 'base' => 'Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
', 'refs' => [ 'AgentActionGroup$actionGroupExecutor' => 'The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
', 'CreateAgentActionGroupRequest$actionGroupExecutor' => 'The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
', 'UpdateAgentActionGroupRequest$actionGroupExecutor' => 'The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
', ], ], 'ActionGroupSignature' => [ 'base' => NULL, 'refs' => [ 'AgentActionGroup$parentActionSignature' => 'If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn\'t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
', 'CreateAgentActionGroupRequest$parentActionGroupSignature' => 'To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn\'t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
', 'UpdateAgentActionGroupRequest$parentActionGroupSignature' => 'To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn\'t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
', ], ], 'ActionGroupState' => [ 'base' => NULL, 'refs' => [ 'ActionGroupSummary$actionGroupState' => 'Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
', 'AgentActionGroup$actionGroupState' => 'Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
', 'CreateAgentActionGroupRequest$actionGroupState' => 'Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
', 'UpdateAgentActionGroupRequest$actionGroupState' => 'Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
', ], ], 'ActionGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAgentActionGroupsResponse$actionGroupSummaries' => 'A list of objects, each of which contains information about an action group.
', ], ], 'ActionGroupSummary' => [ 'base' => 'Contains details about an action group.
', 'refs' => [ 'ActionGroupSummaries$member' => NULL, ], ], 'Agent' => [ 'base' => 'Contains details about an agent.
', 'refs' => [ 'CreateAgentResponse$agent' => 'Contains details about the agent created.
', 'GetAgentResponse$agent' => 'Contains details about the agent.
', 'UpdateAgentResponse$agent' => 'Contains details about the agent that was updated.
', ], ], 'AgentActionGroup' => [ 'base' => 'Contains details about an action group.
', 'refs' => [ 'CreateAgentActionGroupResponse$agentActionGroup' => 'Contains details about the action group that was created.
', 'GetAgentActionGroupResponse$agentActionGroup' => 'Contains details about the action group.
', 'UpdateAgentActionGroupResponse$agentActionGroup' => 'Contains details about the action group that was updated.
', ], ], 'AgentAlias' => [ 'base' => 'Contains details about an alias of an agent.
', 'refs' => [ 'CreateAgentAliasResponse$agentAlias' => 'Contains details about the alias that was created.
', 'GetAgentAliasResponse$agentAlias' => 'Contains information about the alias.
', 'UpdateAgentAliasResponse$agentAlias' => 'Contains details about the alias that was updated.
', ], ], 'AgentAliasArn' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$agentAliasArn' => 'The Amazon Resource Name (ARN) of the alias of the agent.
', ], ], 'AgentAliasHistoryEvent' => [ 'base' => 'Contains details about the history of the alias.
', 'refs' => [ 'AgentAliasHistoryEvents$member' => NULL, ], ], 'AgentAliasHistoryEvents' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$agentAliasHistoryEvents' => 'Contains details about the history of the alias.
', ], ], 'AgentAliasId' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$agentAliasId' => 'The unique identifier of the alias of the agent.
', 'AgentAliasSummary$agentAliasId' => 'Contains details about
', 'DeleteAgentAliasRequest$agentAliasId' => 'The unique identifier of the alias to delete.
', 'DeleteAgentAliasResponse$agentAliasId' => 'The unique identifier of the alias that was deleted.
', 'GetAgentAliasRequest$agentAliasId' => 'The unique identifier of the alias for which to get information.
', 'UpdateAgentAliasRequest$agentAliasId' => 'The unique identifier of the alias.
', ], ], 'AgentAliasRoutingConfiguration' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$routingConfiguration' => 'Contains details about the routing configuration of the alias.
', 'AgentAliasHistoryEvent$routingConfiguration' => 'Contains details about the version of the agent with which the alias is associated.
', 'AgentAliasSummary$routingConfiguration' => 'Contains details about the version of the agent with which the alias is associated.
', 'CreateAgentAliasRequest$routingConfiguration' => 'Contains details about the routing configuration of the alias.
', 'UpdateAgentAliasRequest$routingConfiguration' => 'Contains details about the routing configuration of the alias.
', ], ], 'AgentAliasRoutingConfigurationListItem' => [ 'base' => 'Contains details about the routing configuration of the alias.
', 'refs' => [ 'AgentAliasRoutingConfiguration$member' => NULL, ], ], 'AgentAliasStatus' => [ 'base' => NULL, 'refs' => [ 'AgentAlias$agentAliasStatus' => 'The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent alias is being created.
PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
FAILED – The agent alias API operation failed.
UPDATING – The agent alias is being updated.
DELETING – The agent alias is being deleted.
The status of the alias.
', 'DeleteAgentAliasResponse$agentAliasStatus' => 'The status of the alias.
', ], ], 'AgentAliasSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAgentAliasesResponse$agentAliasSummaries' => 'A list of objects, each of which contains information about an alias of the agent.
', ], ], 'AgentAliasSummary' => [ 'base' => 'Contains details about an alias of an agent.
', 'refs' => [ 'AgentAliasSummaries$member' => NULL, ], ], 'AgentArn' => [ 'base' => NULL, 'refs' => [ 'Agent$agentArn' => 'The Amazon Resource Name (ARN) of the agent.
', 'AgentVersion$agentArn' => 'The Amazon Resource Name (ARN) of the agent that the version belongs to.
', ], ], 'AgentKnowledgeBase' => [ 'base' => 'Contains details about a knowledge base that is associated with an agent.
', 'refs' => [ 'AssociateAgentKnowledgeBaseResponse$agentKnowledgeBase' => 'Contains details about the knowledge base that has been associated with the agent.
', 'GetAgentKnowledgeBaseResponse$agentKnowledgeBase' => 'Contains details about a knowledge base attached to an agent.
', 'UpdateAgentKnowledgeBaseResponse$agentKnowledgeBase' => 'Contains details about the knowledge base that has been associated with an agent.
', ], ], 'AgentKnowledgeBaseSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAgentKnowledgeBasesResponse$agentKnowledgeBaseSummaries' => 'A list of objects, each of which contains information about a knowledge base associated with the agent.
', ], ], 'AgentKnowledgeBaseSummary' => [ 'base' => 'Contains details about a knowledge base associated with an agent.
', 'refs' => [ 'AgentKnowledgeBaseSummaries$member' => NULL, ], ], 'AgentRoleArn' => [ 'base' => NULL, 'refs' => [ 'Agent$agentResourceRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
', 'AgentVersion$agentResourceRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
', 'CreateAgentRequest$agentResourceRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
', 'UpdateAgentRequest$agentResourceRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
', ], ], 'AgentStatus' => [ 'base' => NULL, 'refs' => [ 'Agent$agentStatus' => 'The status of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent is being created.
PREPARING – The agent is being prepared.
PREPARED – The agent is prepared and ready to be invoked.
NOT_PREPARED – The agent has been created but not yet prepared.
FAILED – The agent API operation failed.
UPDATING – The agent is being updated.
DELETING – The agent is being deleted.
The status of the agent.
', 'AgentVersion$agentStatus' => 'The status of the agent that the version belongs to.
', 'AgentVersionSummary$agentStatus' => 'The status of the agent to which the version belongs.
', 'DeleteAgentResponse$agentStatus' => 'The status of the agent.
', 'DeleteAgentVersionResponse$agentStatus' => 'The status of the agent version.
', 'PrepareAgentResponse$agentStatus' => 'The status of the DRAFT version and whether it is ready for use.
A list of objects, each of which contains information about an agent.
', ], ], 'AgentSummary' => [ 'base' => 'Contains details about an agent.
', 'refs' => [ 'AgentSummaries$member' => NULL, ], ], 'AgentVersion' => [ 'base' => 'Contains details about a version of an agent.
', 'refs' => [ 'GetAgentVersionResponse$agentVersion' => 'Contains details about the version of the agent.
', ], ], 'AgentVersionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAgentVersionsResponse$agentVersionSummaries' => 'A list of objects, each of which contains information about a version of the agent.
', ], ], 'AgentVersionSummary' => [ 'base' => 'Contains details about a version of an agent.
', 'refs' => [ 'AgentVersionSummaries$member' => NULL, ], ], 'AssociateAgentKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateAgentKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'BasePromptTemplate' => [ 'base' => NULL, 'refs' => [ 'PromptConfiguration$basePromptTemplate' => 'Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
', ], ], 'BedrockEmbeddingModelArn' => [ 'base' => NULL, 'refs' => [ 'VectorKnowledgeBaseConfiguration$embeddingModelArn' => 'The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'DeleteAgentActionGroupRequest$skipResourceInUseCheck' => 'By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
Whether the parameter is required for the agent to complete the function for action group invocation.
', ], ], 'BucketOwnerAccountId' => [ 'base' => NULL, 'refs' => [ 'S3DataSourceConfiguration$bucketOwnerAccountId' => 'The bucket account owner ID for the S3 bucket.
', ], ], 'ChunkingConfiguration' => [ 'base' => 'Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
', 'refs' => [ 'VectorIngestionConfiguration$chunkingConfiguration' => 'Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
', ], ], 'ChunkingStrategy' => [ 'base' => NULL, 'refs' => [ 'ChunkingConfiguration$chunkingStrategy' => 'Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.
NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'AgentActionGroup$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'AgentAlias$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateAgentActionGroupRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateAgentAliasRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateAgentRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateDataSourceRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'CreateKnowledgeBaseRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', 'StartIngestionJobRequest$clientToken' => 'A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
', ], ], 'ColumnName' => [ 'base' => NULL, 'refs' => [ 'RdsFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'RdsFieldMapping$primaryKeyField' => 'The name of the field in which Amazon Bedrock stores the ID for each entry.
', 'RdsFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'RdsFieldMapping$vectorField' => 'The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
', ], ], 'ConflictException' => [ 'base' => 'There was a conflict performing an operation.
', 'refs' => [], ], 'CreateAgentActionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentActionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationMode' => [ 'base' => NULL, 'refs' => [ 'PromptConfiguration$parserMode' => 'Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
The data deletion policy assigned to the data source.
', 'DataSource$dataDeletionPolicy' => 'The data deletion policy for a data source.
', 'UpdateDataSourceRequest$dataDeletionPolicy' => 'The data deletion policy of the updated data source.
', ], ], 'DataSource' => [ 'base' => 'Contains details about a data source.
', 'refs' => [ 'CreateDataSourceResponse$dataSource' => 'Contains details about the data source.
', 'GetDataSourceResponse$dataSource' => 'Contains details about the data source.
', 'UpdateDataSourceResponse$dataSource' => 'Contains details about the data source.
', ], ], 'DataSourceConfiguration' => [ 'base' => 'Contains details about how a data source is stored.
', 'refs' => [ 'CreateDataSourceRequest$dataSourceConfiguration' => 'Contains metadata about where the data source is stored.
', 'DataSource$dataSourceConfiguration' => 'Contains details about how the data source is stored.
', 'UpdateDataSourceRequest$dataSourceConfiguration' => 'Contains details about the storage configuration of the data source.
', ], ], 'DataSourceStatus' => [ 'base' => NULL, 'refs' => [ 'DataSource$status' => 'The status of the data source. The following statuses are possible:
Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.
The status of the data source.
', 'DeleteDataSourceResponse$status' => 'The status of the data source.
', ], ], 'DataSourceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$dataSourceSummaries' => 'A list of objects, each of which contains information about a data source.
', ], ], 'DataSourceSummary' => [ 'base' => 'Contains details about a data source.
', 'refs' => [ 'DataSourceSummaries$member' => NULL, ], ], 'DataSourceType' => [ 'base' => NULL, 'refs' => [ 'DataSourceConfiguration$type' => 'The type of storage for the data source.
', ], ], 'DateTimestamp' => [ 'base' => NULL, 'refs' => [ 'ActionGroupSummary$updatedAt' => 'The time at which the action group was last updated.
', 'Agent$createdAt' => 'The time at which the agent was created.
', 'Agent$preparedAt' => 'The time at which the agent was last prepared.
', 'Agent$updatedAt' => 'The time at which the agent was last updated.
', 'AgentActionGroup$createdAt' => 'The time at which the action group was created.
', 'AgentActionGroup$updatedAt' => 'The time at which the action group was last updated.
', 'AgentAlias$createdAt' => 'The time at which the alias of the agent was created.
', 'AgentAlias$updatedAt' => 'The time at which the alias was last updated.
', 'AgentAliasHistoryEvent$endDate' => 'The date that the alias stopped being associated to the version in the routingConfiguration object
The date that the alias began being associated to the version in the routingConfiguration object.
The time at which the alias of the agent was created.
', 'AgentAliasSummary$updatedAt' => 'The time at which the alias was last updated.
', 'AgentKnowledgeBase$createdAt' => 'The time at which the association between the agent and the knowledge base was created.
', 'AgentKnowledgeBase$updatedAt' => 'The time at which the association between the agent and the knowledge base was last updated.
', 'AgentKnowledgeBaseSummary$updatedAt' => 'The time at which the knowledge base associated with an agent was last updated.
', 'AgentSummary$updatedAt' => 'The time at which the agent was last updated.
', 'AgentVersion$createdAt' => 'The time at which the version was created.
', 'AgentVersion$updatedAt' => 'The time at which the version was last updated.
', 'AgentVersionSummary$createdAt' => 'The time at which the version was created.
', 'AgentVersionSummary$updatedAt' => 'The time at which the version was last updated.
', 'DataSource$createdAt' => 'The time at which the data source was created.
', 'DataSource$updatedAt' => 'The time at which the data source was last updated.
', 'DataSourceSummary$updatedAt' => 'The time at which the data source was last updated.
', 'IngestionJob$startedAt' => 'The time at which the ingestion job started.
', 'IngestionJob$updatedAt' => 'The time at which the ingestion job was last updated.
', 'IngestionJobSummary$startedAt' => 'The time at which the ingestion job was started.
', 'IngestionJobSummary$updatedAt' => 'The time at which the ingestion job was last updated.
', 'KnowledgeBase$createdAt' => 'The time at which the knowledge base was created.
', 'KnowledgeBase$updatedAt' => 'The time at which the knowledge base was last updated.
', 'KnowledgeBaseSummary$updatedAt' => 'The time at which the knowledge base was last updated.
', 'PrepareAgentResponse$preparedAt' => 'The time at which the DRAFT version of the agent was last prepared.
The description of the action group.
', 'Agent$description' => 'The description of the agent.
', 'AgentActionGroup$description' => 'The description of the action group.
', 'AgentAlias$description' => 'The description of the alias of the agent.
', 'AgentAliasSummary$description' => 'The description of the alias.
', 'AgentKnowledgeBase$description' => 'The description of the association between the agent and the knowledge base.
', 'AgentKnowledgeBaseSummary$description' => 'The description of the knowledge base associated with an agent.
', 'AgentSummary$description' => 'The description of the agent.
', 'AgentVersion$description' => 'The description of the version.
', 'AgentVersionSummary$description' => 'The description of the version of the agent.
', 'AssociateAgentKnowledgeBaseRequest$description' => 'A description of what the agent should use the knowledge base for.
', 'CreateAgentActionGroupRequest$description' => 'A description of the action group.
', 'CreateAgentAliasRequest$description' => 'A description of the alias of the agent.
', 'CreateAgentRequest$description' => 'A description of the agent.
', 'CreateDataSourceRequest$description' => 'A description of the data source.
', 'CreateKnowledgeBaseRequest$description' => 'A description of the knowledge base.
', 'DataSource$description' => 'The description of the data source.
', 'DataSourceSummary$description' => 'The description of the data source.
', 'IngestionJob$description' => 'The description of the ingestion job.
', 'IngestionJobSummary$description' => 'The description of the ingestion job.
', 'KnowledgeBase$description' => 'The description of the knowledge base.
', 'KnowledgeBaseSummary$description' => 'The description of the knowledge base.
', 'StartIngestionJobRequest$description' => 'A description of the ingestion job.
', 'UpdateAgentActionGroupRequest$description' => 'Specifies a new name for the action group.
', 'UpdateAgentAliasRequest$description' => 'Specifies a new description for the alias.
', 'UpdateAgentKnowledgeBaseRequest$description' => 'Specifies a new description for the knowledge base associated with an agent.
', 'UpdateAgentRequest$description' => 'Specifies a new description of the agent.
', 'UpdateDataSourceRequest$description' => 'Specifies a new description for the data source.
', 'UpdateKnowledgeBaseRequest$description' => 'Specifies a new description for the knowledge base.
', ], ], 'DisassociateAgentKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateAgentKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'DraftVersion' => [ 'base' => NULL, 'refs' => [ 'Agent$agentVersion' => 'The version of the agent.
', 'AssociateAgentKnowledgeBaseRequest$agentVersion' => 'The version of the agent with which you want to associate the knowledge base.
', 'CreateAgentActionGroupRequest$agentVersion' => 'The version of the agent for which to create the action group.
', 'DeleteAgentActionGroupRequest$agentVersion' => 'The version of the agent that the action group belongs to.
', 'DisassociateAgentKnowledgeBaseRequest$agentVersion' => 'The version of the agent from which to disassociate the knowledge base.
', 'UpdateAgentActionGroupRequest$agentVersion' => 'The unique identifier of the agent version for which to update the action group.
', 'UpdateAgentKnowledgeBaseRequest$agentVersion' => 'The version of the agent associated with the knowledge base that you want to update.
', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'FailureReasons$member' => NULL, ], ], 'FailureReasons' => [ 'base' => NULL, 'refs' => [ 'Agent$failureReasons' => 'Contains reasons that the agent-related API that you invoked failed.
', 'AgentAlias$failureReasons' => 'Information on the failure of Provisioned Throughput assigned to an agent alias.
', 'AgentVersion$failureReasons' => 'A list of reasons that the API operation on the version failed.
', 'DataSource$failureReasons' => 'The detailed reasons on the failure to delete a data source.
', 'IngestionJob$failureReasons' => 'A list of reasons that the ingestion job failed.
', 'KnowledgeBase$failureReasons' => 'A list of reasons that the API operation on the knowledge base failed.
', ], ], 'FieldName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'MongoDbAtlasFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'MongoDbAtlasFieldMapping$vectorField' => 'The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
', 'OpenSearchServerlessFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'OpenSearchServerlessFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'OpenSearchServerlessFieldMapping$vectorField' => 'The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
', 'PineconeFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'PineconeFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'RedisEnterpriseCloudFieldMapping$metadataField' => 'The name of the field in which Amazon Bedrock stores metadata about the vector store.
', 'RedisEnterpriseCloudFieldMapping$textField' => 'The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
', 'RedisEnterpriseCloudFieldMapping$vectorField' => 'The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
', ], ], 'FixedSizeChunkingConfiguration' => [ 'base' => 'Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The maximum number of tokens to include in a chunk.
', ], ], 'FixedSizeChunkingConfigurationOverlapPercentageInteger' => [ 'base' => NULL, 'refs' => [ 'FixedSizeChunkingConfiguration$overlapPercentage' => 'The percentage of overlap between adjacent chunks of a data source.
', ], ], 'Function' => [ 'base' => 'Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
This data type is used in the following API operations:
A description of the function and its purpose.
', ], ], 'FunctionSchema' => [ 'base' => 'Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
This data type is used in the following API operations:
Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
', 'CreateAgentActionGroupRequest$functionSchema' => 'Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
', 'UpdateAgentActionGroupRequest$functionSchema' => 'Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
', ], ], 'Functions' => [ 'base' => NULL, 'refs' => [ 'FunctionSchema$functions' => 'A list of functions that each define an action in the action group.
', ], ], 'GetAgentActionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentActionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIngestionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIngestionJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GuardrailConfiguration' => [ 'base' => 'The details of the guardrails configuration.
', 'refs' => [ 'Agent$guardrailConfiguration' => 'The guardrails configuration assigned to the agent.
', 'AgentSummary$guardrailConfiguration' => 'The details of the guardrails configuration in the agent summary.
', 'AgentVersion$guardrailConfiguration' => 'The guardrails configuration assigned to the agent version.
', 'AgentVersionSummary$guardrailConfiguration' => 'The details of the guardrails configuration in the agent version summary.
', 'CreateAgentRequest$guardrailConfiguration' => 'The unique Guardrail configuration assigned to the agent when it is created.
', 'UpdateAgentRequest$guardrailConfiguration' => 'The unique Guardrail configuration assigned to the agent when it is updated.
', ], ], 'GuardrailIdentifier' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailIdentifier' => 'The guardrails identifier assigned to the guardrails configuration.
', ], ], 'GuardrailVersion' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailVersion' => 'The guardrails version assigned to the guardrails configuration.
', ], ], 'Id' => [ 'base' => NULL, 'refs' => [ 'ActionGroupSummary$actionGroupId' => 'The unique identifier of the action group.
', 'Agent$agentId' => 'The unique identifier of the agent.
', 'AgentActionGroup$actionGroupId' => 'The unique identifier of the action group.
', 'AgentActionGroup$agentId' => 'The unique identifier of the agent to which the action group belongs.
', 'AgentAlias$agentId' => 'The unique identifier of the agent.
', 'AgentKnowledgeBase$agentId' => 'The unique identifier of the agent with which the knowledge base is associated.
', 'AgentKnowledgeBase$knowledgeBaseId' => 'The unique identifier of the association between the agent and the knowledge base.
', 'AgentKnowledgeBaseSummary$knowledgeBaseId' => 'The unique identifier of the knowledge base associated with an agent.
', 'AgentSummary$agentId' => 'The unique identifier of the agent.
', 'AgentVersion$agentId' => 'The unique identifier of the agent that the version belongs to.
', 'AssociateAgentKnowledgeBaseRequest$agentId' => 'The unique identifier of the agent with which you want to associate the knowledge base.
', 'AssociateAgentKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to associate with the agent.
', 'CreateAgentActionGroupRequest$agentId' => 'The unique identifier of the agent for which to create the action group.
', 'CreateAgentAliasRequest$agentId' => 'The unique identifier of the agent.
', 'CreateDataSourceRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to which to add the data source.
', 'DataSource$dataSourceId' => 'The unique identifier of the data source.
', 'DataSource$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source belongs.
', 'DataSourceSummary$dataSourceId' => 'The unique identifier of the data source.
', 'DataSourceSummary$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source belongs.
', 'DeleteAgentActionGroupRequest$actionGroupId' => 'The unique identifier of the action group to delete.
', 'DeleteAgentActionGroupRequest$agentId' => 'The unique identifier of the agent that the action group belongs to.
', 'DeleteAgentAliasRequest$agentId' => 'The unique identifier of the agent that the alias belongs to.
', 'DeleteAgentAliasResponse$agentId' => 'The unique identifier of the agent that the alias belongs to.
', 'DeleteAgentRequest$agentId' => 'The unique identifier of the agent to delete.
', 'DeleteAgentResponse$agentId' => 'The unique identifier of the agent that was deleted.
', 'DeleteAgentVersionRequest$agentId' => 'The unique identifier of the agent that the version belongs to.
', 'DeleteAgentVersionResponse$agentId' => 'The unique identifier of the agent that the version belongs to.
', 'DeleteDataSourceRequest$dataSourceId' => 'The unique identifier of the data source to delete.
', 'DeleteDataSourceRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base from which to delete the data source.
', 'DeleteDataSourceResponse$dataSourceId' => 'The unique identifier of the data source that was deleted.
', 'DeleteDataSourceResponse$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source that was deleted belonged.
', 'DeleteKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to delete.
', 'DeleteKnowledgeBaseResponse$knowledgeBaseId' => 'The unique identifier of the knowledge base that was deleted.
', 'DisassociateAgentKnowledgeBaseRequest$agentId' => 'The unique identifier of the agent from which to disassociate the knowledge base.
', 'DisassociateAgentKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to disassociate.
', 'GetAgentActionGroupRequest$actionGroupId' => 'The unique identifier of the action group for which to get information.
', 'GetAgentActionGroupRequest$agentId' => 'The unique identifier of the agent that the action group belongs to.
', 'GetAgentAliasRequest$agentId' => 'The unique identifier of the agent to which the alias to get information belongs.
', 'GetAgentKnowledgeBaseRequest$agentId' => 'The unique identifier of the agent with which the knowledge base is associated.
', 'GetAgentKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base associated with the agent.
', 'GetAgentRequest$agentId' => 'The unique identifier of the agent.
', 'GetAgentVersionRequest$agentId' => 'The unique identifier of the agent.
', 'GetDataSourceRequest$dataSourceId' => 'The unique identifier of the data source.
', 'GetDataSourceRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base that the data source was added to.
', 'GetIngestionJobRequest$dataSourceId' => 'The unique identifier of the data source in the ingestion job.
', 'GetIngestionJobRequest$ingestionJobId' => 'The unique identifier of the ingestion job.
', 'GetIngestionJobRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base for which the ingestion job applies.
', 'GetKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base for which to get information.
', 'IngestionJob$dataSourceId' => 'The unique identifier of the ingested data source.
', 'IngestionJob$ingestionJobId' => 'The unique identifier of the ingestion job.
', 'IngestionJob$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source is being added.
', 'IngestionJobSummary$dataSourceId' => 'The unique identifier of the data source in the ingestion job.
', 'IngestionJobSummary$ingestionJobId' => 'The unique identifier of the ingestion job.
', 'IngestionJobSummary$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source is added.
', 'KnowledgeBase$knowledgeBaseId' => 'The unique identifier of the knowledge base.
', 'KnowledgeBaseSummary$knowledgeBaseId' => 'The unique identifier of the knowledge base.
', 'ListAgentActionGroupsRequest$agentId' => 'The unique identifier of the agent.
', 'ListAgentAliasesRequest$agentId' => 'The unique identifier of the agent.
', 'ListAgentKnowledgeBasesRequest$agentId' => 'The unique identifier of the agent for which to return information about knowledge bases associated with it.
', 'ListAgentVersionsRequest$agentId' => 'The unique identifier of the agent.
', 'ListDataSourcesRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base for which to return a list of information.
', 'ListIngestionJobsRequest$dataSourceId' => 'The unique identifier of the data source for which to return ingestion jobs.
', 'ListIngestionJobsRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base for which to return ingestion jobs.
', 'PrepareAgentRequest$agentId' => 'The unique identifier of the agent for which to create a DRAFT version.
The unique identifier of the agent for which the DRAFT version was created.
The unique identifier of the data source to ingest.
', 'StartIngestionJobRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to which to add the data source.
', 'UpdateAgentActionGroupRequest$actionGroupId' => 'The unique identifier of the action group.
', 'UpdateAgentActionGroupRequest$agentId' => 'The unique identifier of the agent for which to update the action group.
', 'UpdateAgentAliasRequest$agentId' => 'The unique identifier of the agent.
', 'UpdateAgentKnowledgeBaseRequest$agentId' => 'The unique identifier of the agent associated with the knowledge base that you want to update.
', 'UpdateAgentKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base that has been associated with an agent.
', 'UpdateAgentRequest$agentId' => 'The unique identifier of the agent.
', 'UpdateDataSourceRequest$dataSourceId' => 'The unique identifier of the data source.
', 'UpdateDataSourceRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to which the data source belongs.
', 'UpdateKnowledgeBaseRequest$knowledgeBaseId' => 'The unique identifier of the knowledge base to update.
', ], ], 'InferenceConfiguration' => [ 'base' => 'Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
This data type is used in the following API operations:
', 'refs' => [ 'GetIngestionJobResponse$ingestionJob' => 'Contains details about the ingestion job.
', 'StartIngestionJobResponse$ingestionJob' => 'An object containing information about the ingestion job.
', ], ], 'IngestionJobFilter' => [ 'base' => 'Defines a filter by which to filter the results.
', 'refs' => [ 'IngestionJobFilters$member' => NULL, ], ], 'IngestionJobFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'IngestionJobFilter$attribute' => 'The attribute by which to filter the results.
', ], ], 'IngestionJobFilterOperator' => [ 'base' => NULL, 'refs' => [ 'IngestionJobFilter$operator' => 'The operation to carry out between the attribute and the values.
', ], ], 'IngestionJobFilterValue' => [ 'base' => NULL, 'refs' => [ 'IngestionJobFilterValues$member' => NULL, ], ], 'IngestionJobFilterValues' => [ 'base' => NULL, 'refs' => [ 'IngestionJobFilter$values' => 'A list of values for the attribute.
', ], ], 'IngestionJobFilters' => [ 'base' => NULL, 'refs' => [ 'ListIngestionJobsRequest$filters' => 'Contains a definition of a filter for which to filter the results.
', ], ], 'IngestionJobSortBy' => [ 'base' => 'Parameters by which to sort the results.
', 'refs' => [ 'ListIngestionJobsRequest$sortBy' => 'Contains details about how to sort the results.
', ], ], 'IngestionJobSortByAttribute' => [ 'base' => NULL, 'refs' => [ 'IngestionJobSortBy$attribute' => 'The attribute by which to sort the results.
', ], ], 'IngestionJobStatistics' => [ 'base' => 'Contains the statistics for the ingestion job.
', 'refs' => [ 'IngestionJob$statistics' => 'Contains statistics about the ingestion job.
', 'IngestionJobSummary$statistics' => 'Contains statistics for the ingestion job.
', ], ], 'IngestionJobStatus' => [ 'base' => NULL, 'refs' => [ 'IngestionJob$status' => 'The status of the ingestion job.
', 'IngestionJobSummary$status' => 'The status of the ingestion job.
', ], ], 'IngestionJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListIngestionJobsResponse$ingestionJobSummaries' => 'A list of objects, each of which contains information about an ingestion job.
', ], ], 'IngestionJobSummary' => [ 'base' => 'Contains details about an ingestion job.
', 'refs' => [ 'IngestionJobSummaries$member' => NULL, ], ], 'Instruction' => [ 'base' => NULL, 'refs' => [ 'Agent$instruction' => 'Instructions that tell the agent what it should do and how it should interact with users.
', 'AgentVersion$instruction' => 'The instructions provided to the agent.
', 'CreateAgentRequest$instruction' => 'Instructions that tell the agent what it should do and how it should interact with users.
', 'UpdateAgentRequest$instruction' => 'Specifies new instructions that tell the agent what it should do and how it should interact with users.
', ], ], 'InternalServerException' => [ 'base' => 'An internal server error occurred. Retry your request.
', 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'Agent$customerEncryptionKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
', 'AgentVersion$customerEncryptionKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
', 'CreateAgentRequest$customerEncryptionKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
', 'ServerSideEncryptionConfiguration$kmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
', 'UpdateAgentRequest$customerEncryptionKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
', ], ], 'KnowledgeBase' => [ 'base' => 'Contains information about a knowledge base.
', 'refs' => [ 'CreateKnowledgeBaseResponse$knowledgeBase' => 'Contains details about the knowledge base.
', 'GetKnowledgeBaseResponse$knowledgeBase' => 'Contains details about the knowledge base.
', 'UpdateKnowledgeBaseResponse$knowledgeBase' => 'Contains details about the knowledge base.
', ], ], 'KnowledgeBaseArn' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBase$knowledgeBaseArn' => 'The Amazon Resource Name (ARN) of the knowledge base.
', ], ], 'KnowledgeBaseConfiguration' => [ 'base' => 'Contains details about the embeddings configuration of the knowledge base.
', 'refs' => [ 'CreateKnowledgeBaseRequest$knowledgeBaseConfiguration' => 'Contains details about the embeddings model used for the knowledge base.
', 'KnowledgeBase$knowledgeBaseConfiguration' => 'Contains details about the embeddings configuration of the knowledge base.
', 'UpdateKnowledgeBaseRequest$knowledgeBaseConfiguration' => 'Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
', ], ], 'KnowledgeBaseRoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateKnowledgeBaseRequest$roleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
', 'KnowledgeBase$roleArn' => 'The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
', 'UpdateKnowledgeBaseRequest$roleArn' => 'Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
', ], ], 'KnowledgeBaseState' => [ 'base' => NULL, 'refs' => [ 'AgentKnowledgeBase$knowledgeBaseState' => 'Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
', 'AgentKnowledgeBaseSummary$knowledgeBaseState' => 'Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
', 'AssociateAgentKnowledgeBaseRequest$knowledgeBaseState' => 'Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
', 'UpdateAgentKnowledgeBaseRequest$knowledgeBaseState' => 'Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
', ], ], 'KnowledgeBaseStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteKnowledgeBaseResponse$status' => 'The status of the knowledge base and whether it has been successfully deleted.
', 'KnowledgeBase$status' => 'The status of the knowledge base. The following statuses are possible:
CREATING – The knowledge base is being created.
ACTIVE – The knowledge base is ready to be queried.
DELETING – The knowledge base is being deleted.
UPDATING – The knowledge base is being updated.
FAILED – The knowledge base API operation failed.
The status of the knowledge base.
', ], ], 'KnowledgeBaseStorageType' => [ 'base' => NULL, 'refs' => [ 'StorageConfiguration$type' => 'The vector store service in which the knowledge base is stored.
', ], ], 'KnowledgeBaseSummaries' => [ 'base' => NULL, 'refs' => [ 'ListKnowledgeBasesResponse$knowledgeBaseSummaries' => 'A list of objects, each of which contains information about a knowledge base.
', ], ], 'KnowledgeBaseSummary' => [ 'base' => 'Contains details about a knowledge base.
', 'refs' => [ 'KnowledgeBaseSummaries$member' => NULL, ], ], 'KnowledgeBaseType' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseConfiguration$type' => 'The type of data that the data source is converted into for the knowledge base.
', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'ActionGroupExecutor$lambda' => 'The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
', 'PromptOverrideConfiguration$overrideLambda' => 'The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Agents for Amazon Bedrock.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of tokens to allow in the generated response.
', ], ], 'ModelIdentifier' => [ 'base' => NULL, 'refs' => [ 'Agent$foundationModel' => 'The foundation model used for orchestration by the agent.
', 'AgentVersion$foundationModel' => 'The foundation model that the version invokes.
', 'CreateAgentRequest$foundationModel' => 'The foundation model to be used for orchestration by the agent you create.
', 'UpdateAgentRequest$foundationModel' => 'Specifies a new foundation model to be used for orchestration by the agent.
', ], ], 'MongoDbAtlasCollectionName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$collectionName' => 'The collection name of the knowledge base in MongoDB Atlas.
', ], ], 'MongoDbAtlasConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
', 'refs' => [ 'StorageConfiguration$mongoDbAtlasConfiguration' => 'Contains the storage configuration of the knowledge base in MongoDB Atlas.
', ], ], 'MongoDbAtlasDatabaseName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$databaseName' => 'The database name in your MongoDB Atlas cluster for your knowledge base.
', ], ], 'MongoDbAtlasEndpoint' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$endpoint' => 'The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
', ], ], 'MongoDbAtlasEndpointServiceName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$endpointServiceName' => 'The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
', ], ], 'MongoDbAtlasFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'MongoDbAtlasConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'MongoDbAtlasIndexName' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$vectorIndexName' => 'The name of the MongoDB Atlas vector search index.
', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'ActionGroupSummary$actionGroupName' => 'The name of the action group.
', 'Agent$agentName' => 'The name of the agent.
', 'AgentActionGroup$actionGroupName' => 'The name of the action group.
', 'AgentAlias$agentAliasName' => 'The name of the alias of the agent.
', 'AgentAliasSummary$agentAliasName' => 'The name of the alias.
', 'AgentSummary$agentName' => 'The name of the agent.
', 'AgentVersion$agentName' => 'The name of the agent that the version belongs to.
', 'AgentVersionSummary$agentName' => 'The name of the agent to which the version belongs.
', 'CreateAgentActionGroupRequest$actionGroupName' => 'The name to give the action group.
', 'CreateAgentAliasRequest$agentAliasName' => 'The name of the alias.
', 'CreateAgentRequest$agentName' => 'A name for the agent that you create.
', 'CreateDataSourceRequest$name' => 'The name of the data source.
', 'CreateKnowledgeBaseRequest$name' => 'A name for the knowledge base.
', 'DataSource$name' => 'The name of the data source.
', 'DataSourceSummary$name' => 'The name of the data source.
', 'Function$name' => 'A name for the function.
', 'KnowledgeBase$name' => 'The name of the knowledge base.
', 'KnowledgeBaseSummary$name' => 'The name of the knowledge base.
', 'ParameterMap$key' => NULL, 'UpdateAgentActionGroupRequest$actionGroupName' => 'Specifies a new name for the action group.
', 'UpdateAgentAliasRequest$agentAliasName' => 'Specifies a new name for the alias.
', 'UpdateAgentRequest$agentName' => 'Specifies a new name for the agent.
', 'UpdateDataSourceRequest$name' => 'Specifies a new name for the data source.
', 'UpdateKnowledgeBaseRequest$name' => 'Specifies a new name for the knowledge base.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListAgentActionGroupsRequest$nextToken' => 'If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
A message describing why this field failed validation.
', 'ValidationExceptionField$name' => 'The name of the field.
', ], ], 'NumericalVersion' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$version' => 'The version number.
', 'DeleteAgentVersionRequest$agentVersion' => 'The version of the agent to delete.
', 'DeleteAgentVersionResponse$agentVersion' => 'The version that was deleted.
', 'GetAgentVersionRequest$agentVersion' => 'The version of the agent.
', ], ], 'OpenSearchServerlessCollectionArn' => [ 'base' => NULL, 'refs' => [ 'OpenSearchServerlessConfiguration$collectionArn' => 'The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
', ], ], 'OpenSearchServerlessConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
', 'refs' => [ 'StorageConfiguration$opensearchServerlessConfiguration' => 'Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
', ], ], 'OpenSearchServerlessFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'OpenSearchServerlessConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'OpenSearchServerlessIndexName' => [ 'base' => NULL, 'refs' => [ 'OpenSearchServerlessConfiguration$vectorIndexName' => 'The name of the vector store.
', ], ], 'ParameterDescription' => [ 'base' => NULL, 'refs' => [ 'ParameterDetail$description' => 'A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
', ], ], 'ParameterDetail' => [ 'base' => 'Contains details about a parameter in a function for an action group.
This data type is used in the following API operations:
The parameters that the agent elicits from the user to fulfill the function.
', ], ], 'Payload' => [ 'base' => NULL, 'refs' => [ 'APISchema$payload' => 'The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
', ], ], 'PineconeConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
', 'refs' => [ 'StorageConfiguration$pineconeConfiguration' => 'Contains the storage configuration of the knowledge base in Pinecone.
', ], ], 'PineconeConnectionString' => [ 'base' => NULL, 'refs' => [ 'PineconeConfiguration$connectionString' => 'The endpoint URL for your index management page.
', ], ], 'PineconeFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'PineconeConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'PineconeNamespace' => [ 'base' => NULL, 'refs' => [ 'PineconeConfiguration$namespace' => 'The namespace to be used to write new data to your database.
', ], ], 'PrepareAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'PrepareAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'PrimitiveLong' => [ 'base' => NULL, 'refs' => [ 'IngestionJobStatistics$numberOfDocumentsDeleted' => 'The number of source documents that was deleted.
', 'IngestionJobStatistics$numberOfDocumentsFailed' => 'The number of source documents that failed to be ingested.
', 'IngestionJobStatistics$numberOfDocumentsScanned' => 'The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
', 'IngestionJobStatistics$numberOfMetadataDocumentsModified' => 'The number of metadata files that were updated or deleted.
', 'IngestionJobStatistics$numberOfMetadataDocumentsScanned' => 'The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
', 'IngestionJobStatistics$numberOfModifiedDocumentsIndexed' => 'The number of modified source documents in the data source that were successfully indexed.
', 'IngestionJobStatistics$numberOfNewDocumentsIndexed' => 'The number of new source documents in the data source that were successfully indexed.
', ], ], 'PromptConfiguration' => [ 'base' => 'Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
', 'refs' => [ 'PromptConfigurations$member' => NULL, ], ], 'PromptConfigurations' => [ 'base' => NULL, 'refs' => [ 'PromptOverrideConfiguration$promptConfigurations' => 'Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
', ], ], 'PromptOverrideConfiguration' => [ 'base' => 'Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
', 'refs' => [ 'Agent$promptOverrideConfiguration' => 'Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
', 'AgentVersion$promptOverrideConfiguration' => 'Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
', 'CreateAgentRequest$promptOverrideConfiguration' => 'Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
', 'UpdateAgentRequest$promptOverrideConfiguration' => 'Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
', ], ], 'PromptState' => [ 'base' => NULL, 'refs' => [ 'PromptConfiguration$promptState' => 'Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
PRE_PROCESSING – ENABLED
ORCHESTRATION – ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
POST_PROCESSING – DISABLED
The step in the agent sequence that this prompt configuration applies to.
', ], ], 'ProvisionedModelIdentifier' => [ 'base' => NULL, 'refs' => [ 'AgentAliasRoutingConfigurationListItem$provisionedThroughput' => 'Information on the Provisioned Throughput assigned to an agent alias.
', ], ], 'RdsArn' => [ 'base' => NULL, 'refs' => [ 'RdsConfiguration$resourceArn' => 'The Amazon Resource Name (ARN) of the vector store.
', ], ], 'RdsConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
', 'refs' => [ 'StorageConfiguration$rdsConfiguration' => 'Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
', ], ], 'RdsDatabaseName' => [ 'base' => NULL, 'refs' => [ 'RdsConfiguration$databaseName' => 'The name of your Amazon RDS database.
', ], ], 'RdsFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'RdsConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'RdsTableName' => [ 'base' => NULL, 'refs' => [ 'RdsConfiguration$tableName' => 'The name of the table in the database.
', ], ], 'RecommendedAction' => [ 'base' => NULL, 'refs' => [ 'RecommendedActions$member' => NULL, ], ], 'RecommendedActions' => [ 'base' => NULL, 'refs' => [ 'Agent$recommendedActions' => 'Contains recommended actions to take for the agent-related API that you invoked to succeed.
', 'AgentVersion$recommendedActions' => 'A list of recommended actions to take for the failed API operation on the version to succeed.
', ], ], 'RedisEnterpriseCloudConfiguration' => [ 'base' => 'Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
', 'refs' => [ 'StorageConfiguration$redisEnterpriseCloudConfiguration' => 'Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
', ], ], 'RedisEnterpriseCloudEndpoint' => [ 'base' => NULL, 'refs' => [ 'RedisEnterpriseCloudConfiguration$endpoint' => 'The endpoint URL of the Redis Enterprise Cloud database.
', ], ], 'RedisEnterpriseCloudFieldMapping' => [ 'base' => 'Contains the names of the fields to which to map information about the vector store.
', 'refs' => [ 'RedisEnterpriseCloudConfiguration$fieldMapping' => 'Contains the names of the fields to which to map information about the vector store.
', ], ], 'RedisEnterpriseCloudIndexName' => [ 'base' => NULL, 'refs' => [ 'RedisEnterpriseCloudConfiguration$vectorIndexName' => 'The name of the vector index.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
', 'refs' => [], ], 'S3BucketArn' => [ 'base' => NULL, 'refs' => [ 'S3DataSourceConfiguration$bucketArn' => 'The Amazon Resource Name (ARN) of the bucket that contains the data source.
', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'S3Identifier$s3BucketName' => 'The name of the S3 bucket.
', ], ], 'S3DataSourceConfiguration' => [ 'base' => 'Contains information about the S3 configuration of the data source.
', 'refs' => [ 'DataSourceConfiguration$s3Configuration' => 'Contains details about the configuration of the S3 object containing the data source.
', ], ], 'S3Identifier' => [ 'base' => 'Contains information about the S3 object containing the resource.
', 'refs' => [ 'APISchema$s3' => 'Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
', ], ], 'S3ObjectKey' => [ 'base' => NULL, 'refs' => [ 'S3Identifier$s3ObjectKey' => 'The S3 object key containing the resource.
', ], ], 'S3Prefix' => [ 'base' => NULL, 'refs' => [ 'S3Prefixes$member' => NULL, ], ], 'S3Prefixes' => [ 'base' => NULL, 'refs' => [ 'S3DataSourceConfiguration$inclusionPrefixes' => 'A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'MongoDbAtlasConfiguration$credentialsSecretArn' => 'The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
', 'PineconeConfiguration$credentialsSecretArn' => 'The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
', 'RdsConfiguration$credentialsSecretArn' => 'The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
', 'RedisEnterpriseCloudConfiguration$credentialsSecretArn' => 'The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
', ], ], 'ServerSideEncryptionConfiguration' => [ 'base' => 'Contains the configuration for server-side encryption.
', 'refs' => [ 'CreateDataSourceRequest$serverSideEncryptionConfiguration' => 'Contains details about the server-side encryption for the data source.
', 'DataSource$serverSideEncryptionConfiguration' => 'Contains details about the configuration of the server-side encryption.
', 'UpdateDataSourceRequest$serverSideEncryptionConfiguration' => 'Contains details about server-side encryption of the data source.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'The number of requests exceeds the service quota. Resubmit your request later.
', 'refs' => [], ], 'SessionTTL' => [ 'base' => NULL, 'refs' => [ 'Agent$idleSessionTTLInSeconds' => 'The number of seconds for which Amazon Bedrock keeps information about a user\'s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
', 'AgentVersion$idleSessionTTLInSeconds' => 'The number of seconds for which Amazon Bedrock keeps information about a user\'s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
', 'CreateAgentRequest$idleSessionTTLInSeconds' => 'The number of seconds for which Amazon Bedrock keeps information about a user\'s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
', 'UpdateAgentRequest$idleSessionTTLInSeconds' => 'The number of seconds for which Amazon Bedrock keeps information about a user\'s conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'IngestionJobSortBy$order' => 'The order by which to sort the results.
', ], ], 'StartIngestionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartIngestionJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSequences' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$stopSequences' => 'A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
', ], ], 'StorageConfiguration' => [ 'base' => 'Contains the storage configuration of the knowledge base.
', 'refs' => [ 'CreateKnowledgeBaseRequest$storageConfiguration' => 'Contains details about the configuration of the vector database used for the knowledge base.
', 'KnowledgeBase$storageConfiguration' => 'Contains details about the storage configuration of the knowledge base.
', 'UpdateKnowledgeBaseRequest$storageConfiguration' => 'Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'StopSequences$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagsMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'A list of keys of the tags to remove from the resource.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagsMap$value' => NULL, ], ], 'TaggableResourcesArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource for which to list tags.
', 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource to tag.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource from which to remove tags.
', ], ], 'TagsMap' => [ 'base' => NULL, 'refs' => [ 'CreateAgentAliasRequest$tags' => 'Any tags that you want to attach to the alias of the agent.
', 'CreateAgentRequest$tags' => 'Any tags that you want to attach to the agent.
', 'CreateKnowledgeBaseRequest$tags' => 'Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
', 'ListTagsForResourceResponse$tags' => 'The key-value pairs for the tags associated with the resource.
', 'TagResourceRequest$tags' => 'An object containing key-value pairs that define the tags to attach to the resource.
', ], ], 'Temperature' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$temperature' => 'The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
', ], ], 'ThrottlingException' => [ 'base' => 'The number of requests exceeds the limit. Resubmit your request later.
', 'refs' => [], ], 'TopK' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topK' => 'While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
The data type of the parameter.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentActionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentActionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'Input validation failed. Check your request parameters and retry the request.
', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => 'Stores information about a field passed inside a request that resulted in an validation error.
', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fieldList' => 'A list of objects containing fields that caused validation errors and their corresponding validation error messages.
', ], ], 'VectorIngestionConfiguration' => [ 'base' => 'Contains details about how to ingest the documents in a data source.
', 'refs' => [ 'CreateDataSourceRequest$vectorIngestionConfiguration' => 'Contains details about how to ingest the documents in the data source.
', 'DataSource$vectorIngestionConfiguration' => 'Contains details about how to ingest the documents in the data source.
', 'UpdateDataSourceRequest$vectorIngestionConfiguration' => 'Contains details about how to ingest the documents in the data source.
', ], ], 'VectorKnowledgeBaseConfiguration' => [ 'base' => 'Contains details about the model used to create vector embeddings for the knowledge base.
', 'refs' => [ 'KnowledgeBaseConfiguration$vectorKnowledgeBaseConfiguration' => 'Contains details about the embeddings model that\'sused to convert the data source.
', ], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'AgentActionGroup$agentVersion' => 'The version of the agent to which the action group belongs.
', 'AgentAliasRoutingConfigurationListItem$agentVersion' => 'The version of the agent with which the alias is associated.
', 'AgentKnowledgeBase$agentVersion' => 'The version of the agent with which the knowledge base is associated.
', 'AgentSummary$latestAgentVersion' => 'The latest version of the agent.
', 'AgentVersionSummary$agentVersion' => 'The version of the agent.
', 'GetAgentActionGroupRequest$agentVersion' => 'The version of the agent that the action group belongs to.
', 'GetAgentKnowledgeBaseRequest$agentVersion' => 'The version of the agent with which the knowledge base is associated.
', 'ListAgentActionGroupsRequest$agentVersion' => 'The version of the agent.
', 'ListAgentKnowledgeBasesRequest$agentVersion' => 'The version of the agent for which to return information about knowledge bases associated with it.
', 'PrepareAgentResponse$agentVersion' => 'The version of the agent.
', ], ], ],]; diff --git a/src/data/controltower/2018-05-10/api-2.json b/src/data/controltower/2018-05-10/api-2.json index caf37c13de..2e849db44d 100644 --- a/src/data/controltower/2018-05-10/api-2.json +++ b/src/data/controltower/2018-05-10/api-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"controltower", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS Control Tower", "serviceId":"ControlTower", "signatureVersion":"v4", @@ -260,6 +261,22 @@ {"shape":"ThrottlingException"} ] }, + "ListControlOperations":{ + "name":"ListControlOperations", + "http":{ + "method":"POST", + "requestUri":"/list-control-operations", + "responseCode":200 + }, + "input":{"shape":"ListControlOperationsInput"}, + "output":{"shape":"ListControlOperationsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ] + }, "ListEnabledBaselines":{ "name":"ListEnabledBaselines", "http":{ @@ -539,14 +556,34 @@ "min":20, "pattern":"^arn:aws[0-9a-zA-Z_\\-:\\/]+$" }, + "ControlIdentifiers":{ + "type":"list", + "member":{"shape":"ControlIdentifier"}, + "max":1, + "min":1 + }, "ControlOperation":{ "type":"structure", "members":{ + "controlIdentifier":{"shape":"ControlIdentifier"}, + "enabledControlIdentifier":{"shape":"Arn"}, "endTime":{"shape":"SyntheticTimestamp_date_time"}, + "operationIdentifier":{"shape":"OperationIdentifier"}, "operationType":{"shape":"ControlOperationType"}, "startTime":{"shape":"SyntheticTimestamp_date_time"}, "status":{"shape":"ControlOperationStatus"}, - "statusMessage":{"shape":"String"} + "statusMessage":{"shape":"String"}, + "targetIdentifier":{"shape":"TargetIdentifier"} + } + }, + "ControlOperationFilter":{ + "type":"structure", + "members":{ + "controlIdentifiers":{"shape":"ControlIdentifiers"}, + "controlOperationTypes":{"shape":"ControlOperationTypes"}, + "enabledControlIdentifiers":{"shape":"EnabledControlIdentifiers"}, + "statuses":{"shape":"ControlOperationStatuses"}, + "targetIdentifiers":{"shape":"TargetIdentifiers"} } }, "ControlOperationStatus":{ @@ -557,6 +594,26 @@ "IN_PROGRESS" ] }, + "ControlOperationStatuses":{ + "type":"list", + "member":{"shape":"ControlOperationStatus"}, + "max":1, + "min":1 + }, + "ControlOperationSummary":{ + "type":"structure", + "members":{ + "controlIdentifier":{"shape":"ControlIdentifier"}, + "enabledControlIdentifier":{"shape":"Arn"}, + "endTime":{"shape":"SyntheticTimestamp_date_time"}, + "operationIdentifier":{"shape":"OperationIdentifier"}, + "operationType":{"shape":"ControlOperationType"}, + "startTime":{"shape":"SyntheticTimestamp_date_time"}, + "status":{"shape":"ControlOperationStatus"}, + "statusMessage":{"shape":"String"}, + "targetIdentifier":{"shape":"TargetIdentifier"} + } + }, "ControlOperationType":{ "type":"string", "enum":[ @@ -565,6 +622,16 @@ "UPDATE_ENABLED_CONTROL" ] }, + "ControlOperationTypes":{ + "type":"list", + "member":{"shape":"ControlOperationType"}, + "max":1, + "min":1 + }, + "ControlOperations":{ + "type":"list", + "member":{"shape":"ControlOperationSummary"} + }, "CreateLandingZoneInput":{ "type":"structure", "required":[ @@ -655,6 +722,12 @@ "driftStatus":{"shape":"DriftStatus"} } }, + "DriftStatuses":{ + "type":"list", + "member":{"shape":"DriftStatus"}, + "max":1, + "min":1 + }, "EnableBaselineInput":{ "type":"structure", "required":[ @@ -806,6 +879,20 @@ "targetRegions":{"shape":"TargetRegions"} } }, + "EnabledControlFilter":{ + "type":"structure", + "members":{ + "controlIdentifiers":{"shape":"ControlIdentifiers"}, + "driftStatuses":{"shape":"DriftStatuses"}, + "statuses":{"shape":"EnablementStatuses"} + } + }, + "EnabledControlIdentifiers":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":1, + "min":1 + }, "EnabledControlParameter":{ "type":"structure", "required":[ @@ -865,6 +952,12 @@ "status":{"shape":"EnablementStatus"} } }, + "EnablementStatuses":{ + "type":"list", + "member":{"shape":"EnablementStatus"}, + "max":1, + "min":1 + }, "GetBaselineInput":{ "type":"structure", "required":["baselineIdentifier"], @@ -1078,6 +1171,32 @@ "nextToken":{"shape":"String"} } }, + "ListControlOperationsInput":{ + "type":"structure", + "members":{ + "filter":{"shape":"ControlOperationFilter"}, + "maxResults":{"shape":"ListControlOperationsMaxResults"}, + "nextToken":{"shape":"ListControlOperationsNextToken"} + } + }, + "ListControlOperationsMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListControlOperationsNextToken":{ + "type":"string", + "pattern":"\\S+" + }, + "ListControlOperationsOutput":{ + "type":"structure", + "required":["controlOperations"], + "members":{ + "controlOperations":{"shape":"ControlOperations"}, + "nextToken":{"shape":"ListControlOperationsNextToken"} + } + }, "ListEnabledBaselinesInput":{ "type":"structure", "members":{ @@ -1106,8 +1225,8 @@ }, "ListEnabledControlsInput":{ "type":"structure", - "required":["targetIdentifier"], "members":{ + "filter":{"shape":"EnabledControlFilter"}, "maxResults":{"shape":"MaxResults"}, "nextToken":{"shape":"String"}, "targetIdentifier":{"shape":"TargetIdentifier"} @@ -1301,6 +1420,12 @@ "min":20, "pattern":"^arn:aws[0-9a-zA-Z_\\-:\\/]+$" }, + "TargetIdentifiers":{ + "type":"list", + "member":{"shape":"TargetIdentifier"}, + "max":1, + "min":1 + }, "TargetRegions":{ "type":"list", "member":{"shape":"Region"} diff --git a/src/data/controltower/2018-05-10/api-2.json.php b/src/data/controltower/2018-05-10/api-2.json.php index a7a0f6d89b..4b4d3e253a 100644 --- a/src/data/controltower/2018-05-10/api-2.json.php +++ b/src/data/controltower/2018-05-10/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2018-05-10', 'endpointPrefix' => 'controltower', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'AWS Control Tower', 'serviceId' => 'ControlTower', 'signatureVersion' => 'v4', 'signingName' => 'controltower', 'uid' => 'controltower-2018-05-10', ], 'operations' => [ 'CreateLandingZone' => [ 'name' => 'CreateLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateLandingZoneInput', ], 'output' => [ 'shape' => 'CreateLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteLandingZone' => [ 'name' => 'DeleteLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteLandingZoneInput', ], 'output' => [ 'shape' => 'DeleteLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DisableBaseline' => [ 'name' => 'DisableBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/disable-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisableBaselineInput', ], 'output' => [ 'shape' => 'DisableBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DisableControl' => [ 'name' => 'DisableControl', 'http' => [ 'method' => 'POST', 'requestUri' => '/disable-control', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisableControlInput', ], 'output' => [ 'shape' => 'DisableControlOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'EnableBaseline' => [ 'name' => 'EnableBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/enable-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'EnableBaselineInput', ], 'output' => [ 'shape' => 'EnableBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'EnableControl' => [ 'name' => 'EnableControl', 'http' => [ 'method' => 'POST', 'requestUri' => '/enable-control', 'responseCode' => 200, ], 'input' => [ 'shape' => 'EnableControlInput', ], 'output' => [ 'shape' => 'EnableControlOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetBaseline' => [ 'name' => 'GetBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetBaselineInput', ], 'output' => [ 'shape' => 'GetBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetBaselineOperation' => [ 'name' => 'GetBaselineOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-baseline-operation', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetBaselineOperationInput', ], 'output' => [ 'shape' => 'GetBaselineOperationOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetControlOperation' => [ 'name' => 'GetControlOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-control-operation', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetControlOperationInput', ], 'output' => [ 'shape' => 'GetControlOperationOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetEnabledBaseline' => [ 'name' => 'GetEnabledBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-enabled-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetEnabledBaselineInput', ], 'output' => [ 'shape' => 'GetEnabledBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetEnabledControl' => [ 'name' => 'GetEnabledControl', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-enabled-control', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetEnabledControlInput', ], 'output' => [ 'shape' => 'GetEnabledControlOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetLandingZone' => [ 'name' => 'GetLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetLandingZoneInput', ], 'output' => [ 'shape' => 'GetLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetLandingZoneOperation' => [ 'name' => 'GetLandingZoneOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-landingzone-operation', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetLandingZoneOperationInput', ], 'output' => [ 'shape' => 'GetLandingZoneOperationOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListBaselines' => [ 'name' => 'ListBaselines', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-baselines', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListBaselinesInput', ], 'output' => [ 'shape' => 'ListBaselinesOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListEnabledBaselines' => [ 'name' => 'ListEnabledBaselines', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-enabled-baselines', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListEnabledBaselinesInput', ], 'output' => [ 'shape' => 'ListEnabledBaselinesOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListEnabledControls' => [ 'name' => 'ListEnabledControls', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-enabled-controls', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListEnabledControlsInput', ], 'output' => [ 'shape' => 'ListEnabledControlsOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListLandingZones' => [ 'name' => 'ListLandingZones', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-landingzones', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListLandingZonesInput', ], 'output' => [ 'shape' => 'ListLandingZonesOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceInput', ], 'output' => [ 'shape' => 'ListTagsForResourceOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ResetEnabledBaseline' => [ 'name' => 'ResetEnabledBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/reset-enabled-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ResetEnabledBaselineInput', ], 'output' => [ 'shape' => 'ResetEnabledBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ResetLandingZone' => [ 'name' => 'ResetLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/reset-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ResetLandingZoneInput', ], 'output' => [ 'shape' => 'ResetLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'TagResourceInput', ], 'output' => [ 'shape' => 'TagResourceOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UntagResourceInput', ], 'output' => [ 'shape' => 'UntagResourceOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateEnabledBaseline' => [ 'name' => 'UpdateEnabledBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-enabled-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateEnabledBaselineInput', ], 'output' => [ 'shape' => 'UpdateEnabledBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateEnabledControl' => [ 'name' => 'UpdateEnabledControl', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-enabled-control', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateEnabledControlInput', ], 'output' => [ 'shape' => 'UpdateEnabledControlOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateLandingZone' => [ 'name' => 'UpdateLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateLandingZoneInput', ], 'output' => [ 'shape' => 'UpdateLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'Arn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[0-9a-zA-Z_\\-:\\/]+$', ], 'BaselineArn' => [ 'type' => 'string', 'pattern' => '^arn:[a-z-]+:controltower:[a-z0-9-]*:[0-9]{0,12}:baseline/[A-Z0-9]{16}$', ], 'BaselineOperation' => [ 'type' => 'structure', 'members' => [ 'endTime' => [ 'shape' => 'Timestamp', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], 'operationType' => [ 'shape' => 'BaselineOperationType', ], 'startTime' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'BaselineOperationStatus', ], 'statusMessage' => [ 'shape' => 'String', ], ], ], 'BaselineOperationStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'IN_PROGRESS', ], ], 'BaselineOperationType' => [ 'type' => 'string', 'enum' => [ 'ENABLE_BASELINE', 'DISABLE_BASELINE', 'UPDATE_ENABLED_BASELINE', 'RESET_ENABLED_BASELINE', ], ], 'BaselineSummary' => [ 'type' => 'structure', 'required' => [ 'arn', 'name', ], 'members' => [ 'arn' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], ], ], 'BaselineVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 1, 'pattern' => '^\\d+(?:\\.\\d+){0,2}$', ], 'Baselines' => [ 'type' => 'list', 'member' => [ 'shape' => 'BaselineSummary', ], ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'ControlIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[0-9a-zA-Z_\\-:\\/]+$', ], 'ControlOperation' => [ 'type' => 'structure', 'members' => [ 'endTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'operationType' => [ 'shape' => 'ControlOperationType', ], 'startTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'status' => [ 'shape' => 'ControlOperationStatus', ], 'statusMessage' => [ 'shape' => 'String', ], ], ], 'ControlOperationStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'IN_PROGRESS', ], ], 'ControlOperationType' => [ 'type' => 'string', 'enum' => [ 'ENABLE_CONTROL', 'DISABLE_CONTROL', 'UPDATE_ENABLED_CONTROL', ], ], 'CreateLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'manifest', 'version', ], 'members' => [ 'manifest' => [ 'shape' => 'Manifest', ], 'tags' => [ 'shape' => 'TagMap', ], 'version' => [ 'shape' => 'LandingZoneVersion', ], ], ], 'CreateLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'arn', 'operationIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'DeleteLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'landingZoneIdentifier', ], 'members' => [ 'landingZoneIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'DisableBaselineInput' => [ 'type' => 'structure', 'required' => [ 'enabledBaselineIdentifier', ], 'members' => [ 'enabledBaselineIdentifier' => [ 'shape' => 'Arn', ], ], ], 'DisableBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'DisableControlInput' => [ 'type' => 'structure', 'required' => [ 'controlIdentifier', 'targetIdentifier', ], 'members' => [ 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'DisableControlOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'Document' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'DriftStatus' => [ 'type' => 'string', 'enum' => [ 'DRIFTED', 'IN_SYNC', 'NOT_CHECKING', 'UNKNOWN', ], ], 'DriftStatusSummary' => [ 'type' => 'structure', 'members' => [ 'driftStatus' => [ 'shape' => 'DriftStatus', ], ], ], 'EnableBaselineInput' => [ 'type' => 'structure', 'required' => [ 'baselineIdentifier', 'baselineVersion', 'targetIdentifier', ], 'members' => [ 'baselineIdentifier' => [ 'shape' => 'Arn', ], 'baselineVersion' => [ 'shape' => 'BaselineVersion', ], 'parameters' => [ 'shape' => 'EnabledBaselineParameters', ], 'tags' => [ 'shape' => 'TagMap', ], 'targetIdentifier' => [ 'shape' => 'Arn', ], ], ], 'EnableBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'arn', 'operationIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'EnableControlInput' => [ 'type' => 'structure', 'required' => [ 'controlIdentifier', 'targetIdentifier', ], 'members' => [ 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'parameters' => [ 'shape' => 'EnabledControlParameters', ], 'tags' => [ 'shape' => 'TagMap', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'EnableControlOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'EnabledBaselineBaselineIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 5, 'min' => 1, ], 'EnabledBaselineDetails' => [ 'type' => 'structure', 'required' => [ 'arn', 'baselineIdentifier', 'statusSummary', 'targetIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'baselineIdentifier' => [ 'shape' => 'String', ], 'baselineVersion' => [ 'shape' => 'String', ], 'parameters' => [ 'shape' => 'EnabledBaselineParameterSummaries', ], 'statusSummary' => [ 'shape' => 'EnablementStatusSummary', ], 'targetIdentifier' => [ 'shape' => 'String', ], ], ], 'EnabledBaselineFilter' => [ 'type' => 'structure', 'members' => [ 'baselineIdentifiers' => [ 'shape' => 'EnabledBaselineBaselineIdentifiers', ], 'targetIdentifiers' => [ 'shape' => 'EnabledBaselineTargetIdentifiers', ], ], ], 'EnabledBaselineParameter' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'EnabledBaselineParameterDocument', ], ], ], 'EnabledBaselineParameterDocument' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'EnabledBaselineParameterSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledBaselineParameterSummary', ], ], 'EnabledBaselineParameterSummary' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'EnabledBaselineParameterDocument', ], ], ], 'EnabledBaselineParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledBaselineParameter', ], ], 'EnabledBaselineSummary' => [ 'type' => 'structure', 'required' => [ 'arn', 'baselineIdentifier', 'statusSummary', 'targetIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'baselineIdentifier' => [ 'shape' => 'String', ], 'baselineVersion' => [ 'shape' => 'String', ], 'statusSummary' => [ 'shape' => 'EnablementStatusSummary', ], 'targetIdentifier' => [ 'shape' => 'String', ], ], ], 'EnabledBaselineTargetIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 5, 'min' => 1, ], 'EnabledBaselines' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledBaselineSummary', ], ], 'EnabledControlDetails' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'driftStatusSummary' => [ 'shape' => 'DriftStatusSummary', ], 'parameters' => [ 'shape' => 'EnabledControlParameterSummaries', ], 'statusSummary' => [ 'shape' => 'EnablementStatusSummary', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], 'targetRegions' => [ 'shape' => 'TargetRegions', ], ], ], 'EnabledControlParameter' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'Document', ], ], ], 'EnabledControlParameterSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledControlParameterSummary', ], ], 'EnabledControlParameterSummary' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'Document', ], ], ], 'EnabledControlParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledControlParameter', ], ], 'EnabledControlSummary' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'driftStatusSummary' => [ 'shape' => 'DriftStatusSummary', ], 'statusSummary' => [ 'shape' => 'EnablementStatusSummary', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'EnabledControls' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledControlSummary', ], ], 'EnablementStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'UNDER_CHANGE', ], ], 'EnablementStatusSummary' => [ 'type' => 'structure', 'members' => [ 'lastOperationIdentifier' => [ 'shape' => 'OperationIdentifier', ], 'status' => [ 'shape' => 'EnablementStatus', ], ], ], 'GetBaselineInput' => [ 'type' => 'structure', 'required' => [ 'baselineIdentifier', ], 'members' => [ 'baselineIdentifier' => [ 'shape' => 'BaselineArn', ], ], ], 'GetBaselineOperationInput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'GetBaselineOperationOutput' => [ 'type' => 'structure', 'required' => [ 'baselineOperation', ], 'members' => [ 'baselineOperation' => [ 'shape' => 'BaselineOperation', ], ], ], 'GetBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'arn', 'name', ], 'members' => [ 'arn' => [ 'shape' => 'BaselineArn', ], 'description' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], ], ], 'GetControlOperationInput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'GetControlOperationOutput' => [ 'type' => 'structure', 'required' => [ 'controlOperation', ], 'members' => [ 'controlOperation' => [ 'shape' => 'ControlOperation', ], ], ], 'GetEnabledBaselineInput' => [ 'type' => 'structure', 'required' => [ 'enabledBaselineIdentifier', ], 'members' => [ 'enabledBaselineIdentifier' => [ 'shape' => 'Arn', ], ], ], 'GetEnabledBaselineOutput' => [ 'type' => 'structure', 'members' => [ 'enabledBaselineDetails' => [ 'shape' => 'EnabledBaselineDetails', ], ], ], 'GetEnabledControlInput' => [ 'type' => 'structure', 'required' => [ 'enabledControlIdentifier', ], 'members' => [ 'enabledControlIdentifier' => [ 'shape' => 'Arn', ], ], ], 'GetEnabledControlOutput' => [ 'type' => 'structure', 'required' => [ 'enabledControlDetails', ], 'members' => [ 'enabledControlDetails' => [ 'shape' => 'EnabledControlDetails', ], ], ], 'GetLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'landingZoneIdentifier', ], 'members' => [ 'landingZoneIdentifier' => [ 'shape' => 'String', ], ], ], 'GetLandingZoneOperationInput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'GetLandingZoneOperationOutput' => [ 'type' => 'structure', 'required' => [ 'operationDetails', ], 'members' => [ 'operationDetails' => [ 'shape' => 'LandingZoneOperationDetail', ], ], ], 'GetLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'landingZone', ], 'members' => [ 'landingZone' => [ 'shape' => 'LandingZoneDetail', ], ], ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, 'retryable' => [ 'throttling' => false, ], ], 'LandingZoneDetail' => [ 'type' => 'structure', 'required' => [ 'manifest', 'version', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'driftStatus' => [ 'shape' => 'LandingZoneDriftStatusSummary', ], 'latestAvailableVersion' => [ 'shape' => 'LandingZoneVersion', ], 'manifest' => [ 'shape' => 'Manifest', ], 'status' => [ 'shape' => 'LandingZoneStatus', ], 'version' => [ 'shape' => 'LandingZoneVersion', ], ], ], 'LandingZoneDriftStatus' => [ 'type' => 'string', 'enum' => [ 'DRIFTED', 'IN_SYNC', ], ], 'LandingZoneDriftStatusSummary' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'LandingZoneDriftStatus', ], ], ], 'LandingZoneOperationDetail' => [ 'type' => 'structure', 'members' => [ 'endTime' => [ 'shape' => 'Timestamp', ], 'operationType' => [ 'shape' => 'LandingZoneOperationType', ], 'startTime' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'LandingZoneOperationStatus', ], 'statusMessage' => [ 'shape' => 'String', ], ], ], 'LandingZoneOperationStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'IN_PROGRESS', ], ], 'LandingZoneOperationType' => [ 'type' => 'string', 'enum' => [ 'DELETE', 'CREATE', 'UPDATE', 'RESET', ], ], 'LandingZoneStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'PROCESSING', 'FAILED', ], ], 'LandingZoneSummary' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], ], ], 'LandingZoneVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '^\\d+.\\d+$', ], 'ListBaselinesInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListBaselinesMaxResults', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListBaselinesMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 4, ], 'ListBaselinesOutput' => [ 'type' => 'structure', 'required' => [ 'baselines', ], 'members' => [ 'baselines' => [ 'shape' => 'Baselines', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListEnabledBaselinesInput' => [ 'type' => 'structure', 'members' => [ 'filter' => [ 'shape' => 'EnabledBaselineFilter', ], 'maxResults' => [ 'shape' => 'ListEnabledBaselinesMaxResults', ], 'nextToken' => [ 'shape' => 'ListEnabledBaselinesNextToken', ], ], ], 'ListEnabledBaselinesMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 5, ], 'ListEnabledBaselinesNextToken' => [ 'type' => 'string', 'pattern' => '\\S+', ], 'ListEnabledBaselinesOutput' => [ 'type' => 'structure', 'required' => [ 'enabledBaselines', ], 'members' => [ 'enabledBaselines' => [ 'shape' => 'EnabledBaselines', ], 'nextToken' => [ 'shape' => 'ListEnabledBaselinesNextToken', ], ], ], 'ListEnabledControlsInput' => [ 'type' => 'structure', 'required' => [ 'targetIdentifier', ], 'members' => [ 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'String', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'ListEnabledControlsOutput' => [ 'type' => 'structure', 'required' => [ 'enabledControls', ], 'members' => [ 'enabledControls' => [ 'shape' => 'EnabledControls', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListLandingZonesInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListLandingZonesMaxResults', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListLandingZonesMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 1, 'min' => 1, ], 'ListLandingZonesOutput' => [ 'type' => 'structure', 'required' => [ 'landingZones', ], 'members' => [ 'landingZones' => [ 'shape' => 'ListLandingZonesOutputLandingZonesList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListLandingZonesOutputLandingZonesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LandingZoneSummary', ], 'max' => 1, 'min' => 0, ], 'ListTagsForResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceOutput' => [ 'type' => 'structure', 'required' => [ 'tags', ], 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'Manifest' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 200, 'min' => 1, ], 'OperationIdentifier' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'Region' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RegionName', ], ], ], 'RegionName' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'ResetEnabledBaselineInput' => [ 'type' => 'structure', 'required' => [ 'enabledBaselineIdentifier', ], 'members' => [ 'enabledBaselineIdentifier' => [ 'shape' => 'Arn', ], ], ], 'ResetEnabledBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'ResetLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'landingZoneIdentifier', ], 'members' => [ 'landingZoneIdentifier' => [ 'shape' => 'String', ], ], ], 'ResetLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'SyntheticTimestamp_date_time' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 200, 'min' => 0, ], 'TagResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TargetIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[0-9a-zA-Z_\\-:\\/]+$', ], 'TargetRegions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Region', ], ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'quotaCode' => [ 'shape' => 'String', ], 'retryAfterSeconds' => [ 'shape' => 'Integer', 'location' => 'header', 'locationName' => 'Retry-After', ], 'serviceCode' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, 'retryable' => [ 'throttling' => true, ], ], 'Timestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'UntagResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeys', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateEnabledBaselineInput' => [ 'type' => 'structure', 'required' => [ 'baselineVersion', 'enabledBaselineIdentifier', ], 'members' => [ 'baselineVersion' => [ 'shape' => 'BaselineVersion', ], 'enabledBaselineIdentifier' => [ 'shape' => 'Arn', ], 'parameters' => [ 'shape' => 'EnabledBaselineParameters', ], ], ], 'UpdateEnabledBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'UpdateEnabledControlInput' => [ 'type' => 'structure', 'required' => [ 'enabledControlIdentifier', 'parameters', ], 'members' => [ 'enabledControlIdentifier' => [ 'shape' => 'Arn', ], 'parameters' => [ 'shape' => 'EnabledControlParameters', ], ], ], 'UpdateEnabledControlOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'UpdateLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'landingZoneIdentifier', 'manifest', 'version', ], 'members' => [ 'landingZoneIdentifier' => [ 'shape' => 'String', ], 'manifest' => [ 'shape' => 'Manifest', ], 'version' => [ 'shape' => 'LandingZoneVersion', ], ], ], 'UpdateLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2018-05-10', 'endpointPrefix' => 'controltower', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'AWS Control Tower', 'serviceId' => 'ControlTower', 'signatureVersion' => 'v4', 'signingName' => 'controltower', 'uid' => 'controltower-2018-05-10', ], 'operations' => [ 'CreateLandingZone' => [ 'name' => 'CreateLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/create-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateLandingZoneInput', ], 'output' => [ 'shape' => 'CreateLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteLandingZone' => [ 'name' => 'DeleteLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/delete-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteLandingZoneInput', ], 'output' => [ 'shape' => 'DeleteLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DisableBaseline' => [ 'name' => 'DisableBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/disable-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisableBaselineInput', ], 'output' => [ 'shape' => 'DisableBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DisableControl' => [ 'name' => 'DisableControl', 'http' => [ 'method' => 'POST', 'requestUri' => '/disable-control', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisableControlInput', ], 'output' => [ 'shape' => 'DisableControlOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'EnableBaseline' => [ 'name' => 'EnableBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/enable-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'EnableBaselineInput', ], 'output' => [ 'shape' => 'EnableBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'EnableControl' => [ 'name' => 'EnableControl', 'http' => [ 'method' => 'POST', 'requestUri' => '/enable-control', 'responseCode' => 200, ], 'input' => [ 'shape' => 'EnableControlInput', ], 'output' => [ 'shape' => 'EnableControlOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetBaseline' => [ 'name' => 'GetBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetBaselineInput', ], 'output' => [ 'shape' => 'GetBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetBaselineOperation' => [ 'name' => 'GetBaselineOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-baseline-operation', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetBaselineOperationInput', ], 'output' => [ 'shape' => 'GetBaselineOperationOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetControlOperation' => [ 'name' => 'GetControlOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-control-operation', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetControlOperationInput', ], 'output' => [ 'shape' => 'GetControlOperationOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetEnabledBaseline' => [ 'name' => 'GetEnabledBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-enabled-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetEnabledBaselineInput', ], 'output' => [ 'shape' => 'GetEnabledBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetEnabledControl' => [ 'name' => 'GetEnabledControl', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-enabled-control', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetEnabledControlInput', ], 'output' => [ 'shape' => 'GetEnabledControlOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetLandingZone' => [ 'name' => 'GetLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetLandingZoneInput', ], 'output' => [ 'shape' => 'GetLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetLandingZoneOperation' => [ 'name' => 'GetLandingZoneOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/get-landingzone-operation', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetLandingZoneOperationInput', ], 'output' => [ 'shape' => 'GetLandingZoneOperationOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListBaselines' => [ 'name' => 'ListBaselines', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-baselines', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListBaselinesInput', ], 'output' => [ 'shape' => 'ListBaselinesOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListControlOperations' => [ 'name' => 'ListControlOperations', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-control-operations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListControlOperationsInput', ], 'output' => [ 'shape' => 'ListControlOperationsOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListEnabledBaselines' => [ 'name' => 'ListEnabledBaselines', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-enabled-baselines', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListEnabledBaselinesInput', ], 'output' => [ 'shape' => 'ListEnabledBaselinesOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListEnabledControls' => [ 'name' => 'ListEnabledControls', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-enabled-controls', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListEnabledControlsInput', ], 'output' => [ 'shape' => 'ListEnabledControlsOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListLandingZones' => [ 'name' => 'ListLandingZones', 'http' => [ 'method' => 'POST', 'requestUri' => '/list-landingzones', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListLandingZonesInput', ], 'output' => [ 'shape' => 'ListLandingZonesOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceInput', ], 'output' => [ 'shape' => 'ListTagsForResourceOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ResetEnabledBaseline' => [ 'name' => 'ResetEnabledBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/reset-enabled-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ResetEnabledBaselineInput', ], 'output' => [ 'shape' => 'ResetEnabledBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ResetLandingZone' => [ 'name' => 'ResetLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/reset-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ResetLandingZoneInput', ], 'output' => [ 'shape' => 'ResetLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'TagResourceInput', ], 'output' => [ 'shape' => 'TagResourceOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UntagResourceInput', ], 'output' => [ 'shape' => 'UntagResourceOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateEnabledBaseline' => [ 'name' => 'UpdateEnabledBaseline', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-enabled-baseline', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateEnabledBaselineInput', ], 'output' => [ 'shape' => 'UpdateEnabledBaselineOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateEnabledControl' => [ 'name' => 'UpdateEnabledControl', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-enabled-control', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateEnabledControlInput', ], 'output' => [ 'shape' => 'UpdateEnabledControlOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateLandingZone' => [ 'name' => 'UpdateLandingZone', 'http' => [ 'method' => 'POST', 'requestUri' => '/update-landingzone', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateLandingZoneInput', ], 'output' => [ 'shape' => 'UpdateLandingZoneOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'Arn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[0-9a-zA-Z_\\-:\\/]+$', ], 'BaselineArn' => [ 'type' => 'string', 'pattern' => '^arn:[a-z-]+:controltower:[a-z0-9-]*:[0-9]{0,12}:baseline/[A-Z0-9]{16}$', ], 'BaselineOperation' => [ 'type' => 'structure', 'members' => [ 'endTime' => [ 'shape' => 'Timestamp', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], 'operationType' => [ 'shape' => 'BaselineOperationType', ], 'startTime' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'BaselineOperationStatus', ], 'statusMessage' => [ 'shape' => 'String', ], ], ], 'BaselineOperationStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'IN_PROGRESS', ], ], 'BaselineOperationType' => [ 'type' => 'string', 'enum' => [ 'ENABLE_BASELINE', 'DISABLE_BASELINE', 'UPDATE_ENABLED_BASELINE', 'RESET_ENABLED_BASELINE', ], ], 'BaselineSummary' => [ 'type' => 'structure', 'required' => [ 'arn', 'name', ], 'members' => [ 'arn' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], ], ], 'BaselineVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 1, 'pattern' => '^\\d+(?:\\.\\d+){0,2}$', ], 'Baselines' => [ 'type' => 'list', 'member' => [ 'shape' => 'BaselineSummary', ], ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'ControlIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[0-9a-zA-Z_\\-:\\/]+$', ], 'ControlIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'ControlIdentifier', ], 'max' => 1, 'min' => 1, ], 'ControlOperation' => [ 'type' => 'structure', 'members' => [ 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'enabledControlIdentifier' => [ 'shape' => 'Arn', ], 'endTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], 'operationType' => [ 'shape' => 'ControlOperationType', ], 'startTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'status' => [ 'shape' => 'ControlOperationStatus', ], 'statusMessage' => [ 'shape' => 'String', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'ControlOperationFilter' => [ 'type' => 'structure', 'members' => [ 'controlIdentifiers' => [ 'shape' => 'ControlIdentifiers', ], 'controlOperationTypes' => [ 'shape' => 'ControlOperationTypes', ], 'enabledControlIdentifiers' => [ 'shape' => 'EnabledControlIdentifiers', ], 'statuses' => [ 'shape' => 'ControlOperationStatuses', ], 'targetIdentifiers' => [ 'shape' => 'TargetIdentifiers', ], ], ], 'ControlOperationStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'IN_PROGRESS', ], ], 'ControlOperationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'ControlOperationStatus', ], 'max' => 1, 'min' => 1, ], 'ControlOperationSummary' => [ 'type' => 'structure', 'members' => [ 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'enabledControlIdentifier' => [ 'shape' => 'Arn', ], 'endTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], 'operationType' => [ 'shape' => 'ControlOperationType', ], 'startTime' => [ 'shape' => 'SyntheticTimestamp_date_time', ], 'status' => [ 'shape' => 'ControlOperationStatus', ], 'statusMessage' => [ 'shape' => 'String', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'ControlOperationType' => [ 'type' => 'string', 'enum' => [ 'ENABLE_CONTROL', 'DISABLE_CONTROL', 'UPDATE_ENABLED_CONTROL', ], ], 'ControlOperationTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ControlOperationType', ], 'max' => 1, 'min' => 1, ], 'ControlOperations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ControlOperationSummary', ], ], 'CreateLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'manifest', 'version', ], 'members' => [ 'manifest' => [ 'shape' => 'Manifest', ], 'tags' => [ 'shape' => 'TagMap', ], 'version' => [ 'shape' => 'LandingZoneVersion', ], ], ], 'CreateLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'arn', 'operationIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'DeleteLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'landingZoneIdentifier', ], 'members' => [ 'landingZoneIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'DisableBaselineInput' => [ 'type' => 'structure', 'required' => [ 'enabledBaselineIdentifier', ], 'members' => [ 'enabledBaselineIdentifier' => [ 'shape' => 'Arn', ], ], ], 'DisableBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'DisableControlInput' => [ 'type' => 'structure', 'required' => [ 'controlIdentifier', 'targetIdentifier', ], 'members' => [ 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'DisableControlOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'Document' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'DriftStatus' => [ 'type' => 'string', 'enum' => [ 'DRIFTED', 'IN_SYNC', 'NOT_CHECKING', 'UNKNOWN', ], ], 'DriftStatusSummary' => [ 'type' => 'structure', 'members' => [ 'driftStatus' => [ 'shape' => 'DriftStatus', ], ], ], 'DriftStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'DriftStatus', ], 'max' => 1, 'min' => 1, ], 'EnableBaselineInput' => [ 'type' => 'structure', 'required' => [ 'baselineIdentifier', 'baselineVersion', 'targetIdentifier', ], 'members' => [ 'baselineIdentifier' => [ 'shape' => 'Arn', ], 'baselineVersion' => [ 'shape' => 'BaselineVersion', ], 'parameters' => [ 'shape' => 'EnabledBaselineParameters', ], 'tags' => [ 'shape' => 'TagMap', ], 'targetIdentifier' => [ 'shape' => 'Arn', ], ], ], 'EnableBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'arn', 'operationIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'EnableControlInput' => [ 'type' => 'structure', 'required' => [ 'controlIdentifier', 'targetIdentifier', ], 'members' => [ 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'parameters' => [ 'shape' => 'EnabledControlParameters', ], 'tags' => [ 'shape' => 'TagMap', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'EnableControlOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'EnabledBaselineBaselineIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 5, 'min' => 1, ], 'EnabledBaselineDetails' => [ 'type' => 'structure', 'required' => [ 'arn', 'baselineIdentifier', 'statusSummary', 'targetIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'baselineIdentifier' => [ 'shape' => 'String', ], 'baselineVersion' => [ 'shape' => 'String', ], 'parameters' => [ 'shape' => 'EnabledBaselineParameterSummaries', ], 'statusSummary' => [ 'shape' => 'EnablementStatusSummary', ], 'targetIdentifier' => [ 'shape' => 'String', ], ], ], 'EnabledBaselineFilter' => [ 'type' => 'structure', 'members' => [ 'baselineIdentifiers' => [ 'shape' => 'EnabledBaselineBaselineIdentifiers', ], 'targetIdentifiers' => [ 'shape' => 'EnabledBaselineTargetIdentifiers', ], ], ], 'EnabledBaselineParameter' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'EnabledBaselineParameterDocument', ], ], ], 'EnabledBaselineParameterDocument' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'EnabledBaselineParameterSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledBaselineParameterSummary', ], ], 'EnabledBaselineParameterSummary' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'EnabledBaselineParameterDocument', ], ], ], 'EnabledBaselineParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledBaselineParameter', ], ], 'EnabledBaselineSummary' => [ 'type' => 'structure', 'required' => [ 'arn', 'baselineIdentifier', 'statusSummary', 'targetIdentifier', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'baselineIdentifier' => [ 'shape' => 'String', ], 'baselineVersion' => [ 'shape' => 'String', ], 'statusSummary' => [ 'shape' => 'EnablementStatusSummary', ], 'targetIdentifier' => [ 'shape' => 'String', ], ], ], 'EnabledBaselineTargetIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 5, 'min' => 1, ], 'EnabledBaselines' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledBaselineSummary', ], ], 'EnabledControlDetails' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'driftStatusSummary' => [ 'shape' => 'DriftStatusSummary', ], 'parameters' => [ 'shape' => 'EnabledControlParameterSummaries', ], 'statusSummary' => [ 'shape' => 'EnablementStatusSummary', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], 'targetRegions' => [ 'shape' => 'TargetRegions', ], ], ], 'EnabledControlFilter' => [ 'type' => 'structure', 'members' => [ 'controlIdentifiers' => [ 'shape' => 'ControlIdentifiers', ], 'driftStatuses' => [ 'shape' => 'DriftStatuses', ], 'statuses' => [ 'shape' => 'EnablementStatuses', ], ], ], 'EnabledControlIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 1, 'min' => 1, ], 'EnabledControlParameter' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'Document', ], ], ], 'EnabledControlParameterSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledControlParameterSummary', ], ], 'EnabledControlParameterSummary' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'Document', ], ], ], 'EnabledControlParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledControlParameter', ], ], 'EnabledControlSummary' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'controlIdentifier' => [ 'shape' => 'ControlIdentifier', ], 'driftStatusSummary' => [ 'shape' => 'DriftStatusSummary', ], 'statusSummary' => [ 'shape' => 'EnablementStatusSummary', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'EnabledControls' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnabledControlSummary', ], ], 'EnablementStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'UNDER_CHANGE', ], ], 'EnablementStatusSummary' => [ 'type' => 'structure', 'members' => [ 'lastOperationIdentifier' => [ 'shape' => 'OperationIdentifier', ], 'status' => [ 'shape' => 'EnablementStatus', ], ], ], 'EnablementStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnablementStatus', ], 'max' => 1, 'min' => 1, ], 'GetBaselineInput' => [ 'type' => 'structure', 'required' => [ 'baselineIdentifier', ], 'members' => [ 'baselineIdentifier' => [ 'shape' => 'BaselineArn', ], ], ], 'GetBaselineOperationInput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'GetBaselineOperationOutput' => [ 'type' => 'structure', 'required' => [ 'baselineOperation', ], 'members' => [ 'baselineOperation' => [ 'shape' => 'BaselineOperation', ], ], ], 'GetBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'arn', 'name', ], 'members' => [ 'arn' => [ 'shape' => 'BaselineArn', ], 'description' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], ], ], 'GetControlOperationInput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'GetControlOperationOutput' => [ 'type' => 'structure', 'required' => [ 'controlOperation', ], 'members' => [ 'controlOperation' => [ 'shape' => 'ControlOperation', ], ], ], 'GetEnabledBaselineInput' => [ 'type' => 'structure', 'required' => [ 'enabledBaselineIdentifier', ], 'members' => [ 'enabledBaselineIdentifier' => [ 'shape' => 'Arn', ], ], ], 'GetEnabledBaselineOutput' => [ 'type' => 'structure', 'members' => [ 'enabledBaselineDetails' => [ 'shape' => 'EnabledBaselineDetails', ], ], ], 'GetEnabledControlInput' => [ 'type' => 'structure', 'required' => [ 'enabledControlIdentifier', ], 'members' => [ 'enabledControlIdentifier' => [ 'shape' => 'Arn', ], ], ], 'GetEnabledControlOutput' => [ 'type' => 'structure', 'required' => [ 'enabledControlDetails', ], 'members' => [ 'enabledControlDetails' => [ 'shape' => 'EnabledControlDetails', ], ], ], 'GetLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'landingZoneIdentifier', ], 'members' => [ 'landingZoneIdentifier' => [ 'shape' => 'String', ], ], ], 'GetLandingZoneOperationInput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'GetLandingZoneOperationOutput' => [ 'type' => 'structure', 'required' => [ 'operationDetails', ], 'members' => [ 'operationDetails' => [ 'shape' => 'LandingZoneOperationDetail', ], ], ], 'GetLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'landingZone', ], 'members' => [ 'landingZone' => [ 'shape' => 'LandingZoneDetail', ], ], ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, 'retryable' => [ 'throttling' => false, ], ], 'LandingZoneDetail' => [ 'type' => 'structure', 'required' => [ 'manifest', 'version', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'driftStatus' => [ 'shape' => 'LandingZoneDriftStatusSummary', ], 'latestAvailableVersion' => [ 'shape' => 'LandingZoneVersion', ], 'manifest' => [ 'shape' => 'Manifest', ], 'status' => [ 'shape' => 'LandingZoneStatus', ], 'version' => [ 'shape' => 'LandingZoneVersion', ], ], ], 'LandingZoneDriftStatus' => [ 'type' => 'string', 'enum' => [ 'DRIFTED', 'IN_SYNC', ], ], 'LandingZoneDriftStatusSummary' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'LandingZoneDriftStatus', ], ], ], 'LandingZoneOperationDetail' => [ 'type' => 'structure', 'members' => [ 'endTime' => [ 'shape' => 'Timestamp', ], 'operationType' => [ 'shape' => 'LandingZoneOperationType', ], 'startTime' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'LandingZoneOperationStatus', ], 'statusMessage' => [ 'shape' => 'String', ], ], ], 'LandingZoneOperationStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'IN_PROGRESS', ], ], 'LandingZoneOperationType' => [ 'type' => 'string', 'enum' => [ 'DELETE', 'CREATE', 'UPDATE', 'RESET', ], ], 'LandingZoneStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'PROCESSING', 'FAILED', ], ], 'LandingZoneSummary' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'Arn', ], ], ], 'LandingZoneVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '^\\d+.\\d+$', ], 'ListBaselinesInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListBaselinesMaxResults', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListBaselinesMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 4, ], 'ListBaselinesOutput' => [ 'type' => 'structure', 'required' => [ 'baselines', ], 'members' => [ 'baselines' => [ 'shape' => 'Baselines', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListControlOperationsInput' => [ 'type' => 'structure', 'members' => [ 'filter' => [ 'shape' => 'ControlOperationFilter', ], 'maxResults' => [ 'shape' => 'ListControlOperationsMaxResults', ], 'nextToken' => [ 'shape' => 'ListControlOperationsNextToken', ], ], ], 'ListControlOperationsMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListControlOperationsNextToken' => [ 'type' => 'string', 'pattern' => '\\S+', ], 'ListControlOperationsOutput' => [ 'type' => 'structure', 'required' => [ 'controlOperations', ], 'members' => [ 'controlOperations' => [ 'shape' => 'ControlOperations', ], 'nextToken' => [ 'shape' => 'ListControlOperationsNextToken', ], ], ], 'ListEnabledBaselinesInput' => [ 'type' => 'structure', 'members' => [ 'filter' => [ 'shape' => 'EnabledBaselineFilter', ], 'maxResults' => [ 'shape' => 'ListEnabledBaselinesMaxResults', ], 'nextToken' => [ 'shape' => 'ListEnabledBaselinesNextToken', ], ], ], 'ListEnabledBaselinesMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 5, ], 'ListEnabledBaselinesNextToken' => [ 'type' => 'string', 'pattern' => '\\S+', ], 'ListEnabledBaselinesOutput' => [ 'type' => 'structure', 'required' => [ 'enabledBaselines', ], 'members' => [ 'enabledBaselines' => [ 'shape' => 'EnabledBaselines', ], 'nextToken' => [ 'shape' => 'ListEnabledBaselinesNextToken', ], ], ], 'ListEnabledControlsInput' => [ 'type' => 'structure', 'members' => [ 'filter' => [ 'shape' => 'EnabledControlFilter', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'nextToken' => [ 'shape' => 'String', ], 'targetIdentifier' => [ 'shape' => 'TargetIdentifier', ], ], ], 'ListEnabledControlsOutput' => [ 'type' => 'structure', 'required' => [ 'enabledControls', ], 'members' => [ 'enabledControls' => [ 'shape' => 'EnabledControls', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListLandingZonesInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListLandingZonesMaxResults', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListLandingZonesMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 1, 'min' => 1, ], 'ListLandingZonesOutput' => [ 'type' => 'structure', 'required' => [ 'landingZones', ], 'members' => [ 'landingZones' => [ 'shape' => 'ListLandingZonesOutputLandingZonesList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListLandingZonesOutputLandingZonesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LandingZoneSummary', ], 'max' => 1, 'min' => 0, ], 'ListTagsForResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceOutput' => [ 'type' => 'structure', 'required' => [ 'tags', ], 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'Manifest' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 200, 'min' => 1, ], 'OperationIdentifier' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'Region' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RegionName', ], ], ], 'RegionName' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'ResetEnabledBaselineInput' => [ 'type' => 'structure', 'required' => [ 'enabledBaselineIdentifier', ], 'members' => [ 'enabledBaselineIdentifier' => [ 'shape' => 'Arn', ], ], ], 'ResetEnabledBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'ResetLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'landingZoneIdentifier', ], 'members' => [ 'landingZoneIdentifier' => [ 'shape' => 'String', ], ], ], 'ResetLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 402, 'senderFault' => true, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'SyntheticTimestamp_date_time' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 200, 'min' => 0, ], 'TagResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TargetIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[0-9a-zA-Z_\\-:\\/]+$', ], 'TargetIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'TargetIdentifier', ], 'max' => 1, 'min' => 1, ], 'TargetRegions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Region', ], ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'quotaCode' => [ 'shape' => 'String', ], 'retryAfterSeconds' => [ 'shape' => 'Integer', 'location' => 'header', 'locationName' => 'Retry-After', ], 'serviceCode' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, 'retryable' => [ 'throttling' => true, ], ], 'Timestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'UntagResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeys', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateEnabledBaselineInput' => [ 'type' => 'structure', 'required' => [ 'baselineVersion', 'enabledBaselineIdentifier', ], 'members' => [ 'baselineVersion' => [ 'shape' => 'BaselineVersion', ], 'enabledBaselineIdentifier' => [ 'shape' => 'Arn', ], 'parameters' => [ 'shape' => 'EnabledBaselineParameters', ], ], ], 'UpdateEnabledBaselineOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'UpdateEnabledControlInput' => [ 'type' => 'structure', 'required' => [ 'enabledControlIdentifier', 'parameters', ], 'members' => [ 'enabledControlIdentifier' => [ 'shape' => 'Arn', ], 'parameters' => [ 'shape' => 'EnabledControlParameters', ], ], ], 'UpdateEnabledControlOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'UpdateLandingZoneInput' => [ 'type' => 'structure', 'required' => [ 'landingZoneIdentifier', 'manifest', 'version', ], 'members' => [ 'landingZoneIdentifier' => [ 'shape' => 'String', ], 'manifest' => [ 'shape' => 'Manifest', ], 'version' => [ 'shape' => 'LandingZoneVersion', ], ], ], 'UpdateLandingZoneOutput' => [ 'type' => 'structure', 'required' => [ 'operationIdentifier', ], 'members' => [ 'operationIdentifier' => [ 'shape' => 'OperationIdentifier', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'message', ], 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], ],]; diff --git a/src/data/controltower/2018-05-10/docs-2.json b/src/data/controltower/2018-05-10/docs-2.json index ba7d53eb9d..bbb8f24549 100644 --- a/src/data/controltower/2018-05-10/docs-2.json +++ b/src/data/controltower/2018-05-10/docs-2.json @@ -1,30 +1,31 @@ { "version": "2.0", - "service": "These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
The controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Controls reference guide section of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls cannot be added or removed.
ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
", + "service": "Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
The controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower User Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Controls reference guide section of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls cannot be added or removed.
ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
", "operations": { "CreateLandingZone": "Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
", "DeleteLandingZone": "Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
", - "DisableBaseline": "Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline.
Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
", - "EnableBaseline": "Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target.
Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
", - "GetBaseline": "Retrieve details about an existing Baseline resource by specifying its identifier.
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure.
Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .
", "GetLandingZone": "Returns details about the landing zone. Displays a message in case of error.
", - "GetLandingZoneOperation": "Returns the status of the specified landing zone operation. Details for an operation are available for 60 days.
", - "ListBaselines": "Returns a summary list of all available baselines.
", - "ListEnabledBaselines": "Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.
Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
", + "ListBaselines": "Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
", + "ListControlOperations": "Provides a list of operations in progress or queued.
", + "ListEnabledBaselines": "Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Amazon Web Services Control Tower User Guide .
", "ListLandingZones": "Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
", "ListTagsForResource": "Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
", - "ResetEnabledBaseline": "Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU.
Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.
", "TagResource": "Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
", "UntagResource": "Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
", - "UpdateEnabledBaseline": "Updates an EnabledBaseline resource's applied parameters or version.
Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
Updates the configuration of an already enabled control.
If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.
If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.
If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the Amazon Web Services Control Tower User Guide
This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.
" }, @@ -37,6 +38,8 @@ "Arn": { "base": null, "refs": { + "ControlOperation$enabledControlIdentifier": "The controlIdentifier of the enabled control.
The controlIdentifier of an enabled control.
The ARN of the landing zone resource.
", "DisableBaselineInput$enabledBaselineIdentifier": "Identifier of the EnabledBaseline resource to be deactivated, in ARN format.
The ARN of the baseline to be enabled.
", @@ -48,6 +51,7 @@ "EnabledBaselineSummary$arn": "The ARN of the EnabledBaseline resource
The ARN of the enabled control.
", + "EnabledControlIdentifiers$member": null, "EnabledControlSummary$arn": "The ARN of the enabled control.
", "GetEnabledBaselineInput$enabledBaselineIdentifier": "Identifier of the EnabledBaseline resource to be retrieved, in ARN format.
The controlIdentifier of the enabled control.
The controlIdentifier of the control for the operation.
The controlIdentifier of a control.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The control identifier of the enabled control. For information on how to find the controlIdentifier, see the overview page.
The controlIdentifier of the enabled control.
The set of controlIdentifier returned by the filter.
The set of controlIdentifier returned by the filter.
An operation performed by the control.
", "refs": { "GetControlOperationOutput$controlOperation": "An operation performed by the control.
" } }, + "ControlOperationFilter": { + "base": "A filter object that lets you call ListCOntrolOperations with a specific filter.
An input filter for the ListControlOperations API that lets you select the types of control operations to view.
One of IN_PROGRESS, SUCEEDED, or FAILED.
One of IN_PROGRESS, SUCEEDED, or FAILED.
The status of the specified control operation.
" + } + }, + "ControlOperationStatuses": { + "base": null, + "refs": { + "ControlOperationFilter$statuses": "Lists the status of control operations.
" + } + }, + "ControlOperationSummary": { + "base": "A summary of information about the specified control operation.
", + "refs": { + "ControlOperations$member": null } }, "ControlOperationType": { "base": null, "refs": { - "ControlOperation$operationType": "One of ENABLE_CONTROL or DISABLE_CONTROL.
One of ENABLE_CONTROL or DISABLE_CONTROL.
The type of operation.
", + "ControlOperationTypes$member": null + } + }, + "ControlOperationTypes": { + "base": null, + "refs": { + "ControlOperationFilter$controlOperationTypes": "The set of ControlOperation objects returned by the filter.
Returns a list of output from control operations. PLACEHOLDER
" } }, "CreateLandingZoneInput": { @@ -187,7 +235,8 @@ "DriftStatus": { "base": null, "refs": { - "DriftStatusSummary$driftStatus": "The drift status of the enabled control.
Valid values:
DRIFTED: The enabledControl deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The enabledControl deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.
UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the enabled control.
The drift status of the enabled control.
Valid values:
DRIFTED: The enabledControl deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The enabledControl deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.
UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the enabled control.
The drift status of the enabled control.
" } }, + "DriftStatuses": { + "base": null, + "refs": { + "EnabledControlFilter$driftStatuses": "A list of DriftStatus items.
Information about the enabled control.
" } }, + "EnabledControlFilter": { + "base": "A structure that returns a set of control identifiers, the control status for each control in the set, and the drift status for each control in the set.
", + "refs": { + "ListEnabledControlsInput$filter": "An input filter for the ListCEnabledControls API that lets you select the types of control operations to view.
The set controlIdentifier of enabled controls selected by the filter.
A key/value pair, where Key is of type String and Value is of type Document.
The deployment status of the enabled control.
Valid values:
SUCCEEDED: The enabledControl configuration was deployed successfully.
UNDER_CHANGE: The enabledControl configuration is changing.
FAILED: The enabledControl configuration failed to deploy.
The deployment status of the enabled control.
Valid values:
SUCCEEDED: The enabledControl configuration was deployed successfully.
UNDER_CHANGE: The enabledControl configuration is changing.
FAILED: The enabledControl configuration failed to deploy.
A short description of the status of the enabled control.
" } }, + "EnablementStatuses": { + "base": null, + "refs": { + "EnabledControlFilter$statuses": "A list of EnablementStatus items.
The maximum number of results to be shown.
" + } + }, + "ListControlOperationsNextToken": { + "base": null, + "refs": { + "ListControlOperationsInput$nextToken": "A pagination token.
", + "ListControlOperationsOutput$nextToken": "A pagination token.
" + } + }, + "ListControlOperationsOutput": { + "base": null, + "refs": { + } + }, "ListEnabledBaselinesInput": { "base": null, "refs": { @@ -565,9 +662,9 @@ "Manifest": { "base": null, "refs": { - "CreateLandingZoneInput$manifest": "The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review The manifest file.
", - "LandingZoneDetail$manifest": "The landing zone manifest.yaml text file that specifies the landing zone configurations.
The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review The manifest file.
The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
", + "LandingZoneDetail$manifest": "The landing zone manifest JSON text file that specifies the landing zone configurations.
", + "UpdateLandingZoneInput$manifest": "The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
" } }, "MaxResults": { @@ -580,6 +677,8 @@ "base": null, "refs": { "BaselineOperation$operationIdentifier": "The identifier of the specified operation.
", + "ControlOperation$operationIdentifier": "The identifier of the specified operation.
", + "ControlOperationSummary$operationIdentifier": "The unique identifier of a control operation.
", "CreateLandingZoneOutput$operationIdentifier": "A unique identifier assigned to a CreateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.
>A unique identifier assigned to a DeleteLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
The ID (in UUID format) of the asynchronous DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The human-readable name of a Baseline.
", "ConflictException$message": null, "ControlOperation$statusMessage": "If the operation result is FAILED, this string contains a message explaining why the operation failed.
A speficic message displayed as part of the control status.
", "DeleteLandingZoneInput$landingZoneIdentifier": "The unique identifier of the landing zone.
", "EnabledBaselineDetails$baselineIdentifier": "The specific Baseline enabled as part of the EnabledBaseline resource.
The enabled version of the Baseline.
The time that the operation finished.
", - "ControlOperation$startTime": "The time that the operation began.
" + "ControlOperation$startTime": "The time that the operation began.
", + "ControlOperationSummary$endTime": "The time at which the control operation was completed.
", + "ControlOperationSummary$startTime": "The time at which a control operation began.
" } }, "TagKey": { @@ -730,11 +832,20 @@ "TargetIdentifier": { "base": null, "refs": { + "ControlOperation$targetIdentifier": "The target upon which the control operation is working.
", + "ControlOperationSummary$targetIdentifier": "The unique identifier of the target of a control operation.
", "DisableControlInput$targetIdentifier": "The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit.
", - "ListEnabledControlsInput$targetIdentifier": "The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The set of targetIdentifier objects returned by the filter.
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.
To call these APIs, you\'ll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
The controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Controls reference guide section of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls cannot be added or removed.
ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
', 'operations' => [ 'CreateLandingZone' => 'Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
', 'DeleteLandingZone' => 'Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
', 'DisableBaseline' => 'Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline.
This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'EnableBaseline' => 'Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target.
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'GetBaseline' => 'Retrieve details about an existing Baseline resource by specifying its identifier.
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure.
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'GetLandingZone' => 'Returns details about the landing zone. Displays a message in case of error.
', 'GetLandingZoneOperation' => 'Returns the status of the specified landing zone operation. Details for an operation are available for 60 days.
', 'ListBaselines' => 'Returns a summary list of all available baselines.
', 'ListEnabledBaselines' => 'Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'ListLandingZones' => 'Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
', 'ListTagsForResource' => 'Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'ResetEnabledBaseline' => 'Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU.
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.
', 'TagResource' => 'Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'UntagResource' => 'Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'UpdateEnabledBaseline' => 'Updates an EnabledBaseline resource\'s applied parameters or version.
Updates the configuration of an already enabled control.
If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.
If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.
If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the Amazon Web Services Control Tower User Guide
This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You do not have sufficient access to perform this action.
', 'refs' => [], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'CreateLandingZoneOutput$arn' => 'The ARN of the landing zone resource.
', 'DisableBaselineInput$enabledBaselineIdentifier' => 'Identifier of the EnabledBaseline resource to be deactivated, in ARN format.
The ARN of the baseline to be enabled.
', 'EnableBaselineInput$targetIdentifier' => 'The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.
', 'EnableBaselineOutput$arn' => 'The ARN of the EnabledBaseline resource.
The ARN of the EnabledControl resource.
The ARN of the EnabledBaseline resource.
The ARN of the EnabledBaseline resource
The ARN of the enabled control.
', 'EnabledControlSummary$arn' => 'The ARN of the enabled control.
', 'GetEnabledBaselineInput$enabledBaselineIdentifier' => 'Identifier of the EnabledBaseline resource to be retrieved, in ARN format.
The controlIdentifier of the enabled control.
The ARN of the landing zone.
', 'LandingZoneSummary$arn' => 'The ARN of the landing zone.
', 'ListTagsForResourceInput$resourceArn' => 'The ARN of the resource.
', 'ResetEnabledBaselineInput$enabledBaselineIdentifier' => 'Specifies the ID of the EnabledBaseline resource to be re-enabled, in ARN format.
The ARN of the resource to be tagged.
', 'UntagResourceInput$resourceArn' => 'The ARN of the resource.
', 'UpdateEnabledBaselineInput$enabledBaselineIdentifier' => 'Specifies the EnabledBaseline resource to be updated.
The ARN of the enabled control that will be updated.
', ], ], 'BaselineArn' => [ 'base' => NULL, 'refs' => [ 'GetBaselineInput$baselineIdentifier' => 'The ARN of the Baseline resource to be retrieved.
The baseline ARN.
', ], ], 'BaselineOperation' => [ 'base' => 'An object of shape BaselineOperation, returning details about the specified Baseline operation ID.
A baselineOperation object that shows information about the specified operation ID.
An enumerated type (enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.
An enumerated type (enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.
Returns a summary of information about a Baseline object.
The specific version to be enabled of the specified baseline.
', 'UpdateEnabledBaselineInput$baselineVersion' => 'Specifies the new Baseline version, to which the EnabledBaseline should be updated.
A list of Baseline object details.
Updating or deleting the resource can cause an inconsistent state.
', 'refs' => [], ], 'ControlIdentifier' => [ 'base' => NULL, 'refs' => [ 'DisableControlInput$controlIdentifier' => 'The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The control identifier of the enabled control. For information on how to find the controlIdentifier, see the overview page.
The controlIdentifier of the enabled control.
An operation performed by the control.
', 'refs' => [ 'GetControlOperationOutput$controlOperation' => 'An operation performed by the control.
', ], ], 'ControlOperationStatus' => [ 'base' => NULL, 'refs' => [ 'ControlOperation$status' => 'One of IN_PROGRESS, SUCEEDED, or FAILED.
One of ENABLE_CONTROL or DISABLE_CONTROL.
The value of a key/value pair.
', 'EnabledControlParameterSummary$value' => 'The value of a key/value pair.
', ], ], 'DriftStatus' => [ 'base' => NULL, 'refs' => [ 'DriftStatusSummary$driftStatus' => 'The drift status of the enabled control.
Valid values:
DRIFTED: The enabledControl deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The enabledControl deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.
UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the enabled control.
The drift summary of the enabled control.
Amazon Web Services Control Tower expects the enabled control configuration to include all supported and governed Regions. If the enabled control differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
', 'refs' => [ 'EnabledControlDetails$driftStatusSummary' => 'The drift status of the enabled control.
', 'EnabledControlSummary$driftStatusSummary' => 'The drift status of the enabled control.
', ], ], 'EnableBaselineInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableBaselineOutput' => [ 'base' => NULL, 'refs' => [], ], 'EnableControlInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableControlOutput' => [ 'base' => NULL, 'refs' => [], ], 'EnabledBaselineBaselineIdentifiers' => [ 'base' => NULL, 'refs' => [ 'EnabledBaselineFilter$baselineIdentifiers' => 'Identifiers for the Baseline objects returned as part of the filter operation.
Details of the EnabledBaseline resource.
Details of the EnabledBaseline resource.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
A key-value parameter to an EnabledBaseline resource.
A low-level Document object of any type (for example, a Java Object).
A low-level document object of any type (for example, a Java Object).
', ], ], 'EnabledBaselineParameterSummaries' => [ 'base' => NULL, 'refs' => [ 'EnabledBaselineDetails$parameters' => 'Shows the parameters that are applied when enabling this Baseline.
Summary of an applied parameter to an EnabledBaseline resource.
A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.
Parameters to apply when making an update.
', ], ], 'EnabledBaselineSummary' => [ 'base' => 'Returns a summary of information about an EnabledBaseline object.
Identifiers for the targets of the Baseline filter operation.
Retuens a list of summaries of EnabledBaseline resources.
Information about the enabled control.
', 'refs' => [ 'GetEnabledControlOutput$enabledControlDetails' => 'Information about the enabled control.
', ], ], 'EnabledControlParameter' => [ 'base' => 'A key/value pair, where Key is of type String and Value is of type Document.
Array of EnabledControlParameter objects.
Returns a summary of information about the parameters of an enabled control.
', 'refs' => [ 'EnabledControlParameterSummaries$member' => NULL, ], ], 'EnabledControlParameters' => [ 'base' => NULL, 'refs' => [ 'EnableControlInput$parameters' => 'A list of input parameter values, which are specified to configure the control when you enable it.
', 'UpdateEnabledControlInput$parameters' => 'A key/value pair, where Key is of type String and Value is of type Document.
Returns a summary of information about an enabled control.
', 'refs' => [ 'EnabledControls$member' => NULL, ], ], 'EnabledControls' => [ 'base' => NULL, 'refs' => [ 'ListEnabledControlsOutput$enabledControls' => 'Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
', ], ], 'EnablementStatus' => [ 'base' => NULL, 'refs' => [ 'EnablementStatusSummary$status' => 'The deployment status of the enabled control.
Valid values:
SUCCEEDED: The enabledControl configuration was deployed successfully.
UNDER_CHANGE: The enabledControl configuration is changing.
FAILED: The enabledControl configuration failed to deploy.
The deployment summary of the enabled control.
', 'refs' => [ 'EnabledBaselineDetails$statusSummary' => NULL, 'EnabledBaselineSummary$statusSummary' => NULL, 'EnabledControlDetails$statusSummary' => 'The deployment summary of the enabled control.
', 'EnabledControlSummary$statusSummary' => 'A short description of the status of the enabled control.
', ], ], 'GetBaselineInput' => [ 'base' => NULL, 'refs' => [], ], 'GetBaselineOperationInput' => [ 'base' => NULL, 'refs' => [], ], 'GetBaselineOperationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBaselineOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetControlOperationInput' => [ 'base' => NULL, 'refs' => [], ], 'GetControlOperationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetEnabledBaselineInput' => [ 'base' => NULL, 'refs' => [], ], 'GetEnabledBaselineOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetEnabledControlInput' => [ 'base' => NULL, 'refs' => [], ], 'GetEnabledControlOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetLandingZoneInput' => [ 'base' => NULL, 'refs' => [], ], 'GetLandingZoneOperationInput' => [ 'base' => NULL, 'refs' => [], ], 'GetLandingZoneOperationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetLandingZoneOutput' => [ 'base' => NULL, 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ThrottlingException$retryAfterSeconds' => 'The number of seconds the caller should wait before retrying.
', ], ], 'InternalServerException' => [ 'base' => 'An unexpected error occurred during processing of a request.
', 'refs' => [], ], 'LandingZoneDetail' => [ 'base' => 'Information about the landing zone.
', 'refs' => [ 'GetLandingZoneOutput$landingZone' => 'Information about the landing zone.
', ], ], 'LandingZoneDriftStatus' => [ 'base' => NULL, 'refs' => [ 'LandingZoneDriftStatusSummary$status' => 'The drift status of the landing zone.
Valid values:
DRIFTED: The landing zone deployed in this configuration does not match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The landing zone deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
The drift status summary of the landing zone.
If the landing zone differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the landing zone.
', 'refs' => [ 'LandingZoneDetail$driftStatus' => 'The drift status of the landing zone.
', ], ], 'LandingZoneOperationDetail' => [ 'base' => 'Information about a landing zone operation.
', 'refs' => [ 'GetLandingZoneOperationOutput$operationDetails' => 'Details about a landing zone operation.
', ], ], 'LandingZoneOperationStatus' => [ 'base' => NULL, 'refs' => [ 'LandingZoneOperationDetail$status' => 'Valid values:
SUCCEEDED: The landing zone operation succeeded.
IN_PROGRESS: The landing zone operation is in progress.
FAILED: The landing zone operation failed.
The landing zone operation type.
Valid values:
DELETE: The DeleteLandingZone operation.
CREATE: The CreateLandingZone operation.
UPDATE: The UpdateLandingZone operation.
RESET: The ResetLandingZone operation.
The landing zone deployment status. One of ACTIVE, PROCESSING, FAILED.
Returns a summary of information about a landing zone.
', 'refs' => [ 'ListLandingZonesOutputLandingZonesList$member' => NULL, ], ], 'LandingZoneVersion' => [ 'base' => NULL, 'refs' => [ 'CreateLandingZoneInput$version' => 'The landing zone version, for example, 3.0.
', 'LandingZoneDetail$latestAvailableVersion' => 'The latest available version of the landing zone.
', 'LandingZoneDetail$version' => 'The landing zone\'s current deployed version.
', 'UpdateLandingZoneInput$version' => 'The landing zone version, for example, 3.2.
', ], ], 'ListBaselinesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBaselinesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListBaselinesInput$maxResults' => 'The maximum number of results to be shown.
', ], ], 'ListBaselinesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEnabledBaselinesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEnabledBaselinesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListEnabledBaselinesInput$maxResults' => 'The maximum number of results to be shown.
', ], ], 'ListEnabledBaselinesNextToken' => [ 'base' => NULL, 'refs' => [ 'ListEnabledBaselinesInput$nextToken' => 'A pagination token.
', 'ListEnabledBaselinesOutput$nextToken' => 'A pagination token.
', ], ], 'ListEnabledBaselinesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEnabledControlsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEnabledControlsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListLandingZonesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListLandingZonesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListLandingZonesInput$maxResults' => 'The maximum number of returned landing zone ARNs, which is one.
', ], ], 'ListLandingZonesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListLandingZonesOutputLandingZonesList' => [ 'base' => NULL, 'refs' => [ 'ListLandingZonesOutput$landingZones' => 'The ARN of the landing zone.
', ], ], 'ListTagsForResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'Manifest' => [ 'base' => NULL, 'refs' => [ 'CreateLandingZoneInput$manifest' => 'The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review The manifest file.
', 'LandingZoneDetail$manifest' => 'The landing zone manifest.yaml text file that specifies the landing zone configurations.
The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review The manifest file.
How many results to return per API call.
', ], ], 'OperationIdentifier' => [ 'base' => NULL, 'refs' => [ 'BaselineOperation$operationIdentifier' => 'The identifier of the specified operation.
', 'CreateLandingZoneOutput$operationIdentifier' => 'A unique identifier assigned to a CreateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation\'s status.
>A unique identifier assigned to a DeleteLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation\'s status.
The ID (in UUID format) of the asynchronous DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
', 'EnableBaselineOutput$operationIdentifier' => 'The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
', 'EnablementStatusSummary$lastOperationIdentifier' => 'The last operation identifier for the enabled control.
', 'GetBaselineOperationInput$operationIdentifier' => 'The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).
', 'GetControlOperationInput$operationIdentifier' => 'The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
', 'GetLandingZoneOperationInput$operationIdentifier' => 'A unique identifier assigned to a landing zone operation.
', 'ResetEnabledBaselineOutput$operationIdentifier' => 'The ID (in UUID format) of the asynchronous ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
A unique identifier assigned to a ResetLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation\'s status.
The ID (in UUID format) of the asynchronous UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The operation identifier for this UpdateEnabledControl operation.
A unique identifier assigned to a UpdateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation\'s status.
An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
The expected Regions are based on the Regions that are governed by the landing zone. In certain cases, a control is not actually enabled in the Region as expected, such as during drift, or mixed governance.
', 'refs' => [ 'TargetRegions$member' => NULL, ], ], 'RegionName' => [ 'base' => NULL, 'refs' => [ 'Region$name' => 'The Amazon Web Services Region name.
', ], ], 'ResetEnabledBaselineInput' => [ 'base' => NULL, 'refs' => [], ], 'ResetEnabledBaselineOutput' => [ 'base' => NULL, 'refs' => [], ], 'ResetLandingZoneInput' => [ 'base' => NULL, 'refs' => [], ], 'ResetLandingZoneOutput' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The request references a resource that does not exist.
', 'refs' => [], ], 'ServiceQuotaExceededException' => [ 'base' => 'The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'BaselineOperation$statusMessage' => 'A status message that gives more information about the operation\'s status, if applicable.
', 'BaselineSummary$arn' => 'The full ARN of a Baseline.
', 'BaselineSummary$description' => 'A summary description of a Baseline.
', 'BaselineSummary$name' => 'The human-readable name of a Baseline.
', 'ConflictException$message' => NULL, 'ControlOperation$statusMessage' => 'If the operation result is FAILED, this string contains a message explaining why the operation failed.
The unique identifier of the landing zone.
', 'EnabledBaselineDetails$baselineIdentifier' => 'The specific Baseline enabled as part of the EnabledBaseline resource.
The enabled version of the Baseline.
The target on which to enable the Baseline.
A string denoting the parameter key.
', 'EnabledBaselineParameterSummary$key' => 'A string denoting the parameter key.
', 'EnabledBaselineSummary$baselineIdentifier' => 'The specific baseline that is enabled as part of the EnabledBaseline resource.
The enabled version of the baseline.
', 'EnabledBaselineSummary$targetIdentifier' => 'The target upon which the baseline is enabled.
', 'EnabledControlParameter$key' => 'The key of a key/value pair.
', 'EnabledControlParameterSummary$key' => 'The key of a key/value pair.
', 'GetBaselineOutput$description' => 'A description of the baseline.
', 'GetBaselineOutput$name' => 'A user-friendly name for the baseline.
', 'GetLandingZoneInput$landingZoneIdentifier' => 'The unique identifier of the landing zone.
', 'InternalServerException$message' => NULL, 'LandingZoneOperationDetail$statusMessage' => 'If the operation result is FAILED, this string contains a message explaining why the operation failed.
', 'ListBaselinesInput$nextToken' => 'A pagination token.
', 'ListBaselinesOutput$nextToken' => 'A pagination token.
', 'ListEnabledControlsInput$nextToken' => 'The token to continue the list from a previous API call with the same parameters.
', 'ListEnabledControlsOutput$nextToken' => 'Retrieves the next page of results. If the string is empty, the response is the end of the results.
', 'ListLandingZonesInput$nextToken' => 'The token to continue the list from a previous API call with the same parameters.
', 'ListLandingZonesOutput$nextToken' => 'Retrieves the next page of results. If the string is empty, the response is the end of the results.
', 'ResetLandingZoneInput$landingZoneIdentifier' => 'The unique identifier of the landing zone.
', 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'ThrottlingException$quotaCode' => 'The ID of the service quota that was exceeded.
', 'ThrottlingException$serviceCode' => 'The ID of the service that is associated with the error.
', 'UpdateLandingZoneInput$landingZoneIdentifier' => 'The unique identifier of the landing zone.
', 'ValidationException$message' => NULL, ], ], 'SyntheticTimestamp_date_time' => [ 'base' => NULL, 'refs' => [ 'ControlOperation$endTime' => 'The time that the operation finished.
', 'ControlOperation$startTime' => 'The time that the operation began.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeys$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceInput$tagKeys' => 'Tag keys to be removed from the resource.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateLandingZoneInput$tags' => 'Tags to be applied to the landing zone.
', 'EnableBaselineInput$tags' => 'Tags associated with input to EnableBaseline.
Tags to be applied to the EnabledControl resource.
A list of tags, as key:value strings.
Tags to be applied to the resource.
', ], ], 'TagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'TargetIdentifier' => [ 'base' => NULL, 'refs' => [ 'DisableControlInput$targetIdentifier' => 'The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit.
', 'ListEnabledControlsInput$targetIdentifier' => 'The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
Target Amazon Web Services Regions for the enabled control.
', ], ], 'ThrottlingException' => [ 'base' => 'The request was denied due to request throttling.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'BaselineOperation$endTime' => 'The end time of the operation (if applicable), in ISO 8601 format.
', 'BaselineOperation$startTime' => 'The start time of the operation, in ISO 8601 format.
', 'LandingZoneOperationDetail$endTime' => 'The landing zone operation end time.
', 'LandingZoneOperationDetail$startTime' => 'The landing zone operation start time.
', ], ], 'UntagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEnabledBaselineInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEnabledBaselineOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEnabledControlInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEnabledControlOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLandingZoneInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLandingZoneOutput' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'The input does not satisfy the constraints specified by an Amazon Web Services service.
', 'refs' => [], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.
To call these APIs, you\'ll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
The controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower User Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Controls reference guide section of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls cannot be added or removed.
ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the "Actions" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the "Actions" section. For usage examples, see Baseline API input and output examples with CLI.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
', 'operations' => [ 'CreateLandingZone' => 'Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
', 'DeleteLandingZone' => 'Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
', 'DisableBaseline' => 'Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'EnableBaseline' => 'Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'GetBaseline' => 'Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'GetLandingZone' => 'Returns details about the landing zone. Displays a message in case of error.
', 'GetLandingZoneOperation' => 'Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
', 'ListBaselines' => 'Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'ListControlOperations' => 'Provides a list of operations in progress or queued.
', 'ListEnabledBaselines' => 'Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'ListLandingZones' => 'Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
', 'ListTagsForResource' => 'Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'ResetEnabledBaseline' => 'Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.
', 'TagResource' => 'Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'UntagResource' => 'Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
', 'UpdateEnabledBaseline' => 'Updates an EnabledBaseline resource\'s applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
Updates the configuration of an already enabled control.
If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.
If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.
If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the Amazon Web Services Control Tower User Guide
This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You do not have sufficient access to perform this action.
', 'refs' => [], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'ControlOperation$enabledControlIdentifier' => 'The controlIdentifier of the enabled control.
The controlIdentifier of an enabled control.
The ARN of the landing zone resource.
', 'DisableBaselineInput$enabledBaselineIdentifier' => 'Identifier of the EnabledBaseline resource to be deactivated, in ARN format.
The ARN of the baseline to be enabled.
', 'EnableBaselineInput$targetIdentifier' => 'The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.
', 'EnableBaselineOutput$arn' => 'The ARN of the EnabledBaseline resource.
The ARN of the EnabledControl resource.
The ARN of the EnabledBaseline resource.
The ARN of the EnabledBaseline resource
The ARN of the enabled control.
', 'EnabledControlIdentifiers$member' => NULL, 'EnabledControlSummary$arn' => 'The ARN of the enabled control.
', 'GetEnabledBaselineInput$enabledBaselineIdentifier' => 'Identifier of the EnabledBaseline resource to be retrieved, in ARN format.
The controlIdentifier of the enabled control.
The ARN of the landing zone.
', 'LandingZoneSummary$arn' => 'The ARN of the landing zone.
', 'ListTagsForResourceInput$resourceArn' => 'The ARN of the resource.
', 'ResetEnabledBaselineInput$enabledBaselineIdentifier' => 'Specifies the ID of the EnabledBaseline resource to be re-enabled, in ARN format.
The ARN of the resource to be tagged.
', 'UntagResourceInput$resourceArn' => 'The ARN of the resource.
', 'UpdateEnabledBaselineInput$enabledBaselineIdentifier' => 'Specifies the EnabledBaseline resource to be updated.
The ARN of the enabled control that will be updated.
', ], ], 'BaselineArn' => [ 'base' => NULL, 'refs' => [ 'GetBaselineInput$baselineIdentifier' => 'The ARN of the Baseline resource to be retrieved.
The baseline ARN.
', ], ], 'BaselineOperation' => [ 'base' => 'An object of shape BaselineOperation, returning details about the specified Baseline operation ID.
A baselineOperation object that shows information about the specified operation ID.
An enumerated type (enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.
An enumerated type (enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.
Returns a summary of information about a Baseline object.
The specific version to be enabled of the specified baseline.
', 'UpdateEnabledBaselineInput$baselineVersion' => 'Specifies the new Baseline version, to which the EnabledBaseline should be updated.
A list of Baseline object details.
Updating or deleting the resource can cause an inconsistent state.
', 'refs' => [], ], 'ControlIdentifier' => [ 'base' => NULL, 'refs' => [ 'ControlIdentifiers$member' => NULL, 'ControlOperation$controlIdentifier' => 'The controlIdentifier of the control for the operation.
The controlIdentifier of a control.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The control identifier of the enabled control. For information on how to find the controlIdentifier, see the overview page.
The controlIdentifier of the enabled control.
The set of controlIdentifier returned by the filter.
The set of controlIdentifier returned by the filter.
An operation performed by the control.
', 'refs' => [ 'GetControlOperationOutput$controlOperation' => 'An operation performed by the control.
', ], ], 'ControlOperationFilter' => [ 'base' => 'A filter object that lets you call ListCOntrolOperations with a specific filter.
An input filter for the ListControlOperations API that lets you select the types of control operations to view.
One of IN_PROGRESS, SUCEEDED, or FAILED.
The status of the specified control operation.
', ], ], 'ControlOperationStatuses' => [ 'base' => NULL, 'refs' => [ 'ControlOperationFilter$statuses' => 'Lists the status of control operations.
', ], ], 'ControlOperationSummary' => [ 'base' => 'A summary of information about the specified control operation.
', 'refs' => [ 'ControlOperations$member' => NULL, ], ], 'ControlOperationType' => [ 'base' => NULL, 'refs' => [ 'ControlOperation$operationType' => 'One of ENABLE_CONTROL or DISABLE_CONTROL.
The type of operation.
', 'ControlOperationTypes$member' => NULL, ], ], 'ControlOperationTypes' => [ 'base' => NULL, 'refs' => [ 'ControlOperationFilter$controlOperationTypes' => 'The set of ControlOperation objects returned by the filter.
Returns a list of output from control operations. PLACEHOLDER
', ], ], 'CreateLandingZoneInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateLandingZoneOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLandingZoneInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLandingZoneOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisableBaselineInput' => [ 'base' => NULL, 'refs' => [], ], 'DisableBaselineOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisableControlInput' => [ 'base' => NULL, 'refs' => [], ], 'DisableControlOutput' => [ 'base' => NULL, 'refs' => [], ], 'Document' => [ 'base' => NULL, 'refs' => [ 'EnabledControlParameter$value' => 'The value of a key/value pair.
', 'EnabledControlParameterSummary$value' => 'The value of a key/value pair.
', ], ], 'DriftStatus' => [ 'base' => NULL, 'refs' => [ 'DriftStatusSummary$driftStatus' => 'The drift status of the enabled control.
Valid values:
DRIFTED: The enabledControl deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The enabledControl deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.
UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the enabled control.
The drift summary of the enabled control.
Amazon Web Services Control Tower expects the enabled control configuration to include all supported and governed Regions. If the enabled control differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
', 'refs' => [ 'EnabledControlDetails$driftStatusSummary' => 'The drift status of the enabled control.
', 'EnabledControlSummary$driftStatusSummary' => 'The drift status of the enabled control.
', ], ], 'DriftStatuses' => [ 'base' => NULL, 'refs' => [ 'EnabledControlFilter$driftStatuses' => 'A list of DriftStatus items.
Identifiers for the Baseline objects returned as part of the filter operation.
Details of the EnabledBaseline resource.
Details of the EnabledBaseline resource.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
A key-value parameter to an EnabledBaseline resource.
A low-level Document object of any type (for example, a Java Object).
A low-level document object of any type (for example, a Java Object).
', ], ], 'EnabledBaselineParameterSummaries' => [ 'base' => NULL, 'refs' => [ 'EnabledBaselineDetails$parameters' => 'Shows the parameters that are applied when enabling this Baseline.
Summary of an applied parameter to an EnabledBaseline resource.
A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.
Parameters to apply when making an update.
', ], ], 'EnabledBaselineSummary' => [ 'base' => 'Returns a summary of information about an EnabledBaseline object.
Identifiers for the targets of the Baseline filter operation.
Retuens a list of summaries of EnabledBaseline resources.
Information about the enabled control.
', 'refs' => [ 'GetEnabledControlOutput$enabledControlDetails' => 'Information about the enabled control.
', ], ], 'EnabledControlFilter' => [ 'base' => 'A structure that returns a set of control identifiers, the control status for each control in the set, and the drift status for each control in the set.
', 'refs' => [ 'ListEnabledControlsInput$filter' => 'An input filter for the ListCEnabledControls API that lets you select the types of control operations to view.
The set controlIdentifier of enabled controls selected by the filter.
A key/value pair, where Key is of type String and Value is of type Document.
Array of EnabledControlParameter objects.
Returns a summary of information about the parameters of an enabled control.
', 'refs' => [ 'EnabledControlParameterSummaries$member' => NULL, ], ], 'EnabledControlParameters' => [ 'base' => NULL, 'refs' => [ 'EnableControlInput$parameters' => 'A list of input parameter values, which are specified to configure the control when you enable it.
', 'UpdateEnabledControlInput$parameters' => 'A key/value pair, where Key is of type String and Value is of type Document.
Returns a summary of information about an enabled control.
', 'refs' => [ 'EnabledControls$member' => NULL, ], ], 'EnabledControls' => [ 'base' => NULL, 'refs' => [ 'ListEnabledControlsOutput$enabledControls' => 'Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
', ], ], 'EnablementStatus' => [ 'base' => NULL, 'refs' => [ 'EnablementStatusSummary$status' => 'The deployment status of the enabled control.
Valid values:
SUCCEEDED: The enabledControl configuration was deployed successfully.
UNDER_CHANGE: The enabledControl configuration is changing.
FAILED: The enabledControl configuration failed to deploy.
The deployment summary of the enabled control.
', 'refs' => [ 'EnabledBaselineDetails$statusSummary' => NULL, 'EnabledBaselineSummary$statusSummary' => NULL, 'EnabledControlDetails$statusSummary' => 'The deployment summary of the enabled control.
', 'EnabledControlSummary$statusSummary' => 'A short description of the status of the enabled control.
', ], ], 'EnablementStatuses' => [ 'base' => NULL, 'refs' => [ 'EnabledControlFilter$statuses' => 'A list of EnablementStatus items.
The number of seconds the caller should wait before retrying.
', ], ], 'InternalServerException' => [ 'base' => 'An unexpected error occurred during processing of a request.
', 'refs' => [], ], 'LandingZoneDetail' => [ 'base' => 'Information about the landing zone.
', 'refs' => [ 'GetLandingZoneOutput$landingZone' => 'Information about the landing zone.
', ], ], 'LandingZoneDriftStatus' => [ 'base' => NULL, 'refs' => [ 'LandingZoneDriftStatusSummary$status' => 'The drift status of the landing zone.
Valid values:
DRIFTED: The landing zone deployed in this configuration does not match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The landing zone deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
The drift status summary of the landing zone.
If the landing zone differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the landing zone.
', 'refs' => [ 'LandingZoneDetail$driftStatus' => 'The drift status of the landing zone.
', ], ], 'LandingZoneOperationDetail' => [ 'base' => 'Information about a landing zone operation.
', 'refs' => [ 'GetLandingZoneOperationOutput$operationDetails' => 'Details about a landing zone operation.
', ], ], 'LandingZoneOperationStatus' => [ 'base' => NULL, 'refs' => [ 'LandingZoneOperationDetail$status' => 'Valid values:
SUCCEEDED: The landing zone operation succeeded.
IN_PROGRESS: The landing zone operation is in progress.
FAILED: The landing zone operation failed.
The landing zone operation type.
Valid values:
DELETE: The DeleteLandingZone operation.
CREATE: The CreateLandingZone operation.
UPDATE: The UpdateLandingZone operation.
RESET: The ResetLandingZone operation.
The landing zone deployment status. One of ACTIVE, PROCESSING, FAILED.
Returns a summary of information about a landing zone.
', 'refs' => [ 'ListLandingZonesOutputLandingZonesList$member' => NULL, ], ], 'LandingZoneVersion' => [ 'base' => NULL, 'refs' => [ 'CreateLandingZoneInput$version' => 'The landing zone version, for example, 3.0.
', 'LandingZoneDetail$latestAvailableVersion' => 'The latest available version of the landing zone.
', 'LandingZoneDetail$version' => 'The landing zone\'s current deployed version.
', 'UpdateLandingZoneInput$version' => 'The landing zone version, for example, 3.2.
', ], ], 'ListBaselinesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBaselinesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListBaselinesInput$maxResults' => 'The maximum number of results to be shown.
', ], ], 'ListBaselinesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListControlOperationsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListControlOperationsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListControlOperationsInput$maxResults' => 'The maximum number of results to be shown.
', ], ], 'ListControlOperationsNextToken' => [ 'base' => NULL, 'refs' => [ 'ListControlOperationsInput$nextToken' => 'A pagination token.
', 'ListControlOperationsOutput$nextToken' => 'A pagination token.
', ], ], 'ListControlOperationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEnabledBaselinesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEnabledBaselinesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListEnabledBaselinesInput$maxResults' => 'The maximum number of results to be shown.
', ], ], 'ListEnabledBaselinesNextToken' => [ 'base' => NULL, 'refs' => [ 'ListEnabledBaselinesInput$nextToken' => 'A pagination token.
', 'ListEnabledBaselinesOutput$nextToken' => 'A pagination token.
', ], ], 'ListEnabledBaselinesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEnabledControlsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEnabledControlsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListLandingZonesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListLandingZonesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListLandingZonesInput$maxResults' => 'The maximum number of returned landing zone ARNs, which is one.
', ], ], 'ListLandingZonesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListLandingZonesOutputLandingZonesList' => [ 'base' => NULL, 'refs' => [ 'ListLandingZonesOutput$landingZones' => 'The ARN of the landing zone.
', ], ], 'ListTagsForResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'Manifest' => [ 'base' => NULL, 'refs' => [ 'CreateLandingZoneInput$manifest' => 'The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
', 'LandingZoneDetail$manifest' => 'The landing zone manifest JSON text file that specifies the landing zone configurations.
', 'UpdateLandingZoneInput$manifest' => 'The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListEnabledControlsInput$maxResults' => 'How many results to return per API call.
', ], ], 'OperationIdentifier' => [ 'base' => NULL, 'refs' => [ 'BaselineOperation$operationIdentifier' => 'The identifier of the specified operation.
', 'ControlOperation$operationIdentifier' => 'The identifier of the specified operation.
', 'ControlOperationSummary$operationIdentifier' => 'The unique identifier of a control operation.
', 'CreateLandingZoneOutput$operationIdentifier' => 'A unique identifier assigned to a CreateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation\'s status.
>A unique identifier assigned to a DeleteLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation\'s status.
The ID (in UUID format) of the asynchronous DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
', 'EnableBaselineOutput$operationIdentifier' => 'The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
', 'EnablementStatusSummary$lastOperationIdentifier' => 'The last operation identifier for the enabled control.
', 'GetBaselineOperationInput$operationIdentifier' => 'The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).
', 'GetControlOperationInput$operationIdentifier' => 'The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
', 'GetLandingZoneOperationInput$operationIdentifier' => 'A unique identifier assigned to a landing zone operation.
', 'ResetEnabledBaselineOutput$operationIdentifier' => 'The ID (in UUID format) of the asynchronous ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
A unique identifier assigned to a ResetLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation\'s status.
The ID (in UUID format) of the asynchronous UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The operation identifier for this UpdateEnabledControl operation.
A unique identifier assigned to a UpdateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation\'s status.
An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
The expected Regions are based on the Regions that are governed by the landing zone. In certain cases, a control is not actually enabled in the Region as expected, such as during drift, or mixed governance.
', 'refs' => [ 'TargetRegions$member' => NULL, ], ], 'RegionName' => [ 'base' => NULL, 'refs' => [ 'Region$name' => 'The Amazon Web Services Region name.
', ], ], 'ResetEnabledBaselineInput' => [ 'base' => NULL, 'refs' => [], ], 'ResetEnabledBaselineOutput' => [ 'base' => NULL, 'refs' => [], ], 'ResetLandingZoneInput' => [ 'base' => NULL, 'refs' => [], ], 'ResetLandingZoneOutput' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The request references a resource that does not exist.
', 'refs' => [], ], 'ServiceQuotaExceededException' => [ 'base' => 'The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'BaselineOperation$statusMessage' => 'A status message that gives more information about the operation\'s status, if applicable.
', 'BaselineSummary$arn' => 'The full ARN of a Baseline.
', 'BaselineSummary$description' => 'A summary description of a Baseline.
', 'BaselineSummary$name' => 'The human-readable name of a Baseline.
', 'ConflictException$message' => NULL, 'ControlOperation$statusMessage' => 'If the operation result is FAILED, this string contains a message explaining why the operation failed.
A speficic message displayed as part of the control status.
', 'DeleteLandingZoneInput$landingZoneIdentifier' => 'The unique identifier of the landing zone.
', 'EnabledBaselineDetails$baselineIdentifier' => 'The specific Baseline enabled as part of the EnabledBaseline resource.
The enabled version of the Baseline.
The target on which to enable the Baseline.
A string denoting the parameter key.
', 'EnabledBaselineParameterSummary$key' => 'A string denoting the parameter key.
', 'EnabledBaselineSummary$baselineIdentifier' => 'The specific baseline that is enabled as part of the EnabledBaseline resource.
The enabled version of the baseline.
', 'EnabledBaselineSummary$targetIdentifier' => 'The target upon which the baseline is enabled.
', 'EnabledControlParameter$key' => 'The key of a key/value pair.
', 'EnabledControlParameterSummary$key' => 'The key of a key/value pair.
', 'GetBaselineOutput$description' => 'A description of the baseline.
', 'GetBaselineOutput$name' => 'A user-friendly name for the baseline.
', 'GetLandingZoneInput$landingZoneIdentifier' => 'The unique identifier of the landing zone.
', 'InternalServerException$message' => NULL, 'LandingZoneOperationDetail$statusMessage' => 'If the operation result is FAILED, this string contains a message explaining why the operation failed.
', 'ListBaselinesInput$nextToken' => 'A pagination token.
', 'ListBaselinesOutput$nextToken' => 'A pagination token.
', 'ListEnabledControlsInput$nextToken' => 'The token to continue the list from a previous API call with the same parameters.
', 'ListEnabledControlsOutput$nextToken' => 'Retrieves the next page of results. If the string is empty, the response is the end of the results.
', 'ListLandingZonesInput$nextToken' => 'The token to continue the list from a previous API call with the same parameters.
', 'ListLandingZonesOutput$nextToken' => 'Retrieves the next page of results. If the string is empty, the response is the end of the results.
', 'ResetLandingZoneInput$landingZoneIdentifier' => 'The unique identifier of the landing zone.
', 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'ThrottlingException$quotaCode' => 'The ID of the service quota that was exceeded.
', 'ThrottlingException$serviceCode' => 'The ID of the service that is associated with the error.
', 'UpdateLandingZoneInput$landingZoneIdentifier' => 'The unique identifier of the landing zone.
', 'ValidationException$message' => NULL, ], ], 'SyntheticTimestamp_date_time' => [ 'base' => NULL, 'refs' => [ 'ControlOperation$endTime' => 'The time that the operation finished.
', 'ControlOperation$startTime' => 'The time that the operation began.
', 'ControlOperationSummary$endTime' => 'The time at which the control operation was completed.
', 'ControlOperationSummary$startTime' => 'The time at which a control operation began.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeys$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceInput$tagKeys' => 'Tag keys to be removed from the resource.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateLandingZoneInput$tags' => 'Tags to be applied to the landing zone.
', 'EnableBaselineInput$tags' => 'Tags associated with input to EnableBaseline.
Tags to be applied to the EnabledControl resource.
A list of tags, as key:value strings.
Tags to be applied to the resource.
', ], ], 'TagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'TargetIdentifier' => [ 'base' => NULL, 'refs' => [ 'ControlOperation$targetIdentifier' => 'The target upon which the control operation is working.
', 'ControlOperationSummary$targetIdentifier' => 'The unique identifier of the target of a control operation.
', 'DisableControlInput$targetIdentifier' => 'The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the organizational unit.
', 'ListEnabledControlsInput$targetIdentifier' => 'The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The set of targetIdentifier objects returned by the filter.
Target Amazon Web Services Regions for the enabled control.
', ], ], 'ThrottlingException' => [ 'base' => 'The request was denied due to request throttling.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'BaselineOperation$endTime' => 'The end time of the operation (if applicable), in ISO 8601 format.
', 'BaselineOperation$startTime' => 'The start time of the operation, in ISO 8601 format.
', 'LandingZoneOperationDetail$endTime' => 'The landing zone operation end time.
', 'LandingZoneOperationDetail$startTime' => 'The landing zone operation start time.
', ], ], 'UntagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEnabledBaselineInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEnabledBaselineOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEnabledControlInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEnabledControlOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLandingZoneInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLandingZoneOutput' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'The input does not satisfy the constraints specified by an Amazon Web Services service.
', 'refs' => [], ], ],]; diff --git a/src/data/controltower/2018-05-10/paginators-1.json b/src/data/controltower/2018-05-10/paginators-1.json index 10d8dd60fc..a8886472f4 100644 --- a/src/data/controltower/2018-05-10/paginators-1.json +++ b/src/data/controltower/2018-05-10/paginators-1.json @@ -6,6 +6,12 @@ "limit_key": "maxResults", "result_key": "baselines" }, + "ListControlOperations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "controlOperations" + }, "ListEnabledBaselines": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/src/data/controltower/2018-05-10/paginators-1.json.php b/src/data/controltower/2018-05-10/paginators-1.json.php index 4482d8574a..14ad0e0a4f 100644 --- a/src/data/controltower/2018-05-10/paginators-1.json.php +++ b/src/data/controltower/2018-05-10/paginators-1.json.php @@ -1,3 +1,3 @@ [ 'ListBaselines' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', 'result_key' => 'baselines', ], 'ListEnabledBaselines' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', 'result_key' => 'enabledBaselines', ], 'ListEnabledControls' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', 'result_key' => 'enabledControls', ], 'ListLandingZones' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', 'result_key' => 'landingZones', ], ],]; +return [ 'pagination' => [ 'ListBaselines' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', 'result_key' => 'baselines', ], 'ListControlOperations' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', 'result_key' => 'controlOperations', ], 'ListEnabledBaselines' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', 'result_key' => 'enabledBaselines', ], 'ListEnabledControls' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', 'result_key' => 'enabledControls', ], 'ListLandingZones' => [ 'input_token' => 'nextToken', 'output_token' => 'nextToken', 'limit_key' => 'maxResults', 'result_key' => 'landingZones', ], ],]; diff --git a/src/data/osis/2022-01-01/api-2.json b/src/data/osis/2022-01-01/api-2.json index 8312f2ce11..ea7523c1b5 100644 --- a/src/data/osis/2022-01-01/api-2.json +++ b/src/data/osis/2022-01-01/api-2.json @@ -4,6 +4,7 @@ "apiVersion":"2022-01-01", "endpointPrefix":"osis", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Amazon OpenSearch Ingestion", "serviceId":"OSIS", "signatureVersion":"v4", @@ -19,6 +20,7 @@ "input":{"shape":"CreatePipelineRequest"}, "output":{"shape":"CreatePipelineResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"LimitExceededException"}, {"shape":"ValidationException"}, {"shape":"InternalException"}, @@ -36,6 +38,7 @@ "input":{"shape":"DeletePipelineRequest"}, "output":{"shape":"DeletePipelineResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"}, {"shape":"AccessDeniedException"}, @@ -52,6 +55,7 @@ "input":{"shape":"GetPipelineRequest"}, "output":{"shape":"GetPipelineResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"}, {"shape":"AccessDeniedException"}, @@ -67,6 +71,7 @@ "input":{"shape":"GetPipelineBlueprintRequest"}, "output":{"shape":"GetPipelineBlueprintResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalException"}, {"shape":"ValidationException"}, @@ -82,6 +87,7 @@ "input":{"shape":"GetPipelineChangeProgressRequest"}, "output":{"shape":"GetPipelineChangeProgressResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"}, {"shape":"AccessDeniedException"}, @@ -97,6 +103,7 @@ "input":{"shape":"ListPipelineBlueprintsRequest"}, "output":{"shape":"ListPipelineBlueprintsResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"}, {"shape":"AccessDeniedException"}, @@ -112,6 +119,7 @@ "input":{"shape":"ListPipelinesRequest"}, "output":{"shape":"ListPipelinesResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"}, {"shape":"AccessDeniedException"}, @@ -127,6 +135,7 @@ "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalException"}, @@ -142,6 +151,7 @@ "input":{"shape":"StartPipelineRequest"}, "output":{"shape":"StartPipelineResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalException"}, @@ -158,6 +168,7 @@ "input":{"shape":"StopPipelineRequest"}, "output":{"shape":"StopPipelineResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalException"}, @@ -174,6 +185,7 @@ "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"LimitExceededException"}, {"shape":"ValidationException"}, {"shape":"InternalException"}, @@ -190,6 +202,7 @@ "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalException"}, @@ -205,6 +218,7 @@ "input":{"shape":"UpdatePipelineRequest"}, "output":{"shape":"UpdatePipelineResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"}, {"shape":"AccessDeniedException"}, @@ -221,6 +235,7 @@ "input":{"shape":"ValidatePipelineRequest"}, "output":{"shape":"ValidatePipelineResponse"}, "errors":[ + {"shape":"DisabledOperationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalException"}, {"shape":"ValidationException"} @@ -235,6 +250,10 @@ "error":{"httpStatusCode":403}, "exception":true }, + "BlueprintFormat":{ + "type":"string", + "pattern":"(YAML|JSON)" + }, "Boolean":{"type":"boolean"}, "BufferOptions":{ "type":"structure", @@ -287,6 +306,10 @@ "FAILED" ] }, + "CidrBlock":{ + "type":"string", + "pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[0-9])$" + }, "CloudWatchLogDestination":{ "type":"structure", "required":["LogGroup"], @@ -343,6 +366,13 @@ "members":{ } }, + "DisabledOperationException":{ + "type":"structure", + "members":{ + }, + "error":{"httpStatusCode":409}, + "exception":true + }, "EncryptionAtRestOptions":{ "type":"structure", "required":["KmsKeyArn"], @@ -358,13 +388,19 @@ "shape":"String", "location":"uri", "locationName":"BlueprintName" + }, + "Format":{ + "shape":"BlueprintFormat", + "location":"querystring", + "locationName":"format" } } }, "GetPipelineBlueprintResponse":{ "type":"structure", "members":{ - "Blueprint":{"shape":"PipelineBlueprint"} + "Blueprint":{"shape":"PipelineBlueprint"}, + "Format":{"shape":"String"} } }, "GetPipelineChangeProgressRequest":{ @@ -524,6 +560,7 @@ "BufferOptions":{"shape":"BufferOptions"}, "EncryptionAtRestOptions":{"shape":"EncryptionAtRestOptions"}, "ServiceVpcEndpoints":{"shape":"ServiceVpcEndpointsList"}, + "Destinations":{"shape":"PipelineDestinationList"}, "Tags":{"shape":"TagList"} } }, @@ -537,13 +574,21 @@ "type":"structure", "members":{ "BlueprintName":{"shape":"String"}, - "PipelineConfigurationBody":{"shape":"String"} + "PipelineConfigurationBody":{"shape":"String"}, + "DisplayName":{"shape":"String"}, + "DisplayDescription":{"shape":"String"}, + "Service":{"shape":"String"}, + "UseCase":{"shape":"String"} } }, "PipelineBlueprintSummary":{ "type":"structure", "members":{ - "BlueprintName":{"shape":"String"} + "BlueprintName":{"shape":"String"}, + "DisplayName":{"shape":"String"}, + "DisplayDescription":{"shape":"String"}, + "Service":{"shape":"String"}, + "UseCase":{"shape":"String"} } }, "PipelineBlueprintsSummaryList":{ @@ -555,6 +600,17 @@ "max":24000, "min":1 }, + "PipelineDestination":{ + "type":"structure", + "members":{ + "ServiceName":{"shape":"String"}, + "Endpoint":{"shape":"String"} + } + }, + "PipelineDestinationList":{ + "type":"list", + "member":{"shape":"PipelineDestination"} + }, "PipelineName":{ "type":"string", "max":28, @@ -593,6 +649,7 @@ "MaxUnits":{"shape":"PipelineUnits"}, "CreatedAt":{"shape":"Timestamp"}, "LastUpdatedAt":{"shape":"Timestamp"}, + "Destinations":{"shape":"PipelineDestinationList"}, "Tags":{"shape":"TagList"} } }, @@ -814,6 +871,14 @@ "type":"list", "member":{"shape":"ValidationMessage"} }, + "VpcAttachmentOptions":{ + "type":"structure", + "required":["AttachToVpc"], + "members":{ + "AttachToVpc":{"shape":"Boolean"}, + "CidrBlock":{"shape":"CidrBlock"} + } + }, "VpcEndpoint":{ "type":"structure", "members":{ @@ -835,7 +900,8 @@ "required":["SubnetIds"], "members":{ "SubnetIds":{"shape":"SubnetIds"}, - "SecurityGroupIds":{"shape":"SecurityGroupIds"} + "SecurityGroupIds":{"shape":"SecurityGroupIds"}, + "VpcAttachmentOptions":{"shape":"VpcAttachmentOptions"} } } } diff --git a/src/data/osis/2022-01-01/api-2.json.php b/src/data/osis/2022-01-01/api-2.json.php index dfe871787d..6c17b6da41 100644 --- a/src/data/osis/2022-01-01/api-2.json.php +++ b/src/data/osis/2022-01-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2022-01-01', 'endpointPrefix' => 'osis', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon OpenSearch Ingestion', 'serviceId' => 'OSIS', 'signatureVersion' => 'v4', 'uid' => 'osis-2022-01-01', ], 'operations' => [ 'CreatePipeline' => [ 'name' => 'CreatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/createPipeline', ], 'input' => [ 'shape' => 'CreatePipelineRequest', ], 'output' => [ 'shape' => 'CreatePipelineResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeletePipeline' => [ 'name' => 'DeletePipeline', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2022-01-01/osis/deletePipeline/{PipelineName}', ], 'input' => [ 'shape' => 'DeletePipelineRequest', ], 'output' => [ 'shape' => 'DeletePipelineResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetPipeline' => [ 'name' => 'GetPipeline', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/getPipeline/{PipelineName}', ], 'input' => [ 'shape' => 'GetPipelineRequest', ], 'output' => [ 'shape' => 'GetPipelineResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetPipelineBlueprint' => [ 'name' => 'GetPipelineBlueprint', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/getPipelineBlueprint/{BlueprintName}', ], 'input' => [ 'shape' => 'GetPipelineBlueprintRequest', ], 'output' => [ 'shape' => 'GetPipelineBlueprintResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetPipelineChangeProgress' => [ 'name' => 'GetPipelineChangeProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/getPipelineChangeProgress/{PipelineName}', ], 'input' => [ 'shape' => 'GetPipelineChangeProgressRequest', ], 'output' => [ 'shape' => 'GetPipelineChangeProgressResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListPipelineBlueprints' => [ 'name' => 'ListPipelineBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/listPipelineBlueprints', ], 'input' => [ 'shape' => 'ListPipelineBlueprintsRequest', ], 'output' => [ 'shape' => 'ListPipelineBlueprintsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidPaginationTokenException', ], ], ], 'ListPipelines' => [ 'name' => 'ListPipelines', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/listPipelines', ], 'input' => [ 'shape' => 'ListPipelinesRequest', ], 'output' => [ 'shape' => 'ListPipelinesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidPaginationTokenException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/listTagsForResource/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'StartPipeline' => [ 'name' => 'StartPipeline', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2022-01-01/osis/startPipeline/{PipelineName}', ], 'input' => [ 'shape' => 'StartPipelineRequest', ], 'output' => [ 'shape' => 'StartPipelineResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'StopPipeline' => [ 'name' => 'StopPipeline', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2022-01-01/osis/stopPipeline/{PipelineName}', ], 'input' => [ 'shape' => 'StopPipelineRequest', ], 'output' => [ 'shape' => 'StopPipelineResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/tagResource/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/untagResource/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdatePipeline' => [ 'name' => 'UpdatePipeline', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2022-01-01/osis/updatePipeline/{PipelineName}', ], 'input' => [ 'shape' => 'UpdatePipelineRequest', ], 'output' => [ 'shape' => 'UpdatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], ], 'ValidatePipeline' => [ 'name' => 'ValidatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/validatePipeline', ], 'input' => [ 'shape' => 'ValidatePipelineRequest', ], 'output' => [ 'shape' => 'ValidatePipelineResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'BufferOptions' => [ 'type' => 'structure', 'required' => [ 'PersistentBufferEnabled', ], 'members' => [ 'PersistentBufferEnabled' => [ 'shape' => 'Boolean', ], ], ], 'ChangeProgressStage' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ChangeProgressStageStatuses', ], 'Description' => [ 'shape' => 'String', ], 'LastUpdatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ChangeProgressStageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChangeProgressStage', ], ], 'ChangeProgressStageStatuses' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', ], ], 'ChangeProgressStatus' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'ChangeProgressStatuses', ], 'TotalNumberOfStages' => [ 'shape' => 'Integer', ], 'ChangeProgressStages' => [ 'shape' => 'ChangeProgressStageList', ], ], ], 'ChangeProgressStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChangeProgressStatus', ], ], 'ChangeProgressStatuses' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', ], ], 'CloudWatchLogDestination' => [ 'type' => 'structure', 'required' => [ 'LogGroup', ], 'members' => [ 'LogGroup' => [ 'shape' => 'LogGroup', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'CreatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'MinUnits', 'MaxUnits', 'PipelineConfigurationBody', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'MinUnits' => [ 'shape' => 'PipelineUnits', ], 'MaxUnits' => [ 'shape' => 'PipelineUnits', ], 'PipelineConfigurationBody' => [ 'shape' => 'PipelineConfigurationBody', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'VpcOptions' => [ 'shape' => 'VpcOptions', ], 'BufferOptions' => [ 'shape' => 'BufferOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'DeletePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'DeletePipelineResponse' => [ 'type' => 'structure', 'members' => [], ], 'EncryptionAtRestOptions' => [ 'type' => 'structure', 'required' => [ 'KmsKeyArn', ], 'members' => [ 'KmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'GetPipelineBlueprintRequest' => [ 'type' => 'structure', 'required' => [ 'BlueprintName', ], 'members' => [ 'BlueprintName' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'BlueprintName', ], ], ], 'GetPipelineBlueprintResponse' => [ 'type' => 'structure', 'members' => [ 'Blueprint' => [ 'shape' => 'PipelineBlueprint', ], ], ], 'GetPipelineChangeProgressRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'GetPipelineChangeProgressResponse' => [ 'type' => 'structure', 'members' => [ 'ChangeProgressStatuses' => [ 'shape' => 'ChangeProgressStatusList', ], ], ], 'GetPipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'GetPipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'IngestEndpointUrlsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'InvalidPaginationTokenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 7, ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ListPipelineBlueprintsRequest' => [ 'type' => 'structure', 'members' => [], ], 'ListPipelineBlueprintsResponse' => [ 'type' => 'structure', 'members' => [ 'Blueprints' => [ 'shape' => 'PipelineBlueprintsSummaryList', ], ], ], 'ListPipelinesRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListPipelinesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'Pipelines' => [ 'shape' => 'PipelineSummaryList', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'PipelineArn', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'LogGroup' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '\\/aws\\/vendedlogs\\/[\\.\\-_/#A-Za-z0-9]+', ], 'LogPublishingOptions' => [ 'type' => 'structure', 'members' => [ 'IsLoggingEnabled' => [ 'shape' => 'Boolean', ], 'CloudWatchLogDestination' => [ 'shape' => 'CloudWatchLogDestination', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'NextToken' => [ 'type' => 'string', 'max' => 3000, 'min' => 0, 'pattern' => '^([\\s\\S]*)$', ], 'Pipeline' => [ 'type' => 'structure', 'members' => [ 'PipelineName' => [ 'shape' => 'String', ], 'PipelineArn' => [ 'shape' => 'String', ], 'MinUnits' => [ 'shape' => 'Integer', ], 'MaxUnits' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'PipelineStatus', ], 'StatusReason' => [ 'shape' => 'PipelineStatusReason', ], 'PipelineConfigurationBody' => [ 'shape' => 'String', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastUpdatedAt' => [ 'shape' => 'Timestamp', ], 'IngestEndpointUrls' => [ 'shape' => 'IngestEndpointUrlsList', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'VpcEndpoints' => [ 'shape' => 'VpcEndpointsList', ], 'BufferOptions' => [ 'shape' => 'BufferOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'ServiceVpcEndpoints' => [ 'shape' => 'ServiceVpcEndpointsList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineArn' => [ 'type' => 'string', 'max' => 76, 'min' => 46, 'pattern' => '^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):osis:.+:pipeline\\/.+$', ], 'PipelineBlueprint' => [ 'type' => 'structure', 'members' => [ 'BlueprintName' => [ 'shape' => 'String', ], 'PipelineConfigurationBody' => [ 'shape' => 'String', ], ], ], 'PipelineBlueprintSummary' => [ 'type' => 'structure', 'members' => [ 'BlueprintName' => [ 'shape' => 'String', ], ], ], 'PipelineBlueprintsSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineBlueprintSummary', ], ], 'PipelineConfigurationBody' => [ 'type' => 'string', 'max' => 24000, 'min' => 1, ], 'PipelineName' => [ 'type' => 'string', 'max' => 28, 'min' => 3, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'PipelineStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'CREATE_FAILED', 'UPDATE_FAILED', 'STARTING', 'START_FAILED', 'STOPPING', 'STOPPED', ], ], 'PipelineStatusReason' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'String', ], ], ], 'PipelineSummary' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'PipelineStatus', ], 'StatusReason' => [ 'shape' => 'PipelineStatusReason', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'MinUnits' => [ 'shape' => 'PipelineUnits', ], 'MaxUnits' => [ 'shape' => 'PipelineUnits', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastUpdatedAt' => [ 'shape' => 'Timestamp', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineSummary', ], ], 'PipelineUnits' => [ 'type' => 'integer', 'min' => 1, ], 'ResourceAlreadyExistsException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 20, 'min' => 11, 'pattern' => 'sg-\\w{8}(\\w{9})?', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 12, 'min' => 1, ], 'ServiceVpcEndpoint' => [ 'type' => 'structure', 'members' => [ 'ServiceName' => [ 'shape' => 'VpcEndpointServiceName', ], 'VpcEndpointId' => [ 'shape' => 'String', ], ], ], 'ServiceVpcEndpointsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceVpcEndpoint', ], ], 'StartPipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'StartPipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'StopPipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'StopPipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 24, 'min' => 15, 'pattern' => 'subnet-\\w{8}(\\w{9})?', ], 'SubnetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 12, 'min' => 1, ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Tags', ], 'members' => [ 'Arn' => [ 'shape' => 'PipelineArn', 'location' => 'querystring', 'locationName' => 'arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'TagKeys', ], 'members' => [ 'Arn' => [ 'shape' => 'PipelineArn', 'location' => 'querystring', 'locationName' => 'arn', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], 'MinUnits' => [ 'shape' => 'PipelineUnits', ], 'MaxUnits' => [ 'shape' => 'PipelineUnits', ], 'PipelineConfigurationBody' => [ 'shape' => 'PipelineConfigurationBody', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'BufferOptions' => [ 'shape' => 'BufferOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], ], ], 'UpdatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'ValidatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineConfigurationBody', ], 'members' => [ 'PipelineConfigurationBody' => [ 'shape' => 'PipelineConfigurationBody', ], ], ], 'ValidatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'isValid' => [ 'shape' => 'Boolean', ], 'Errors' => [ 'shape' => 'ValidationMessageList', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationMessage' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'ValidationMessageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationMessage', ], ], 'VpcEndpoint' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'VpcOptions' => [ 'shape' => 'VpcOptions', ], ], ], 'VpcEndpointServiceName' => [ 'type' => 'string', 'enum' => [ 'OPENSEARCH_SERVERLESS', ], ], 'VpcEndpointsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpoint', ], ], 'VpcOptions' => [ 'type' => 'structure', 'required' => [ 'SubnetIds', ], 'members' => [ 'SubnetIds' => [ 'shape' => 'SubnetIds', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2022-01-01', 'endpointPrefix' => 'osis', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'Amazon OpenSearch Ingestion', 'serviceId' => 'OSIS', 'signatureVersion' => 'v4', 'uid' => 'osis-2022-01-01', ], 'operations' => [ 'CreatePipeline' => [ 'name' => 'CreatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/createPipeline', ], 'input' => [ 'shape' => 'CreatePipelineRequest', ], 'output' => [ 'shape' => 'CreatePipelineResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeletePipeline' => [ 'name' => 'DeletePipeline', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2022-01-01/osis/deletePipeline/{PipelineName}', ], 'input' => [ 'shape' => 'DeletePipelineRequest', ], 'output' => [ 'shape' => 'DeletePipelineResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetPipeline' => [ 'name' => 'GetPipeline', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/getPipeline/{PipelineName}', ], 'input' => [ 'shape' => 'GetPipelineRequest', ], 'output' => [ 'shape' => 'GetPipelineResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetPipelineBlueprint' => [ 'name' => 'GetPipelineBlueprint', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/getPipelineBlueprint/{BlueprintName}', ], 'input' => [ 'shape' => 'GetPipelineBlueprintRequest', ], 'output' => [ 'shape' => 'GetPipelineBlueprintResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetPipelineChangeProgress' => [ 'name' => 'GetPipelineChangeProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/getPipelineChangeProgress/{PipelineName}', ], 'input' => [ 'shape' => 'GetPipelineChangeProgressRequest', ], 'output' => [ 'shape' => 'GetPipelineChangeProgressResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListPipelineBlueprints' => [ 'name' => 'ListPipelineBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/listPipelineBlueprints', ], 'input' => [ 'shape' => 'ListPipelineBlueprintsRequest', ], 'output' => [ 'shape' => 'ListPipelineBlueprintsResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidPaginationTokenException', ], ], ], 'ListPipelines' => [ 'name' => 'ListPipelines', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/listPipelines', ], 'input' => [ 'shape' => 'ListPipelinesRequest', ], 'output' => [ 'shape' => 'ListPipelinesResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidPaginationTokenException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/2022-01-01/osis/listTagsForResource/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'StartPipeline' => [ 'name' => 'StartPipeline', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2022-01-01/osis/startPipeline/{PipelineName}', ], 'input' => [ 'shape' => 'StartPipelineRequest', ], 'output' => [ 'shape' => 'StartPipelineResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'StopPipeline' => [ 'name' => 'StopPipeline', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2022-01-01/osis/stopPipeline/{PipelineName}', ], 'input' => [ 'shape' => 'StopPipelineRequest', ], 'output' => [ 'shape' => 'StopPipelineResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/tagResource/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/untagResource/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdatePipeline' => [ 'name' => 'UpdatePipeline', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2022-01-01/osis/updatePipeline/{PipelineName}', ], 'input' => [ 'shape' => 'UpdatePipelineRequest', ], 'output' => [ 'shape' => 'UpdatePipelineResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], ], ], 'ValidatePipeline' => [ 'name' => 'ValidatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/2022-01-01/osis/validatePipeline', ], 'input' => [ 'shape' => 'ValidatePipelineRequest', ], 'output' => [ 'shape' => 'ValidatePipelineResponse', ], 'errors' => [ [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'BlueprintFormat' => [ 'type' => 'string', 'pattern' => '(YAML|JSON)', ], 'Boolean' => [ 'type' => 'boolean', ], 'BufferOptions' => [ 'type' => 'structure', 'required' => [ 'PersistentBufferEnabled', ], 'members' => [ 'PersistentBufferEnabled' => [ 'shape' => 'Boolean', ], ], ], 'ChangeProgressStage' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ChangeProgressStageStatuses', ], 'Description' => [ 'shape' => 'String', ], 'LastUpdatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ChangeProgressStageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChangeProgressStage', ], ], 'ChangeProgressStageStatuses' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', ], ], 'ChangeProgressStatus' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'ChangeProgressStatuses', ], 'TotalNumberOfStages' => [ 'shape' => 'Integer', ], 'ChangeProgressStages' => [ 'shape' => 'ChangeProgressStageList', ], ], ], 'ChangeProgressStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChangeProgressStatus', ], ], 'ChangeProgressStatuses' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', ], ], 'CidrBlock' => [ 'type' => 'string', 'pattern' => '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[0-9])$', ], 'CloudWatchLogDestination' => [ 'type' => 'structure', 'required' => [ 'LogGroup', ], 'members' => [ 'LogGroup' => [ 'shape' => 'LogGroup', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'CreatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'MinUnits', 'MaxUnits', 'PipelineConfigurationBody', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'MinUnits' => [ 'shape' => 'PipelineUnits', ], 'MaxUnits' => [ 'shape' => 'PipelineUnits', ], 'PipelineConfigurationBody' => [ 'shape' => 'PipelineConfigurationBody', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'VpcOptions' => [ 'shape' => 'VpcOptions', ], 'BufferOptions' => [ 'shape' => 'BufferOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'DeletePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'DeletePipelineResponse' => [ 'type' => 'structure', 'members' => [], ], 'DisabledOperationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'EncryptionAtRestOptions' => [ 'type' => 'structure', 'required' => [ 'KmsKeyArn', ], 'members' => [ 'KmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'GetPipelineBlueprintRequest' => [ 'type' => 'structure', 'required' => [ 'BlueprintName', ], 'members' => [ 'BlueprintName' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'BlueprintName', ], 'Format' => [ 'shape' => 'BlueprintFormat', 'location' => 'querystring', 'locationName' => 'format', ], ], ], 'GetPipelineBlueprintResponse' => [ 'type' => 'structure', 'members' => [ 'Blueprint' => [ 'shape' => 'PipelineBlueprint', ], 'Format' => [ 'shape' => 'String', ], ], ], 'GetPipelineChangeProgressRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'GetPipelineChangeProgressResponse' => [ 'type' => 'structure', 'members' => [ 'ChangeProgressStatuses' => [ 'shape' => 'ChangeProgressStatusList', ], ], ], 'GetPipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'GetPipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'IngestEndpointUrlsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'InvalidPaginationTokenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 7, ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ListPipelineBlueprintsRequest' => [ 'type' => 'structure', 'members' => [], ], 'ListPipelineBlueprintsResponse' => [ 'type' => 'structure', 'members' => [ 'Blueprints' => [ 'shape' => 'PipelineBlueprintsSummaryList', ], ], ], 'ListPipelinesRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListPipelinesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'Pipelines' => [ 'shape' => 'PipelineSummaryList', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'PipelineArn', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'LogGroup' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '\\/aws\\/vendedlogs\\/[\\.\\-_/#A-Za-z0-9]+', ], 'LogPublishingOptions' => [ 'type' => 'structure', 'members' => [ 'IsLoggingEnabled' => [ 'shape' => 'Boolean', ], 'CloudWatchLogDestination' => [ 'shape' => 'CloudWatchLogDestination', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'NextToken' => [ 'type' => 'string', 'max' => 3000, 'min' => 0, 'pattern' => '^([\\s\\S]*)$', ], 'Pipeline' => [ 'type' => 'structure', 'members' => [ 'PipelineName' => [ 'shape' => 'String', ], 'PipelineArn' => [ 'shape' => 'String', ], 'MinUnits' => [ 'shape' => 'Integer', ], 'MaxUnits' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'PipelineStatus', ], 'StatusReason' => [ 'shape' => 'PipelineStatusReason', ], 'PipelineConfigurationBody' => [ 'shape' => 'String', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastUpdatedAt' => [ 'shape' => 'Timestamp', ], 'IngestEndpointUrls' => [ 'shape' => 'IngestEndpointUrlsList', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'VpcEndpoints' => [ 'shape' => 'VpcEndpointsList', ], 'BufferOptions' => [ 'shape' => 'BufferOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'ServiceVpcEndpoints' => [ 'shape' => 'ServiceVpcEndpointsList', ], 'Destinations' => [ 'shape' => 'PipelineDestinationList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineArn' => [ 'type' => 'string', 'max' => 76, 'min' => 46, 'pattern' => '^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):osis:.+:pipeline\\/.+$', ], 'PipelineBlueprint' => [ 'type' => 'structure', 'members' => [ 'BlueprintName' => [ 'shape' => 'String', ], 'PipelineConfigurationBody' => [ 'shape' => 'String', ], 'DisplayName' => [ 'shape' => 'String', ], 'DisplayDescription' => [ 'shape' => 'String', ], 'Service' => [ 'shape' => 'String', ], 'UseCase' => [ 'shape' => 'String', ], ], ], 'PipelineBlueprintSummary' => [ 'type' => 'structure', 'members' => [ 'BlueprintName' => [ 'shape' => 'String', ], 'DisplayName' => [ 'shape' => 'String', ], 'DisplayDescription' => [ 'shape' => 'String', ], 'Service' => [ 'shape' => 'String', ], 'UseCase' => [ 'shape' => 'String', ], ], ], 'PipelineBlueprintsSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineBlueprintSummary', ], ], 'PipelineConfigurationBody' => [ 'type' => 'string', 'max' => 24000, 'min' => 1, ], 'PipelineDestination' => [ 'type' => 'structure', 'members' => [ 'ServiceName' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], ], ], 'PipelineDestinationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineDestination', ], ], 'PipelineName' => [ 'type' => 'string', 'max' => 28, 'min' => 3, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'PipelineStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'CREATE_FAILED', 'UPDATE_FAILED', 'STARTING', 'START_FAILED', 'STOPPING', 'STOPPED', ], ], 'PipelineStatusReason' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'String', ], ], ], 'PipelineSummary' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'PipelineStatus', ], 'StatusReason' => [ 'shape' => 'PipelineStatusReason', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'MinUnits' => [ 'shape' => 'PipelineUnits', ], 'MaxUnits' => [ 'shape' => 'PipelineUnits', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastUpdatedAt' => [ 'shape' => 'Timestamp', ], 'Destinations' => [ 'shape' => 'PipelineDestinationList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineSummary', ], ], 'PipelineUnits' => [ 'type' => 'integer', 'min' => 1, ], 'ResourceAlreadyExistsException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 20, 'min' => 11, 'pattern' => 'sg-\\w{8}(\\w{9})?', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 12, 'min' => 1, ], 'ServiceVpcEndpoint' => [ 'type' => 'structure', 'members' => [ 'ServiceName' => [ 'shape' => 'VpcEndpointServiceName', ], 'VpcEndpointId' => [ 'shape' => 'String', ], ], ], 'ServiceVpcEndpointsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceVpcEndpoint', ], ], 'StartPipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'StartPipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'StopPipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], ], ], 'StopPipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 24, 'min' => 15, 'pattern' => 'subnet-\\w{8}(\\w{9})?', ], 'SubnetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 12, 'min' => 1, ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Tags', ], 'members' => [ 'Arn' => [ 'shape' => 'PipelineArn', 'location' => 'querystring', 'locationName' => 'arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'Arn', 'TagKeys', ], 'members' => [ 'Arn' => [ 'shape' => 'PipelineArn', 'location' => 'querystring', 'locationName' => 'arn', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', 'location' => 'uri', 'locationName' => 'PipelineName', ], 'MinUnits' => [ 'shape' => 'PipelineUnits', ], 'MaxUnits' => [ 'shape' => 'PipelineUnits', ], 'PipelineConfigurationBody' => [ 'shape' => 'PipelineConfigurationBody', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'BufferOptions' => [ 'shape' => 'BufferOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], ], ], 'UpdatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'Pipeline' => [ 'shape' => 'Pipeline', ], ], ], 'ValidatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineConfigurationBody', ], 'members' => [ 'PipelineConfigurationBody' => [ 'shape' => 'PipelineConfigurationBody', ], ], ], 'ValidatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'isValid' => [ 'shape' => 'Boolean', ], 'Errors' => [ 'shape' => 'ValidationMessageList', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationMessage' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'ValidationMessageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationMessage', ], ], 'VpcAttachmentOptions' => [ 'type' => 'structure', 'required' => [ 'AttachToVpc', ], 'members' => [ 'AttachToVpc' => [ 'shape' => 'Boolean', ], 'CidrBlock' => [ 'shape' => 'CidrBlock', ], ], ], 'VpcEndpoint' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'VpcOptions' => [ 'shape' => 'VpcOptions', ], ], ], 'VpcEndpointServiceName' => [ 'type' => 'string', 'enum' => [ 'OPENSEARCH_SERVERLESS', ], ], 'VpcEndpointsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpoint', ], ], 'VpcOptions' => [ 'type' => 'structure', 'required' => [ 'SubnetIds', ], 'members' => [ 'SubnetIds' => [ 'shape' => 'SubnetIds', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'VpcAttachmentOptions' => [ 'shape' => 'VpcAttachmentOptions', ], ], ], ],]; diff --git a/src/data/osis/2022-01-01/docs-2.json b/src/data/osis/2022-01-01/docs-2.json index d1211c38e6..8028558ff3 100644 --- a/src/data/osis/2022-01-01/docs-2.json +++ b/src/data/osis/2022-01-01/docs-2.json @@ -23,16 +23,23 @@ "refs": { } }, + "BlueprintFormat": { + "base": null, + "refs": { + "GetPipelineBlueprintRequest$Format": "The format format of the blueprint to retrieve.
" + } + }, "Boolean": { "base": null, "refs": { "BufferOptions$PersistentBufferEnabled": "Whether persistent buffering should be enabled.
", "LogPublishingOptions$IsLoggingEnabled": "Whether logs should be published.
", - "ValidatePipelineResponse$isValid": "A boolean indicating whether or not the pipeline configuration is valid.
" + "ValidatePipelineResponse$isValid": "A boolean indicating whether or not the pipeline configuration is valid.
", + "VpcAttachmentOptions$AttachToVpc": "Whether a VPC is attached to the pipeline.
" } }, "BufferOptions": { - "base": "Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions.
", + "base": "Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.
Key-value pairs to configure persistent buffering for the pipeline.
", "Pipeline$BufferOptions": null, @@ -75,6 +82,12 @@ "ChangeProgressStatus$Status": "The overall status of the pipeline configuration change.
" } }, + "CidrBlock": { + "base": null, + "refs": { + "VpcAttachmentOptions$CidrBlock": "The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
" + } + }, "CloudWatchLogDestination": { "base": "The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.
", "refs": { @@ -106,8 +119,13 @@ "refs": { } }, + "DisabledOperationException": { + "base": "Exception is thrown when an operation has been disabled.
", + "refs": { + } + }, "EncryptionAtRestOptions": { - "base": "Options to control how OpenSearch encrypts all data-at-rest.
", + "base": "Options to control how OpenSearch encrypts buffer data.
", "refs": { "CreatePipelineRequest$EncryptionAtRestOptions": "Key-value pairs to configure encryption for data that is written to a persistent buffer.
", "Pipeline$EncryptionAtRestOptions": null, @@ -171,7 +189,7 @@ "KmsKeyArn": { "base": null, "refs": { - "EncryptionAtRestOptions$KmsKeyArn": "The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.
" + "EncryptionAtRestOptions$KmsKeyArn": "The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key.
" } }, "LimitExceededException": { @@ -212,7 +230,7 @@ "LogGroup": { "base": null, "refs": { - "CloudWatchLogDestination$LogGroup": "The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.
The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/vendedlogs/OpenSearchService/pipelines.
The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
An object representing the destination of a pipeline.
", + "refs": { + "PipelineDestinationList$member": null + } + }, + "PipelineDestinationList": { + "base": null, + "refs": { + "Pipeline$Destinations": "Destinations to which the pipeline writes data.
", + "PipelineSummary$Destinations": "A list of destinations to which the pipeline writes data.
" + } + }, "PipelineName": { "base": null, "refs": { "CreatePipelineRequest$PipelineName": "The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.
", "DeletePipelineRequest$PipelineName": "The name of the pipeline to delete.
", "GetPipelineChangeProgressRequest$PipelineName": "The name of the pipeline.
", - "GetPipelineRequest$PipelineName": "The name of the pipeline to get information about.
", + "GetPipelineRequest$PipelineName": "The name of the pipeline.
", "PipelineSummary$PipelineName": "The name of the pipeline.
", "StartPipelineRequest$PipelineName": "The name of the pipeline to start.
", "StopPipelineRequest$PipelineName": "The name of the pipeline to stop.
", @@ -362,7 +393,7 @@ "ServiceVpcEndpointsList": { "base": null, "refs": { - "Pipeline$ServiceVpcEndpoints": "A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.
" + "Pipeline$ServiceVpcEndpoints": "A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
" } }, "StartPipelineRequest": { @@ -391,15 +422,26 @@ "ChangeProgressStage$Name": "The name of the stage.
", "ChangeProgressStage$Description": "A description of the stage.
", "GetPipelineBlueprintRequest$BlueprintName": "The name of the blueprint to retrieve.
", + "GetPipelineBlueprintResponse$Format": "The format of the blueprint.
", "IngestEndpointUrlsList$member": null, "Pipeline$PipelineName": "The name of the pipeline.
", "Pipeline$PipelineArn": "The Amazon Resource Name (ARN) of the pipeline.
", "Pipeline$PipelineConfigurationBody": "The Data Prepper pipeline configuration in YAML format.
", "PipelineBlueprint$BlueprintName": "The name of the blueprint.
", "PipelineBlueprint$PipelineConfigurationBody": "The YAML configuration of the blueprint.
", + "PipelineBlueprint$DisplayName": "The display name of the blueprint.
", + "PipelineBlueprint$DisplayDescription": "A description of the blueprint.
", + "PipelineBlueprint$Service": "The name of the service that the blueprint is associated with.
", + "PipelineBlueprint$UseCase": "The use case that the blueprint relates to.
", "PipelineBlueprintSummary$BlueprintName": "The name of the blueprint.
", + "PipelineBlueprintSummary$DisplayName": "The display name of the blueprint.
", + "PipelineBlueprintSummary$DisplayDescription": "A description of the blueprint.
", + "PipelineBlueprintSummary$Service": "The name of the service that the blueprint is associated with.
", + "PipelineBlueprintSummary$UseCase": "The use case that the blueprint relates to.
", + "PipelineDestination$ServiceName": "The name of the service receiving data from the pipeline.
", + "PipelineDestination$Endpoint": "The endpoint receiving data from the pipeline.
", "PipelineStatusReason$Description": "A description of why a pipeline has a certain status.
", - "ServiceVpcEndpoint$VpcEndpointId": "The ID of the VPC endpoint that was created.
", + "ServiceVpcEndpoint$VpcEndpointId": "The unique identifier of the VPC endpoint that was created.
", "StringList$member": null, "ValidationMessage$Message": "The validation message.
", "VpcEndpoint$VpcEndpointId": "The unique identifier of the endpoint.
", @@ -520,6 +562,12 @@ "ValidatePipelineResponse$Errors": "A list of errors if the configuration is invalid.
" } }, + "VpcAttachmentOptions": { + "base": "Options for attaching a VPC to pipeline.
", + "refs": { + "VpcOptions$VpcAttachmentOptions": "Options for attaching a VPC to a pipeline.
" + } + }, "VpcEndpoint": { "base": "An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.
", "refs": { diff --git a/src/data/osis/2022-01-01/docs-2.json.php b/src/data/osis/2022-01-01/docs-2.json.php index 6e00f6ac15..fcfd34daad 100644 --- a/src/data/osis/2022-01-01/docs-2.json.php +++ b/src/data/osis/2022-01-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion.
', 'operations' => [ 'CreatePipeline' => 'Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
', 'DeletePipeline' => 'Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
', 'GetPipeline' => 'Retrieves information about an OpenSearch Ingestion pipeline.
', 'GetPipelineBlueprint' => 'Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.
For more information, see Tracking the status of pipeline creation.
', 'ListPipelineBlueprints' => 'Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
', 'ListPipelines' => 'Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
', 'ListTagsForResource' => 'Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
', 'StartPipeline' => 'Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
', 'StopPipeline' => 'Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
', 'TagResource' => 'Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
', 'UntagResource' => 'Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
', 'UpdatePipeline' => 'Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
', 'ValidatePipeline' => 'Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You don\'t have permissions to access the resource.
', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'BufferOptions$PersistentBufferEnabled' => 'Whether persistent buffering should be enabled.
', 'LogPublishingOptions$IsLoggingEnabled' => 'Whether logs should be published.
', 'ValidatePipelineResponse$isValid' => 'A boolean indicating whether or not the pipeline configuration is valid.
', ], ], 'BufferOptions' => [ 'base' => 'Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions.
', 'refs' => [ 'CreatePipelineRequest$BufferOptions' => 'Key-value pairs to configure persistent buffering for the pipeline.
', 'Pipeline$BufferOptions' => NULL, 'UpdatePipelineRequest$BufferOptions' => 'Key-value pairs to configure persistent buffering for the pipeline.
', ], ], 'ChangeProgressStage' => [ 'base' => 'Progress details for a specific stage of a pipeline configuration change.
', 'refs' => [ 'ChangeProgressStageList$member' => NULL, ], ], 'ChangeProgressStageList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatus$ChangeProgressStages' => 'Information about the stages that the pipeline is going through to perform the configuration change.
', ], ], 'ChangeProgressStageStatuses' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => 'The current status of the stage that the change is in.
', ], ], 'ChangeProgressStatus' => [ 'base' => 'The progress details of a pipeline configuration change.
', 'refs' => [ 'ChangeProgressStatusList$member' => NULL, ], ], 'ChangeProgressStatusList' => [ 'base' => NULL, 'refs' => [ 'GetPipelineChangeProgressResponse$ChangeProgressStatuses' => 'The current status of the change happening on the pipeline.
', ], ], 'ChangeProgressStatuses' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatus$Status' => 'The overall status of the pipeline configuration change.
', ], ], 'CloudWatchLogDestination' => [ 'base' => 'The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.
', 'refs' => [ 'LogPublishingOptions$CloudWatchLogDestination' => 'The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.
The client attempted to remove a resource that is currently in use.
', 'refs' => [], ], 'CreatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'EncryptionAtRestOptions' => [ 'base' => 'Options to control how OpenSearch encrypts all data-at-rest.
', 'refs' => [ 'CreatePipelineRequest$EncryptionAtRestOptions' => 'Key-value pairs to configure encryption for data that is written to a persistent buffer.
', 'Pipeline$EncryptionAtRestOptions' => NULL, 'UpdatePipelineRequest$EncryptionAtRestOptions' => 'Key-value pairs to configure encryption for data that is written to a persistent buffer.
', ], ], 'GetPipelineBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineChangeProgressRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineChangeProgressResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'IngestEndpointUrlsList' => [ 'base' => NULL, 'refs' => [ 'Pipeline$IngestEndpointUrls' => 'The ingestion endpoints for the pipeline, which you can send data to.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatus$TotalNumberOfStages' => 'The total number of stages required for the pipeline configuration change.
', 'Pipeline$MinUnits' => 'The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'Pipeline$MaxUnits' => 'The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
', ], ], 'InternalException' => [ 'base' => 'The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
', 'refs' => [], ], 'InvalidPaginationTokenException' => [ 'base' => 'An invalid pagination token provided in the request.
', 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyArn' => 'The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.
', ], ], 'LimitExceededException' => [ 'base' => 'You attempted to create more than the allowed number of tags.
', 'refs' => [], ], 'ListPipelineBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogGroup' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLogDestination$LogGroup' => 'The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.
Container for the values required to configure logging for the pipeline. If you don\'t specify these values, OpenSearch Ingestion will not publish logs from your application to CloudWatch Logs.
', 'refs' => [ 'CreatePipelineRequest$LogPublishingOptions' => 'Key-value pairs to configure log publishing.
', 'Pipeline$LogPublishingOptions' => 'Key-value pairs that represent log publishing settings.
', 'UpdatePipelineRequest$LogPublishingOptions' => 'Key-value pairs to configure log publishing.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesRequest$MaxResults' => 'An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Information about an existing OpenSearch Ingestion pipeline.
', 'refs' => [ 'CreatePipelineResponse$Pipeline' => 'Container for information about the created pipeline.
', 'GetPipelineResponse$Pipeline' => 'Detailed information about the requested pipeline.
', 'StartPipelineResponse$Pipeline' => NULL, 'StopPipelineResponse$Pipeline' => NULL, 'UpdatePipelineResponse$Pipeline' => 'Container for information about the updated pipeline.
', ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$Arn' => 'The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.
', 'PipelineSummary$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'TagResourceRequest$Arn' => 'The Amazon Resource Name (ARN) of the pipeline to tag.
', 'UntagResourceRequest$Arn' => 'The Amazon Resource Name (ARN) of the pipeline to remove tags from.
', ], ], 'PipelineBlueprint' => [ 'base' => 'Container for information about an OpenSearch Ingestion blueprint.
', 'refs' => [ 'GetPipelineBlueprintResponse$Blueprint' => 'The requested blueprint in YAML format.
', ], ], 'PipelineBlueprintSummary' => [ 'base' => 'A summary of an OpenSearch Ingestion blueprint.
', 'refs' => [ 'PipelineBlueprintsSummaryList$member' => NULL, ], ], 'PipelineBlueprintsSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineBlueprintsResponse$Blueprints' => 'A list of available blueprints for Data Prepper.
', ], ], 'PipelineConfigurationBody' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineConfigurationBody' => 'The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.
', 'DeletePipelineRequest$PipelineName' => 'The name of the pipeline to delete.
', 'GetPipelineChangeProgressRequest$PipelineName' => 'The name of the pipeline.
', 'GetPipelineRequest$PipelineName' => 'The name of the pipeline to get information about.
', 'PipelineSummary$PipelineName' => 'The name of the pipeline.
', 'StartPipelineRequest$PipelineName' => 'The name of the pipeline to start.
', 'StopPipelineRequest$PipelineName' => 'The name of the pipeline to stop.
', 'UpdatePipelineRequest$PipelineName' => 'The name of the pipeline to update.
', ], ], 'PipelineStatus' => [ 'base' => NULL, 'refs' => [ 'Pipeline$Status' => 'The current status of the pipeline.
', 'PipelineSummary$Status' => 'The current status of the pipeline.
', ], ], 'PipelineStatusReason' => [ 'base' => 'Information about a pipeline\'s current status.
', 'refs' => [ 'Pipeline$StatusReason' => 'The reason for the current status of the pipeline.
', 'PipelineSummary$StatusReason' => NULL, ], ], 'PipelineSummary' => [ 'base' => 'Summary information for an OpenSearch Ingestion pipeline.
', 'refs' => [ 'PipelineSummaryList$member' => NULL, ], ], 'PipelineSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesResponse$Pipelines' => 'A list of all existing Data Prepper pipelines.
', ], ], 'PipelineUnits' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$MinUnits' => 'The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'CreatePipelineRequest$MaxUnits' => 'The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'PipelineSummary$MinUnits' => 'The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'PipelineSummary$MaxUnits' => 'The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'UpdatePipelineRequest$MinUnits' => 'The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'UpdatePipelineRequest$MaxUnits' => 'The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
', ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'You attempted to create a resource that already exists.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'You attempted to access or delete a resource that does not exist.
', 'refs' => [], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcOptions$SecurityGroupIds' => 'A list of security groups associated with the VPC endpoint.
', ], ], 'ServiceVpcEndpoint' => [ 'base' => 'A container for information about VPC endpoints that were created to other services
', 'refs' => [ 'ServiceVpcEndpointsList$member' => NULL, ], ], 'ServiceVpcEndpointsList' => [ 'base' => NULL, 'refs' => [ 'Pipeline$ServiceVpcEndpoints' => 'A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.
', ], ], 'StartPipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Name' => 'The name of the stage.
', 'ChangeProgressStage$Description' => 'A description of the stage.
', 'GetPipelineBlueprintRequest$BlueprintName' => 'The name of the blueprint to retrieve.
', 'IngestEndpointUrlsList$member' => NULL, 'Pipeline$PipelineName' => 'The name of the pipeline.
', 'Pipeline$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'Pipeline$PipelineConfigurationBody' => 'The Data Prepper pipeline configuration in YAML format.
', 'PipelineBlueprint$BlueprintName' => 'The name of the blueprint.
', 'PipelineBlueprint$PipelineConfigurationBody' => 'The YAML configuration of the blueprint.
', 'PipelineBlueprintSummary$BlueprintName' => 'The name of the blueprint.
', 'PipelineStatusReason$Description' => 'A description of why a pipeline has a certain status.
', 'ServiceVpcEndpoint$VpcEndpointId' => 'The ID of the VPC endpoint that was created.
', 'StringList$member' => NULL, 'ValidationMessage$Message' => 'The validation message.
', 'VpcEndpoint$VpcEndpointId' => 'The unique identifier of the endpoint.
', 'VpcEndpoint$VpcId' => 'The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'The tag keys to remove.
', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'VpcOptions$SubnetIds' => 'A list of subnet IDs associated with the VPC endpoint.
', ], ], 'Tag' => [ 'base' => 'A tag (key-value pair) for an OpenSearch Ingestion pipeline.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The tag key. Tag keys must be unique for the pipeline to which they are attached.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$Tags' => 'List of tags to add to the pipeline upon creation.
', 'ListTagsForResourceResponse$Tags' => 'A list of tags associated with the given pipeline.
', 'Pipeline$Tags' => 'A list of tags associated with the given pipeline.
', 'PipelineSummary$Tags' => 'A list of tags associated with the given pipeline.
', 'TagResourceRequest$Tags' => 'The list of key-value tags to add to the pipeline.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value assigned to the corresponding tag key. Tag values can be null and don\'t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
The most recent updated timestamp of the stage.
', 'ChangeProgressStatus$StartTime' => 'The time at which the configuration change is made on the pipeline.
', 'Pipeline$CreatedAt' => 'The date and time when the pipeline was created.
', 'Pipeline$LastUpdatedAt' => 'The date and time when the pipeline was last updated.
', 'PipelineSummary$CreatedAt' => 'The date and time when the pipeline was created.
', 'PipelineSummary$LastUpdatedAt' => 'The date and time when the pipeline was last updated.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'An exception for missing or invalid input fields.
', 'refs' => [], ], 'ValidationMessage' => [ 'base' => 'A validation message associated with a ValidatePipeline request in OpenSearch Ingestion.
A list of errors if the configuration is invalid.
', ], ], 'VpcEndpoint' => [ 'base' => 'An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.
', 'refs' => [ 'VpcEndpointsList$member' => NULL, ], ], 'VpcEndpointServiceName' => [ 'base' => NULL, 'refs' => [ 'ServiceVpcEndpoint$ServiceName' => 'The name of the service for which a VPC endpoint was created.
', ], ], 'VpcEndpointsList' => [ 'base' => NULL, 'refs' => [ 'Pipeline$VpcEndpoints' => 'The VPC interface endpoints that have access to the pipeline.
', ], ], 'VpcOptions' => [ 'base' => 'Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
', 'refs' => [ 'CreatePipelineRequest$VpcOptions' => 'Container for the values required to configure VPC access for the pipeline. If you don\'t specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.
', 'VpcEndpoint$VpcOptions' => 'Information about the VPC, including associated subnets and security groups.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion.
', 'operations' => [ 'CreatePipeline' => 'Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
', 'DeletePipeline' => 'Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
', 'GetPipeline' => 'Retrieves information about an OpenSearch Ingestion pipeline.
', 'GetPipelineBlueprint' => 'Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.
For more information, see Tracking the status of pipeline creation.
', 'ListPipelineBlueprints' => 'Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
', 'ListPipelines' => 'Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
', 'ListTagsForResource' => 'Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
', 'StartPipeline' => 'Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
', 'StopPipeline' => 'Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
', 'TagResource' => 'Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
', 'UntagResource' => 'Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
', 'UpdatePipeline' => 'Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
', 'ValidatePipeline' => 'Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You don\'t have permissions to access the resource.
', 'refs' => [], ], 'BlueprintFormat' => [ 'base' => NULL, 'refs' => [ 'GetPipelineBlueprintRequest$Format' => 'The format format of the blueprint to retrieve.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'BufferOptions$PersistentBufferEnabled' => 'Whether persistent buffering should be enabled.
', 'LogPublishingOptions$IsLoggingEnabled' => 'Whether logs should be published.
', 'ValidatePipelineResponse$isValid' => 'A boolean indicating whether or not the pipeline configuration is valid.
', 'VpcAttachmentOptions$AttachToVpc' => 'Whether a VPC is attached to the pipeline.
', ], ], 'BufferOptions' => [ 'base' => 'Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.
Key-value pairs to configure persistent buffering for the pipeline.
', 'Pipeline$BufferOptions' => NULL, 'UpdatePipelineRequest$BufferOptions' => 'Key-value pairs to configure persistent buffering for the pipeline.
', ], ], 'ChangeProgressStage' => [ 'base' => 'Progress details for a specific stage of a pipeline configuration change.
', 'refs' => [ 'ChangeProgressStageList$member' => NULL, ], ], 'ChangeProgressStageList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatus$ChangeProgressStages' => 'Information about the stages that the pipeline is going through to perform the configuration change.
', ], ], 'ChangeProgressStageStatuses' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => 'The current status of the stage that the change is in.
', ], ], 'ChangeProgressStatus' => [ 'base' => 'The progress details of a pipeline configuration change.
', 'refs' => [ 'ChangeProgressStatusList$member' => NULL, ], ], 'ChangeProgressStatusList' => [ 'base' => NULL, 'refs' => [ 'GetPipelineChangeProgressResponse$ChangeProgressStatuses' => 'The current status of the change happening on the pipeline.
', ], ], 'ChangeProgressStatuses' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatus$Status' => 'The overall status of the pipeline configuration change.
', ], ], 'CidrBlock' => [ 'base' => NULL, 'refs' => [ 'VpcAttachmentOptions$CidrBlock' => 'The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
', ], ], 'CloudWatchLogDestination' => [ 'base' => 'The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.
', 'refs' => [ 'LogPublishingOptions$CloudWatchLogDestination' => 'The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.
The client attempted to remove a resource that is currently in use.
', 'refs' => [], ], 'CreatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisabledOperationException' => [ 'base' => 'Exception is thrown when an operation has been disabled.
', 'refs' => [], ], 'EncryptionAtRestOptions' => [ 'base' => 'Options to control how OpenSearch encrypts buffer data.
', 'refs' => [ 'CreatePipelineRequest$EncryptionAtRestOptions' => 'Key-value pairs to configure encryption for data that is written to a persistent buffer.
', 'Pipeline$EncryptionAtRestOptions' => NULL, 'UpdatePipelineRequest$EncryptionAtRestOptions' => 'Key-value pairs to configure encryption for data that is written to a persistent buffer.
', ], ], 'GetPipelineBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineChangeProgressRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineChangeProgressResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'IngestEndpointUrlsList' => [ 'base' => NULL, 'refs' => [ 'Pipeline$IngestEndpointUrls' => 'The ingestion endpoints for the pipeline, which you can send data to.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatus$TotalNumberOfStages' => 'The total number of stages required for the pipeline configuration change.
', 'Pipeline$MinUnits' => 'The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'Pipeline$MaxUnits' => 'The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
', ], ], 'InternalException' => [ 'base' => 'The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
', 'refs' => [], ], 'InvalidPaginationTokenException' => [ 'base' => 'An invalid pagination token provided in the request.
', 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyArn' => 'The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key.
', ], ], 'LimitExceededException' => [ 'base' => 'You attempted to create more than the allowed number of tags.
', 'refs' => [], ], 'ListPipelineBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogGroup' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLogDestination$LogGroup' => 'The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/vendedlogs/OpenSearchService/pipelines.
Container for the values required to configure logging for the pipeline. If you don\'t specify these values, OpenSearch Ingestion will not publish logs from your application to CloudWatch Logs.
', 'refs' => [ 'CreatePipelineRequest$LogPublishingOptions' => 'Key-value pairs to configure log publishing.
', 'Pipeline$LogPublishingOptions' => 'Key-value pairs that represent log publishing settings.
', 'UpdatePipelineRequest$LogPublishingOptions' => 'Key-value pairs to configure log publishing.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesRequest$MaxResults' => 'An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Information about an existing OpenSearch Ingestion pipeline.
', 'refs' => [ 'CreatePipelineResponse$Pipeline' => 'Container for information about the created pipeline.
', 'GetPipelineResponse$Pipeline' => 'Detailed information about the requested pipeline.
', 'StartPipelineResponse$Pipeline' => NULL, 'StopPipelineResponse$Pipeline' => NULL, 'UpdatePipelineResponse$Pipeline' => 'Container for information about the updated pipeline.
', ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$Arn' => 'The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.
', 'PipelineSummary$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'TagResourceRequest$Arn' => 'The Amazon Resource Name (ARN) of the pipeline to tag.
', 'UntagResourceRequest$Arn' => 'The Amazon Resource Name (ARN) of the pipeline to remove tags from.
', ], ], 'PipelineBlueprint' => [ 'base' => 'Container for information about an OpenSearch Ingestion blueprint.
', 'refs' => [ 'GetPipelineBlueprintResponse$Blueprint' => 'The requested blueprint in YAML format.
', ], ], 'PipelineBlueprintSummary' => [ 'base' => 'A summary of an OpenSearch Ingestion blueprint.
', 'refs' => [ 'PipelineBlueprintsSummaryList$member' => NULL, ], ], 'PipelineBlueprintsSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineBlueprintsResponse$Blueprints' => 'A list of available blueprints for Data Prepper.
', ], ], 'PipelineConfigurationBody' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineConfigurationBody' => 'The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
An object representing the destination of a pipeline.
', 'refs' => [ 'PipelineDestinationList$member' => NULL, ], ], 'PipelineDestinationList' => [ 'base' => NULL, 'refs' => [ 'Pipeline$Destinations' => 'Destinations to which the pipeline writes data.
', 'PipelineSummary$Destinations' => 'A list of destinations to which the pipeline writes data.
', ], ], 'PipelineName' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineName' => 'The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.
', 'DeletePipelineRequest$PipelineName' => 'The name of the pipeline to delete.
', 'GetPipelineChangeProgressRequest$PipelineName' => 'The name of the pipeline.
', 'GetPipelineRequest$PipelineName' => 'The name of the pipeline.
', 'PipelineSummary$PipelineName' => 'The name of the pipeline.
', 'StartPipelineRequest$PipelineName' => 'The name of the pipeline to start.
', 'StopPipelineRequest$PipelineName' => 'The name of the pipeline to stop.
', 'UpdatePipelineRequest$PipelineName' => 'The name of the pipeline to update.
', ], ], 'PipelineStatus' => [ 'base' => NULL, 'refs' => [ 'Pipeline$Status' => 'The current status of the pipeline.
', 'PipelineSummary$Status' => 'The current status of the pipeline.
', ], ], 'PipelineStatusReason' => [ 'base' => 'Information about a pipeline\'s current status.
', 'refs' => [ 'Pipeline$StatusReason' => 'The reason for the current status of the pipeline.
', 'PipelineSummary$StatusReason' => NULL, ], ], 'PipelineSummary' => [ 'base' => 'Summary information for an OpenSearch Ingestion pipeline.
', 'refs' => [ 'PipelineSummaryList$member' => NULL, ], ], 'PipelineSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesResponse$Pipelines' => 'A list of all existing Data Prepper pipelines.
', ], ], 'PipelineUnits' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$MinUnits' => 'The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'CreatePipelineRequest$MaxUnits' => 'The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'PipelineSummary$MinUnits' => 'The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'PipelineSummary$MaxUnits' => 'The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'UpdatePipelineRequest$MinUnits' => 'The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
', 'UpdatePipelineRequest$MaxUnits' => 'The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
', ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'You attempted to create a resource that already exists.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'You attempted to access or delete a resource that does not exist.
', 'refs' => [], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcOptions$SecurityGroupIds' => 'A list of security groups associated with the VPC endpoint.
', ], ], 'ServiceVpcEndpoint' => [ 'base' => 'A container for information about VPC endpoints that were created to other services
', 'refs' => [ 'ServiceVpcEndpointsList$member' => NULL, ], ], 'ServiceVpcEndpointsList' => [ 'base' => NULL, 'refs' => [ 'Pipeline$ServiceVpcEndpoints' => 'A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
', ], ], 'StartPipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Name' => 'The name of the stage.
', 'ChangeProgressStage$Description' => 'A description of the stage.
', 'GetPipelineBlueprintRequest$BlueprintName' => 'The name of the blueprint to retrieve.
', 'GetPipelineBlueprintResponse$Format' => 'The format of the blueprint.
', 'IngestEndpointUrlsList$member' => NULL, 'Pipeline$PipelineName' => 'The name of the pipeline.
', 'Pipeline$PipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'Pipeline$PipelineConfigurationBody' => 'The Data Prepper pipeline configuration in YAML format.
', 'PipelineBlueprint$BlueprintName' => 'The name of the blueprint.
', 'PipelineBlueprint$PipelineConfigurationBody' => 'The YAML configuration of the blueprint.
', 'PipelineBlueprint$DisplayName' => 'The display name of the blueprint.
', 'PipelineBlueprint$DisplayDescription' => 'A description of the blueprint.
', 'PipelineBlueprint$Service' => 'The name of the service that the blueprint is associated with.
', 'PipelineBlueprint$UseCase' => 'The use case that the blueprint relates to.
', 'PipelineBlueprintSummary$BlueprintName' => 'The name of the blueprint.
', 'PipelineBlueprintSummary$DisplayName' => 'The display name of the blueprint.
', 'PipelineBlueprintSummary$DisplayDescription' => 'A description of the blueprint.
', 'PipelineBlueprintSummary$Service' => 'The name of the service that the blueprint is associated with.
', 'PipelineBlueprintSummary$UseCase' => 'The use case that the blueprint relates to.
', 'PipelineDestination$ServiceName' => 'The name of the service receiving data from the pipeline.
', 'PipelineDestination$Endpoint' => 'The endpoint receiving data from the pipeline.
', 'PipelineStatusReason$Description' => 'A description of why a pipeline has a certain status.
', 'ServiceVpcEndpoint$VpcEndpointId' => 'The unique identifier of the VPC endpoint that was created.
', 'StringList$member' => NULL, 'ValidationMessage$Message' => 'The validation message.
', 'VpcEndpoint$VpcEndpointId' => 'The unique identifier of the endpoint.
', 'VpcEndpoint$VpcId' => 'The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'The tag keys to remove.
', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'VpcOptions$SubnetIds' => 'A list of subnet IDs associated with the VPC endpoint.
', ], ], 'Tag' => [ 'base' => 'A tag (key-value pair) for an OpenSearch Ingestion pipeline.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The tag key. Tag keys must be unique for the pipeline to which they are attached.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$Tags' => 'List of tags to add to the pipeline upon creation.
', 'ListTagsForResourceResponse$Tags' => 'A list of tags associated with the given pipeline.
', 'Pipeline$Tags' => 'A list of tags associated with the given pipeline.
', 'PipelineSummary$Tags' => 'A list of tags associated with the given pipeline.
', 'TagResourceRequest$Tags' => 'The list of key-value tags to add to the pipeline.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value assigned to the corresponding tag key. Tag values can be null and don\'t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
The most recent updated timestamp of the stage.
', 'ChangeProgressStatus$StartTime' => 'The time at which the configuration change is made on the pipeline.
', 'Pipeline$CreatedAt' => 'The date and time when the pipeline was created.
', 'Pipeline$LastUpdatedAt' => 'The date and time when the pipeline was last updated.
', 'PipelineSummary$CreatedAt' => 'The date and time when the pipeline was created.
', 'PipelineSummary$LastUpdatedAt' => 'The date and time when the pipeline was last updated.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'An exception for missing or invalid input fields.
', 'refs' => [], ], 'ValidationMessage' => [ 'base' => 'A validation message associated with a ValidatePipeline request in OpenSearch Ingestion.
A list of errors if the configuration is invalid.
', ], ], 'VpcAttachmentOptions' => [ 'base' => 'Options for attaching a VPC to pipeline.
', 'refs' => [ 'VpcOptions$VpcAttachmentOptions' => 'Options for attaching a VPC to a pipeline.
', ], ], 'VpcEndpoint' => [ 'base' => 'An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.
', 'refs' => [ 'VpcEndpointsList$member' => NULL, ], ], 'VpcEndpointServiceName' => [ 'base' => NULL, 'refs' => [ 'ServiceVpcEndpoint$ServiceName' => 'The name of the service for which a VPC endpoint was created.
', ], ], 'VpcEndpointsList' => [ 'base' => NULL, 'refs' => [ 'Pipeline$VpcEndpoints' => 'The VPC interface endpoints that have access to the pipeline.
', ], ], 'VpcOptions' => [ 'base' => 'Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
', 'refs' => [ 'CreatePipelineRequest$VpcOptions' => 'Container for the values required to configure VPC access for the pipeline. If you don\'t specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.
', 'VpcEndpoint$VpcOptions' => 'Information about the VPC, including associated subnets and security groups.
', ], ], ],]; diff --git a/src/data/rds/2014-10-31/api-2.json b/src/data/rds/2014-10-31/api-2.json index 6fb24d4bc7..6751c63eac 100644 --- a/src/data/rds/2014-10-31/api-2.json +++ b/src/data/rds/2014-10-31/api-2.json @@ -3594,7 +3594,8 @@ "ManageMasterUserPassword":{"shape":"BooleanOptional"}, "MasterUserSecretKmsKeyId":{"shape":"String"}, "EnableLocalWriteForwarding":{"shape":"BooleanOptional"}, - "CACertificateIdentifier":{"shape":"String"} + "CACertificateIdentifier":{"shape":"String"}, + "EngineLifecycleSupport":{"shape":"String"} } }, "CreateDBClusterParameterGroupMessage":{ @@ -3710,7 +3711,8 @@ "CACertificateIdentifier":{"shape":"String"}, "DBSystemId":{"shape":"String"}, "DedicatedLogVolume":{"shape":"BooleanOptional"}, - "MultiTenant":{"shape":"BooleanOptional"} + "MultiTenant":{"shape":"BooleanOptional"}, + "EngineLifecycleSupport":{"shape":"String"} } }, "CreateDBInstanceReadReplicaMessage":{ @@ -3947,6 +3949,7 @@ "SourceDBClusterIdentifier":{"shape":"String"}, "Engine":{"shape":"String"}, "EngineVersion":{"shape":"String"}, + "EngineLifecycleSupport":{"shape":"String"}, "DeletionProtection":{"shape":"BooleanOptional"}, "DatabaseName":{"shape":"String"}, "StorageEncrypted":{"shape":"BooleanOptional"} @@ -4180,7 +4183,8 @@ "AwsBackupRecoveryPointArn":{"shape":"String"}, "LimitlessDatabase":{"shape":"LimitlessDatabase"}, "StorageThroughput":{"shape":"IntegerOptional"}, - "CertificateDetails":{"shape":"CertificateDetails"} + "CertificateDetails":{"shape":"CertificateDetails"}, + "EngineLifecycleSupport":{"shape":"String"} }, "wrapper":true }, @@ -4785,7 +4789,8 @@ "PercentProgress":{"shape":"String"}, "DedicatedLogVolume":{"shape":"Boolean"}, "IsStorageConfigUpgradeAvailable":{"shape":"BooleanOptional"}, - "MultiTenant":{"shape":"BooleanOptional"} + "MultiTenant":{"shape":"BooleanOptional"}, + "EngineLifecycleSupport":{"shape":"String"} }, "wrapper":true }, @@ -6964,6 +6969,7 @@ "Status":{"shape":"String"}, "Engine":{"shape":"String"}, "EngineVersion":{"shape":"String"}, + "EngineLifecycleSupport":{"shape":"String"}, "DatabaseName":{"shape":"String"}, "StorageEncrypted":{"shape":"BooleanOptional"}, "DeletionProtection":{"shape":"BooleanOptional"}, @@ -9121,7 +9127,8 @@ "NetworkType":{"shape":"String"}, "ManageMasterUserPassword":{"shape":"BooleanOptional"}, "MasterUserSecretKmsKeyId":{"shape":"String"}, - "StorageType":{"shape":"String"} + "StorageType":{"shape":"String"}, + "EngineLifecycleSupport":{"shape":"String"} } }, "RestoreDBClusterFromS3Result":{ @@ -9166,7 +9173,8 @@ "PubliclyAccessible":{"shape":"BooleanOptional"}, "ServerlessV2ScalingConfiguration":{"shape":"ServerlessV2ScalingConfiguration"}, "NetworkType":{"shape":"String"}, - "RdsCustomClusterConfiguration":{"shape":"RdsCustomClusterConfiguration"} + "RdsCustomClusterConfiguration":{"shape":"RdsCustomClusterConfiguration"}, + "EngineLifecycleSupport":{"shape":"String"} } }, "RestoreDBClusterFromSnapshotResult":{ @@ -9207,7 +9215,8 @@ "ServerlessV2ScalingConfiguration":{"shape":"ServerlessV2ScalingConfiguration"}, "NetworkType":{"shape":"String"}, "SourceDbClusterResourceId":{"shape":"String"}, - "RdsCustomClusterConfiguration":{"shape":"RdsCustomClusterConfiguration"} + "RdsCustomClusterConfiguration":{"shape":"RdsCustomClusterConfiguration"}, + "EngineLifecycleSupport":{"shape":"String"} } }, "RestoreDBClusterToPointInTimeResult":{ @@ -9260,7 +9269,8 @@ "DBClusterSnapshotIdentifier":{"shape":"String"}, "AllocatedStorage":{"shape":"IntegerOptional"}, "DedicatedLogVolume":{"shape":"BooleanOptional"}, - "CACertificateIdentifier":{"shape":"String"} + "CACertificateIdentifier":{"shape":"String"}, + "EngineLifecycleSupport":{"shape":"String"} } }, "RestoreDBInstanceFromDBSnapshotResult":{ @@ -9330,7 +9340,8 @@ "ManageMasterUserPassword":{"shape":"BooleanOptional"}, "MasterUserSecretKmsKeyId":{"shape":"String"}, "DedicatedLogVolume":{"shape":"BooleanOptional"}, - "CACertificateIdentifier":{"shape":"String"} + "CACertificateIdentifier":{"shape":"String"}, + "EngineLifecycleSupport":{"shape":"String"} } }, "RestoreDBInstanceFromS3Result":{ @@ -9387,7 +9398,8 @@ "StorageThroughput":{"shape":"IntegerOptional"}, "AllocatedStorage":{"shape":"IntegerOptional"}, "DedicatedLogVolume":{"shape":"BooleanOptional"}, - "CACertificateIdentifier":{"shape":"String"} + "CACertificateIdentifier":{"shape":"String"}, + "EngineLifecycleSupport":{"shape":"String"} } }, "RestoreDBInstanceToPointInTimeResult":{ diff --git a/src/data/rds/2014-10-31/api-2.json.php b/src/data/rds/2014-10-31/api-2.json.php index b4244b6f5d..580eb23eab 100644 --- a/src/data/rds/2014-10-31/api-2.json.php +++ b/src/data/rds/2014-10-31/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2014-10-31', 'endpointPrefix' => 'rds', 'protocol' => 'query', 'protocols' => [ 'query', ], 'serviceAbbreviation' => 'Amazon RDS', 'serviceFullName' => 'Amazon Relational Database Service', 'serviceId' => 'RDS', 'signatureVersion' => 'v4', 'uid' => 'rds-2014-10-31', 'xmlNamespace' => 'http://rds.amazonaws.com/doc/2014-10-31/', ], 'operations' => [ 'AddRoleToDBCluster' => [ 'name' => 'AddRoleToDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddRoleToDBClusterMessage', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterRoleAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterRoleQuotaExceededFault', ], ], ], 'AddRoleToDBInstance' => [ 'name' => 'AddRoleToDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddRoleToDBInstanceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBInstanceRoleAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceRoleQuotaExceededFault', ], ], ], 'AddSourceIdentifierToSubscription' => [ 'name' => 'AddSourceIdentifierToSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddSourceIdentifierToSubscriptionMessage', ], 'output' => [ 'shape' => 'AddSourceIdentifierToSubscriptionResult', 'resultWrapper' => 'AddSourceIdentifierToSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'AddTagsToResource' => [ 'name' => 'AddTagsToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsToResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'DBSnapshotTenantDatabaseNotFoundFault', ], ], ], 'ApplyPendingMaintenanceAction' => [ 'name' => 'ApplyPendingMaintenanceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ApplyPendingMaintenanceActionMessage', ], 'output' => [ 'shape' => 'ApplyPendingMaintenanceActionResult', 'resultWrapper' => 'ApplyPendingMaintenanceActionResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'AuthorizeDBSecurityGroupIngress' => [ 'name' => 'AuthorizeDBSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AuthorizeDBSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'AuthorizeDBSecurityGroupIngressResult', 'resultWrapper' => 'AuthorizeDBSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'AuthorizationAlreadyExistsFault', ], [ 'shape' => 'AuthorizationQuotaExceededFault', ], ], ], 'BacktrackDBCluster' => [ 'name' => 'BacktrackDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BacktrackDBClusterMessage', ], 'output' => [ 'shape' => 'DBClusterBacktrack', 'resultWrapper' => 'BacktrackDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'CancelExportTask' => [ 'name' => 'CancelExportTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CancelExportTaskMessage', ], 'output' => [ 'shape' => 'ExportTask', 'resultWrapper' => 'CancelExportTaskResult', ], 'errors' => [ [ 'shape' => 'ExportTaskNotFoundFault', ], [ 'shape' => 'InvalidExportTaskStateFault', ], ], ], 'CopyDBClusterParameterGroup' => [ 'name' => 'CopyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBClusterParameterGroupResult', 'resultWrapper' => 'CopyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CopyDBClusterSnapshot' => [ 'name' => 'CopyDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBClusterSnapshotResult', 'resultWrapper' => 'CopyDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CopyDBParameterGroup' => [ 'name' => 'CopyDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBParameterGroupResult', 'resultWrapper' => 'CopyDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], ], ], 'CopyDBSnapshot' => [ 'name' => 'CopyDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBSnapshotResult', 'resultWrapper' => 'CopyDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'CustomAvailabilityZoneNotFoundFault', ], ], ], 'CopyOptionGroup' => [ 'name' => 'CopyOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyOptionGroupMessage', ], 'output' => [ 'shape' => 'CopyOptionGroupResult', 'resultWrapper' => 'CopyOptionGroupResult', ], 'errors' => [ [ 'shape' => 'OptionGroupAlreadyExistsFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'OptionGroupQuotaExceededFault', ], ], ], 'CreateBlueGreenDeployment' => [ 'name' => 'CreateBlueGreenDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBlueGreenDeploymentRequest', ], 'output' => [ 'shape' => 'CreateBlueGreenDeploymentResponse', 'resultWrapper' => 'CreateBlueGreenDeploymentResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'SourceDatabaseNotSupportedFault', ], [ 'shape' => 'SourceClusterNotSupportedFault', ], [ 'shape' => 'BlueGreenDeploymentAlreadyExistsFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'CreateCustomDBEngineVersion' => [ 'name' => 'CreateCustomDBEngineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCustomDBEngineVersionMessage', ], 'output' => [ 'shape' => 'DBEngineVersion', 'resultWrapper' => 'CreateCustomDBEngineVersionResult', ], 'errors' => [ [ 'shape' => 'CustomDBEngineVersionAlreadyExistsFault', ], [ 'shape' => 'CustomDBEngineVersionQuotaExceededFault', ], [ 'shape' => 'Ec2ImagePropertiesNotSupportedFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'CreateCustomDBEngineVersionFault', ], ], ], 'CreateDBCluster' => [ 'name' => 'CreateDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterMessage', ], 'output' => [ 'shape' => 'CreateDBClusterResult', 'resultWrapper' => 'CreateDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'CreateDBClusterEndpoint' => [ 'name' => 'CreateDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'CreateDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'DBClusterEndpointQuotaExceededFault', ], [ 'shape' => 'DBClusterEndpointAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'CreateDBClusterParameterGroup' => [ 'name' => 'CreateDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBClusterParameterGroupResult', 'resultWrapper' => 'CreateDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBClusterSnapshot' => [ 'name' => 'CreateDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBClusterSnapshotResult', 'resultWrapper' => 'CreateDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'CreateDBInstance' => [ 'name' => 'CreateDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceResult', 'resultWrapper' => 'CreateDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'CertificateNotFoundFault', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], ], ], 'CreateDBInstanceReadReplica' => [ 'name' => 'CreateDBInstanceReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceReadReplicaMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceReadReplicaResult', 'resultWrapper' => 'CreateDBInstanceReadReplicaResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotAllowedFault', ], [ 'shape' => 'InvalidDBSubnetGroupFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'CreateDBParameterGroup' => [ 'name' => 'CreateDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBParameterGroupResult', 'resultWrapper' => 'CreateDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBProxy' => [ 'name' => 'CreateDBProxy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBProxyRequest', ], 'output' => [ 'shape' => 'CreateDBProxyResponse', 'resultWrapper' => 'CreateDBProxyResult', ], 'errors' => [ [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBProxyAlreadyExistsFault', ], [ 'shape' => 'DBProxyQuotaExceededFault', ], ], ], 'CreateDBProxyEndpoint' => [ 'name' => 'CreateDBProxyEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBProxyEndpointRequest', ], 'output' => [ 'shape' => 'CreateDBProxyEndpointResponse', 'resultWrapper' => 'CreateDBProxyEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyEndpointAlreadyExistsFault', ], [ 'shape' => 'DBProxyEndpointQuotaExceededFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'CreateDBSecurityGroup' => [ 'name' => 'CreateDBSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSecurityGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSecurityGroupResult', 'resultWrapper' => 'CreateDBSecurityGroupResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupAlreadyExistsFault', ], [ 'shape' => 'DBSecurityGroupQuotaExceededFault', ], [ 'shape' => 'DBSecurityGroupNotSupportedFault', ], ], ], 'CreateDBShardGroup' => [ 'name' => 'CreateDBShardGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBShardGroupMessage', ], 'output' => [ 'shape' => 'DBShardGroup', 'resultWrapper' => 'CreateDBShardGroupResult', ], 'errors' => [ [ 'shape' => 'DBShardGroupAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'MaxDBShardGroupLimitReached', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidMaxAcuFault', ], [ 'shape' => 'UnsupportedDBEngineVersionFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], ], ], 'CreateDBSnapshot' => [ 'name' => 'CreateDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBSnapshotResult', 'resultWrapper' => 'CreateDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], ], ], 'CreateDBSubnetGroup' => [ 'name' => 'CreateDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSubnetGroupResult', 'resultWrapper' => 'CreateDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupAlreadyExistsFault', ], [ 'shape' => 'DBSubnetGroupQuotaExceededFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'CreateEventSubscription' => [ 'name' => 'CreateEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventSubscriptionMessage', ], 'output' => [ 'shape' => 'CreateEventSubscriptionResult', 'resultWrapper' => 'CreateEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionAlreadyExistFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'CreateGlobalCluster' => [ 'name' => 'CreateGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGlobalClusterMessage', ], 'output' => [ 'shape' => 'CreateGlobalClusterResult', 'resultWrapper' => 'CreateGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterAlreadyExistsFault', ], [ 'shape' => 'GlobalClusterQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'CreateIntegration' => [ 'name' => 'CreateIntegration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateIntegrationMessage', ], 'output' => [ 'shape' => 'Integration', 'resultWrapper' => 'CreateIntegrationResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'IntegrationAlreadyExistsFault', ], [ 'shape' => 'IntegrationQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'IntegrationConflictOperationFault', ], ], ], 'CreateOptionGroup' => [ 'name' => 'CreateOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOptionGroupMessage', ], 'output' => [ 'shape' => 'CreateOptionGroupResult', 'resultWrapper' => 'CreateOptionGroupResult', ], 'errors' => [ [ 'shape' => 'OptionGroupAlreadyExistsFault', ], [ 'shape' => 'OptionGroupQuotaExceededFault', ], ], ], 'CreateTenantDatabase' => [ 'name' => 'CreateTenantDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTenantDatabaseMessage', ], 'output' => [ 'shape' => 'CreateTenantDatabaseResult', 'resultWrapper' => 'CreateTenantDatabaseResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'TenantDatabaseAlreadyExistsFault', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], ], ], 'DeleteBlueGreenDeployment' => [ 'name' => 'DeleteBlueGreenDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBlueGreenDeploymentRequest', ], 'output' => [ 'shape' => 'DeleteBlueGreenDeploymentResponse', 'resultWrapper' => 'DeleteBlueGreenDeploymentResult', ], 'errors' => [ [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'InvalidBlueGreenDeploymentStateFault', ], ], ], 'DeleteCustomDBEngineVersion' => [ 'name' => 'DeleteCustomDBEngineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCustomDBEngineVersionMessage', ], 'output' => [ 'shape' => 'DBEngineVersion', 'resultWrapper' => 'DeleteCustomDBEngineVersionResult', ], 'errors' => [ [ 'shape' => 'CustomDBEngineVersionNotFoundFault', ], [ 'shape' => 'InvalidCustomDBEngineVersionStateFault', ], ], ], 'DeleteDBCluster' => [ 'name' => 'DeleteDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterResult', 'resultWrapper' => 'DeleteDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'DBClusterAutomatedBackupQuotaExceededFault', ], ], ], 'DeleteDBClusterAutomatedBackup' => [ 'name' => 'DeleteDBClusterAutomatedBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterAutomatedBackupMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterAutomatedBackupResult', 'resultWrapper' => 'DeleteDBClusterAutomatedBackupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterAutomatedBackupStateFault', ], [ 'shape' => 'DBClusterAutomatedBackupNotFoundFault', ], ], ], 'DeleteDBClusterEndpoint' => [ 'name' => 'DeleteDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'DeleteDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterEndpointStateFault', ], [ 'shape' => 'DBClusterEndpointNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'DeleteDBClusterParameterGroup' => [ 'name' => 'DeleteDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBClusterSnapshot' => [ 'name' => 'DeleteDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterSnapshotResult', 'resultWrapper' => 'DeleteDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DeleteDBInstance' => [ 'name' => 'DeleteDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceResult', 'resultWrapper' => 'DeleteDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBInstanceAutomatedBackupQuotaExceededFault', ], ], ], 'DeleteDBInstanceAutomatedBackup' => [ 'name' => 'DeleteDBInstanceAutomatedBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceAutomatedBackupMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceAutomatedBackupResult', 'resultWrapper' => 'DeleteDBInstanceAutomatedBackupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceAutomatedBackupStateFault', ], [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'DeleteDBParameterGroup' => [ 'name' => 'DeleteDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBProxy' => [ 'name' => 'DeleteDBProxy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBProxyRequest', ], 'output' => [ 'shape' => 'DeleteDBProxyResponse', 'resultWrapper' => 'DeleteDBProxyResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'DeleteDBProxyEndpoint' => [ 'name' => 'DeleteDBProxyEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBProxyEndpointRequest', ], 'output' => [ 'shape' => 'DeleteDBProxyEndpointResponse', 'resultWrapper' => 'DeleteDBProxyEndpointResult', ], 'errors' => [ [ 'shape' => 'DBProxyEndpointNotFoundFault', ], [ 'shape' => 'InvalidDBProxyEndpointStateFault', ], ], ], 'DeleteDBSecurityGroup' => [ 'name' => 'DeleteDBSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSecurityGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], ], ], 'DeleteDBShardGroup' => [ 'name' => 'DeleteDBShardGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBShardGroupMessage', ], 'output' => [ 'shape' => 'DBShardGroup', 'resultWrapper' => 'DeleteDBShardGroupResult', ], 'errors' => [ [ 'shape' => 'DBShardGroupNotFoundFault', ], [ 'shape' => 'InvalidDBShardGroupStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'DeleteDBSnapshot' => [ 'name' => 'DeleteDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBSnapshotResult', 'resultWrapper' => 'DeleteDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DeleteDBSubnetGroup' => [ 'name' => 'DeleteDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSubnetGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidDBSubnetStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DeleteEventSubscription' => [ 'name' => 'DeleteEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventSubscriptionMessage', ], 'output' => [ 'shape' => 'DeleteEventSubscriptionResult', 'resultWrapper' => 'DeleteEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'InvalidEventSubscriptionStateFault', ], ], ], 'DeleteGlobalCluster' => [ 'name' => 'DeleteGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGlobalClusterMessage', ], 'output' => [ 'shape' => 'DeleteGlobalClusterResult', 'resultWrapper' => 'DeleteGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'DeleteIntegration' => [ 'name' => 'DeleteIntegration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteIntegrationMessage', ], 'output' => [ 'shape' => 'Integration', 'resultWrapper' => 'DeleteIntegrationResult', ], 'errors' => [ [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'IntegrationConflictOperationFault', ], [ 'shape' => 'InvalidIntegrationStateFault', ], ], ], 'DeleteOptionGroup' => [ 'name' => 'DeleteOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOptionGroupMessage', ], 'errors' => [ [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'InvalidOptionGroupStateFault', ], ], ], 'DeleteTenantDatabase' => [ 'name' => 'DeleteTenantDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTenantDatabaseMessage', ], 'output' => [ 'shape' => 'DeleteTenantDatabaseResult', 'resultWrapper' => 'DeleteTenantDatabaseResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'DeregisterDBProxyTargets' => [ 'name' => 'DeregisterDBProxyTargets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterDBProxyTargetsRequest', ], 'output' => [ 'shape' => 'DeregisterDBProxyTargetsResponse', 'resultWrapper' => 'DeregisterDBProxyTargetsResult', ], 'errors' => [ [ 'shape' => 'DBProxyTargetNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'DescribeAccountAttributes' => [ 'name' => 'DescribeAccountAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAccountAttributesMessage', ], 'output' => [ 'shape' => 'AccountAttributesMessage', 'resultWrapper' => 'DescribeAccountAttributesResult', ], ], 'DescribeBlueGreenDeployments' => [ 'name' => 'DescribeBlueGreenDeployments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBlueGreenDeploymentsRequest', ], 'output' => [ 'shape' => 'DescribeBlueGreenDeploymentsResponse', 'resultWrapper' => 'DescribeBlueGreenDeploymentsResult', ], 'errors' => [ [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], ], ], 'DescribeCertificates' => [ 'name' => 'DescribeCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificatesMessage', ], 'output' => [ 'shape' => 'CertificateMessage', 'resultWrapper' => 'DescribeCertificatesResult', ], 'errors' => [ [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'DescribeDBClusterAutomatedBackups' => [ 'name' => 'DescribeDBClusterAutomatedBackups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterAutomatedBackupsMessage', ], 'output' => [ 'shape' => 'DBClusterAutomatedBackupMessage', 'resultWrapper' => 'DescribeDBClusterAutomatedBackupsResult', ], 'errors' => [ [ 'shape' => 'DBClusterAutomatedBackupNotFoundFault', ], ], ], 'DescribeDBClusterBacktracks' => [ 'name' => 'DescribeDBClusterBacktracks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterBacktracksMessage', ], 'output' => [ 'shape' => 'DBClusterBacktrackMessage', 'resultWrapper' => 'DescribeDBClusterBacktracksResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterBacktrackNotFoundFault', ], ], ], 'DescribeDBClusterEndpoints' => [ 'name' => 'DescribeDBClusterEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterEndpointsMessage', ], 'output' => [ 'shape' => 'DBClusterEndpointMessage', 'resultWrapper' => 'DescribeDBClusterEndpointsResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBClusterParameterGroups' => [ 'name' => 'DescribeDBClusterParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupsMessage', 'resultWrapper' => 'DescribeDBClusterParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterParameters' => [ 'name' => 'DescribeDBClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParametersMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupDetails', 'resultWrapper' => 'DescribeDBClusterParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterSnapshotAttributes' => [ 'name' => 'DescribeDBClusterSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBClusterSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusterSnapshots' => [ 'name' => 'DescribeDBClusterSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotsMessage', ], 'output' => [ 'shape' => 'DBClusterSnapshotMessage', 'resultWrapper' => 'DescribeDBClusterSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusters' => [ 'name' => 'DescribeDBClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClustersMessage', ], 'output' => [ 'shape' => 'DBClusterMessage', 'resultWrapper' => 'DescribeDBClustersResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBEngineVersions' => [ 'name' => 'DescribeDBEngineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBEngineVersionsMessage', ], 'output' => [ 'shape' => 'DBEngineVersionMessage', 'resultWrapper' => 'DescribeDBEngineVersionsResult', ], ], 'DescribeDBInstanceAutomatedBackups' => [ 'name' => 'DescribeDBInstanceAutomatedBackups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstanceAutomatedBackupsMessage', ], 'output' => [ 'shape' => 'DBInstanceAutomatedBackupMessage', 'resultWrapper' => 'DescribeDBInstanceAutomatedBackupsResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'DescribeDBInstances' => [ 'name' => 'DescribeDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstancesMessage', ], 'output' => [ 'shape' => 'DBInstanceMessage', 'resultWrapper' => 'DescribeDBInstancesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBLogFiles' => [ 'name' => 'DescribeDBLogFiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBLogFilesMessage', ], 'output' => [ 'shape' => 'DescribeDBLogFilesResponse', 'resultWrapper' => 'DescribeDBLogFilesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBParameterGroups' => [ 'name' => 'DescribeDBParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBParameterGroupsMessage', 'resultWrapper' => 'DescribeDBParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBParameters' => [ 'name' => 'DescribeDBParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBParametersMessage', ], 'output' => [ 'shape' => 'DBParameterGroupDetails', 'resultWrapper' => 'DescribeDBParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBProxies' => [ 'name' => 'DescribeDBProxies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBProxiesRequest', ], 'output' => [ 'shape' => 'DescribeDBProxiesResponse', 'resultWrapper' => 'DescribeDBProxiesResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], ], ], 'DescribeDBProxyEndpoints' => [ 'name' => 'DescribeDBProxyEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBProxyEndpointsRequest', ], 'output' => [ 'shape' => 'DescribeDBProxyEndpointsResponse', 'resultWrapper' => 'DescribeDBProxyEndpointsResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyEndpointNotFoundFault', ], ], ], 'DescribeDBProxyTargetGroups' => [ 'name' => 'DescribeDBProxyTargetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBProxyTargetGroupsRequest', ], 'output' => [ 'shape' => 'DescribeDBProxyTargetGroupsResponse', 'resultWrapper' => 'DescribeDBProxyTargetGroupsResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'DescribeDBProxyTargets' => [ 'name' => 'DescribeDBProxyTargets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBProxyTargetsRequest', ], 'output' => [ 'shape' => 'DescribeDBProxyTargetsResponse', 'resultWrapper' => 'DescribeDBProxyTargetsResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'DescribeDBRecommendations' => [ 'name' => 'DescribeDBRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBRecommendationsMessage', ], 'output' => [ 'shape' => 'DBRecommendationsMessage', 'resultWrapper' => 'DescribeDBRecommendationsResult', ], ], 'DescribeDBSecurityGroups' => [ 'name' => 'DescribeDBSecurityGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSecurityGroupsMessage', ], 'output' => [ 'shape' => 'DBSecurityGroupMessage', 'resultWrapper' => 'DescribeDBSecurityGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], ], ], 'DescribeDBShardGroups' => [ 'name' => 'DescribeDBShardGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBShardGroupsMessage', ], 'output' => [ 'shape' => 'DescribeDBShardGroupsResponse', 'resultWrapper' => 'DescribeDBShardGroupsResult', ], 'errors' => [ [ 'shape' => 'DBShardGroupNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBSnapshotAttributes' => [ 'name' => 'DescribeDBSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSnapshotTenantDatabases' => [ 'name' => 'DescribeDBSnapshotTenantDatabases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotTenantDatabasesMessage', ], 'output' => [ 'shape' => 'DBSnapshotTenantDatabasesMessage', 'resultWrapper' => 'DescribeDBSnapshotTenantDatabasesResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSnapshots' => [ 'name' => 'DescribeDBSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotsMessage', ], 'output' => [ 'shape' => 'DBSnapshotMessage', 'resultWrapper' => 'DescribeDBSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSubnetGroups' => [ 'name' => 'DescribeDBSubnetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSubnetGroupsMessage', ], 'output' => [ 'shape' => 'DBSubnetGroupMessage', 'resultWrapper' => 'DescribeDBSubnetGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DescribeEngineDefaultClusterParameters' => [ 'name' => 'DescribeEngineDefaultClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultClusterParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultClusterParametersResult', 'resultWrapper' => 'DescribeEngineDefaultClusterParametersResult', ], ], 'DescribeEngineDefaultParameters' => [ 'name' => 'DescribeEngineDefaultParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultParametersResult', 'resultWrapper' => 'DescribeEngineDefaultParametersResult', ], ], 'DescribeEventCategories' => [ 'name' => 'DescribeEventCategories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventCategoriesMessage', ], 'output' => [ 'shape' => 'EventCategoriesMessage', 'resultWrapper' => 'DescribeEventCategoriesResult', ], ], 'DescribeEventSubscriptions' => [ 'name' => 'DescribeEventSubscriptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventSubscriptionsMessage', ], 'output' => [ 'shape' => 'EventSubscriptionsMessage', 'resultWrapper' => 'DescribeEventSubscriptionsResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], ], ], 'DescribeEvents' => [ 'name' => 'DescribeEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventsMessage', ], 'output' => [ 'shape' => 'EventsMessage', 'resultWrapper' => 'DescribeEventsResult', ], ], 'DescribeExportTasks' => [ 'name' => 'DescribeExportTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExportTasksMessage', ], 'output' => [ 'shape' => 'ExportTasksMessage', 'resultWrapper' => 'DescribeExportTasksResult', ], 'errors' => [ [ 'shape' => 'ExportTaskNotFoundFault', ], ], ], 'DescribeGlobalClusters' => [ 'name' => 'DescribeGlobalClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGlobalClustersMessage', ], 'output' => [ 'shape' => 'GlobalClustersMessage', 'resultWrapper' => 'DescribeGlobalClustersResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], ], ], 'DescribeIntegrations' => [ 'name' => 'DescribeIntegrations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeIntegrationsMessage', ], 'output' => [ 'shape' => 'DescribeIntegrationsResponse', 'resultWrapper' => 'DescribeIntegrationsResult', ], 'errors' => [ [ 'shape' => 'IntegrationNotFoundFault', ], ], ], 'DescribeOptionGroupOptions' => [ 'name' => 'DescribeOptionGroupOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptionGroupOptionsMessage', ], 'output' => [ 'shape' => 'OptionGroupOptionsMessage', 'resultWrapper' => 'DescribeOptionGroupOptionsResult', ], ], 'DescribeOptionGroups' => [ 'name' => 'DescribeOptionGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptionGroupsMessage', ], 'output' => [ 'shape' => 'OptionGroups', 'resultWrapper' => 'DescribeOptionGroupsResult', ], 'errors' => [ [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'DescribeOrderableDBInstanceOptions' => [ 'name' => 'DescribeOrderableDBInstanceOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrderableDBInstanceOptionsMessage', ], 'output' => [ 'shape' => 'OrderableDBInstanceOptionsMessage', 'resultWrapper' => 'DescribeOrderableDBInstanceOptionsResult', ], ], 'DescribePendingMaintenanceActions' => [ 'name' => 'DescribePendingMaintenanceActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePendingMaintenanceActionsMessage', ], 'output' => [ 'shape' => 'PendingMaintenanceActionsMessage', 'resultWrapper' => 'DescribePendingMaintenanceActionsResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], ], ], 'DescribeReservedDBInstances' => [ 'name' => 'DescribeReservedDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedDBInstancesMessage', ], 'output' => [ 'shape' => 'ReservedDBInstanceMessage', 'resultWrapper' => 'DescribeReservedDBInstancesResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstanceNotFoundFault', ], ], ], 'DescribeReservedDBInstancesOfferings' => [ 'name' => 'DescribeReservedDBInstancesOfferings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedDBInstancesOfferingsMessage', ], 'output' => [ 'shape' => 'ReservedDBInstancesOfferingMessage', 'resultWrapper' => 'DescribeReservedDBInstancesOfferingsResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstancesOfferingNotFoundFault', ], ], ], 'DescribeSourceRegions' => [ 'name' => 'DescribeSourceRegions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSourceRegionsMessage', ], 'output' => [ 'shape' => 'SourceRegionMessage', 'resultWrapper' => 'DescribeSourceRegionsResult', ], ], 'DescribeTenantDatabases' => [ 'name' => 'DescribeTenantDatabases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTenantDatabasesMessage', ], 'output' => [ 'shape' => 'TenantDatabasesMessage', 'resultWrapper' => 'DescribeTenantDatabasesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeValidDBInstanceModifications' => [ 'name' => 'DescribeValidDBInstanceModifications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeValidDBInstanceModificationsMessage', ], 'output' => [ 'shape' => 'DescribeValidDBInstanceModificationsResult', 'resultWrapper' => 'DescribeValidDBInstanceModificationsResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'DisableHttpEndpoint' => [ 'name' => 'DisableHttpEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableHttpEndpointRequest', ], 'output' => [ 'shape' => 'DisableHttpEndpointResponse', 'resultWrapper' => 'DisableHttpEndpointResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidResourceStateFault', ], ], ], 'DownloadDBLogFilePortion' => [ 'name' => 'DownloadDBLogFilePortion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DownloadDBLogFilePortionMessage', ], 'output' => [ 'shape' => 'DownloadDBLogFilePortionDetails', 'resultWrapper' => 'DownloadDBLogFilePortionResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBLogFileNotFoundFault', ], ], ], 'EnableHttpEndpoint' => [ 'name' => 'EnableHttpEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableHttpEndpointRequest', ], 'output' => [ 'shape' => 'EnableHttpEndpointResponse', 'resultWrapper' => 'EnableHttpEndpointResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidResourceStateFault', ], ], ], 'FailoverDBCluster' => [ 'name' => 'FailoverDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverDBClusterMessage', ], 'output' => [ 'shape' => 'FailoverDBClusterResult', 'resultWrapper' => 'FailoverDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'FailoverGlobalCluster' => [ 'name' => 'FailoverGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverGlobalClusterMessage', ], 'output' => [ 'shape' => 'FailoverGlobalClusterResult', 'resultWrapper' => 'FailoverGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'DBSnapshotTenantDatabaseNotFoundFault', ], ], ], 'ModifyActivityStream' => [ 'name' => 'ModifyActivityStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyActivityStreamRequest', ], 'output' => [ 'shape' => 'ModifyActivityStreamResponse', 'resultWrapper' => 'ModifyActivityStreamResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'ModifyCertificates' => [ 'name' => 'ModifyCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCertificatesMessage', ], 'output' => [ 'shape' => 'ModifyCertificatesResult', 'resultWrapper' => 'ModifyCertificatesResult', ], 'errors' => [ [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'ModifyCurrentDBClusterCapacity' => [ 'name' => 'ModifyCurrentDBClusterCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCurrentDBClusterCapacityMessage', ], 'output' => [ 'shape' => 'DBClusterCapacityInfo', 'resultWrapper' => 'ModifyCurrentDBClusterCapacityResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterCapacityFault', ], ], ], 'ModifyCustomDBEngineVersion' => [ 'name' => 'ModifyCustomDBEngineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCustomDBEngineVersionMessage', ], 'output' => [ 'shape' => 'DBEngineVersion', 'resultWrapper' => 'ModifyCustomDBEngineVersionResult', ], 'errors' => [ [ 'shape' => 'CustomDBEngineVersionNotFoundFault', ], [ 'shape' => 'InvalidCustomDBEngineVersionStateFault', ], ], ], 'ModifyDBCluster' => [ 'name' => 'ModifyDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterResult', 'resultWrapper' => 'ModifyDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'StorageTypeNotAvailableFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'ModifyDBClusterEndpoint' => [ 'name' => 'ModifyDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'ModifyDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterEndpointStateFault', ], [ 'shape' => 'DBClusterEndpointNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ModifyDBClusterParameterGroup' => [ 'name' => 'ModifyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBClusterSnapshotAttribute' => [ 'name' => 'ModifyDBClusterSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBClusterSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBInstance' => [ 'name' => 'ModifyDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBInstanceMessage', ], 'output' => [ 'shape' => 'ModifyDBInstanceResult', 'resultWrapper' => 'ModifyDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBUpgradeDependencyFailureFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'CertificateNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], ], ], 'ModifyDBParameterGroup' => [ 'name' => 'ModifyDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBParameterGroupMessage', ], 'output' => [ 'shape' => 'DBParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBProxy' => [ 'name' => 'ModifyDBProxy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBProxyRequest', ], 'output' => [ 'shape' => 'ModifyDBProxyResponse', 'resultWrapper' => 'ModifyDBProxyResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyAlreadyExistsFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'ModifyDBProxyEndpoint' => [ 'name' => 'ModifyDBProxyEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBProxyEndpointRequest', ], 'output' => [ 'shape' => 'ModifyDBProxyEndpointResponse', 'resultWrapper' => 'ModifyDBProxyEndpointResult', ], 'errors' => [ [ 'shape' => 'DBProxyEndpointNotFoundFault', ], [ 'shape' => 'DBProxyEndpointAlreadyExistsFault', ], [ 'shape' => 'InvalidDBProxyEndpointStateFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'ModifyDBProxyTargetGroup' => [ 'name' => 'ModifyDBProxyTargetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBProxyTargetGroupRequest', ], 'output' => [ 'shape' => 'ModifyDBProxyTargetGroupResponse', 'resultWrapper' => 'ModifyDBProxyTargetGroupResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'ModifyDBRecommendation' => [ 'name' => 'ModifyDBRecommendation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBRecommendationMessage', ], 'output' => [ 'shape' => 'DBRecommendationMessage', 'resultWrapper' => 'ModifyDBRecommendationResult', ], 'errors' => [], ], 'ModifyDBShardGroup' => [ 'name' => 'ModifyDBShardGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBShardGroupMessage', ], 'output' => [ 'shape' => 'DBShardGroup', 'resultWrapper' => 'ModifyDBShardGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBShardGroupAlreadyExistsFault', ], [ 'shape' => 'DBShardGroupNotFoundFault', ], [ 'shape' => 'InvalidMaxAcuFault', ], ], ], 'ModifyDBSnapshot' => [ 'name' => 'ModifyDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSnapshotMessage', ], 'output' => [ 'shape' => 'ModifyDBSnapshotResult', 'resultWrapper' => 'ModifyDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'ModifyDBSnapshotAttribute' => [ 'name' => 'ModifyDBSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBSubnetGroup' => [ 'name' => 'ModifyDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'ModifyDBSubnetGroupResult', 'resultWrapper' => 'ModifyDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'SubnetAlreadyInUse', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'ModifyEventSubscription' => [ 'name' => 'ModifyEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyEventSubscriptionMessage', ], 'output' => [ 'shape' => 'ModifyEventSubscriptionResult', 'resultWrapper' => 'ModifyEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], ], ], 'ModifyGlobalCluster' => [ 'name' => 'ModifyGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyGlobalClusterMessage', ], 'output' => [ 'shape' => 'ModifyGlobalClusterResult', 'resultWrapper' => 'ModifyGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ModifyIntegration' => [ 'name' => 'ModifyIntegration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyIntegrationMessage', ], 'output' => [ 'shape' => 'Integration', 'resultWrapper' => 'ModifyIntegrationResult', ], 'errors' => [ [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'InvalidIntegrationStateFault', ], [ 'shape' => 'IntegrationConflictOperationFault', ], ], ], 'ModifyOptionGroup' => [ 'name' => 'ModifyOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyOptionGroupMessage', ], 'output' => [ 'shape' => 'ModifyOptionGroupResult', 'resultWrapper' => 'ModifyOptionGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidOptionGroupStateFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'ModifyTenantDatabase' => [ 'name' => 'ModifyTenantDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyTenantDatabaseMessage', ], 'output' => [ 'shape' => 'ModifyTenantDatabaseResult', 'resultWrapper' => 'ModifyTenantDatabaseResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'TenantDatabaseAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'PromoteReadReplica' => [ 'name' => 'PromoteReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PromoteReadReplicaMessage', ], 'output' => [ 'shape' => 'PromoteReadReplicaResult', 'resultWrapper' => 'PromoteReadReplicaResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'PromoteReadReplicaDBCluster' => [ 'name' => 'PromoteReadReplicaDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PromoteReadReplicaDBClusterMessage', ], 'output' => [ 'shape' => 'PromoteReadReplicaDBClusterResult', 'resultWrapper' => 'PromoteReadReplicaDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'PurchaseReservedDBInstancesOffering' => [ 'name' => 'PurchaseReservedDBInstancesOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PurchaseReservedDBInstancesOfferingMessage', ], 'output' => [ 'shape' => 'PurchaseReservedDBInstancesOfferingResult', 'resultWrapper' => 'PurchaseReservedDBInstancesOfferingResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstancesOfferingNotFoundFault', ], [ 'shape' => 'ReservedDBInstanceAlreadyExistsFault', ], [ 'shape' => 'ReservedDBInstanceQuotaExceededFault', ], ], ], 'RebootDBCluster' => [ 'name' => 'RebootDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBClusterMessage', ], 'output' => [ 'shape' => 'RebootDBClusterResult', 'resultWrapper' => 'RebootDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'RebootDBInstance' => [ 'name' => 'RebootDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBInstanceMessage', ], 'output' => [ 'shape' => 'RebootDBInstanceResult', 'resultWrapper' => 'RebootDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'RebootDBShardGroup' => [ 'name' => 'RebootDBShardGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBShardGroupMessage', ], 'output' => [ 'shape' => 'DBShardGroup', 'resultWrapper' => 'RebootDBShardGroupResult', ], 'errors' => [ [ 'shape' => 'DBShardGroupNotFoundFault', ], [ 'shape' => 'InvalidDBShardGroupStateFault', ], ], ], 'RegisterDBProxyTargets' => [ 'name' => 'RegisterDBProxyTargets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterDBProxyTargetsRequest', ], 'output' => [ 'shape' => 'RegisterDBProxyTargetsResponse', 'resultWrapper' => 'RegisterDBProxyTargetsResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBProxyTargetAlreadyRegisteredFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], [ 'shape' => 'InsufficientAvailableIPsInSubnetFault', ], ], ], 'RemoveFromGlobalCluster' => [ 'name' => 'RemoveFromGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveFromGlobalClusterMessage', ], 'output' => [ 'shape' => 'RemoveFromGlobalClusterResult', 'resultWrapper' => 'RemoveFromGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'RemoveRoleFromDBCluster' => [ 'name' => 'RemoveRoleFromDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveRoleFromDBClusterMessage', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterRoleNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'RemoveRoleFromDBInstance' => [ 'name' => 'RemoveRoleFromDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveRoleFromDBInstanceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBInstanceRoleNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'RemoveSourceIdentifierFromSubscription' => [ 'name' => 'RemoveSourceIdentifierFromSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionMessage', ], 'output' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionResult', 'resultWrapper' => 'RemoveSourceIdentifierFromSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'RemoveTagsFromResource' => [ 'name' => 'RemoveTagsFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsFromResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'DBSnapshotTenantDatabaseNotFoundFault', ], ], ], 'ResetDBClusterParameterGroup' => [ 'name' => 'ResetDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ResetDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'ResetDBParameterGroup' => [ 'name' => 'ResetDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBParameterGroupMessage', ], 'output' => [ 'shape' => 'DBParameterGroupNameMessage', 'resultWrapper' => 'ResetDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'RestoreDBClusterFromS3' => [ 'name' => 'RestoreDBClusterFromS3', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromS3Message', ], 'output' => [ 'shape' => 'RestoreDBClusterFromS3Result', 'resultWrapper' => 'RestoreDBClusterFromS3Result', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], ], ], 'RestoreDBClusterFromSnapshot' => [ 'name' => 'RestoreDBClusterFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterFromSnapshotResult', 'resultWrapper' => 'RestoreDBClusterFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], ], ], 'RestoreDBClusterToPointInTime' => [ 'name' => 'RestoreDBClusterToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterToPointInTimeResult', 'resultWrapper' => 'RestoreDBClusterToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'DBClusterAutomatedBackupNotFoundFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], ], ], 'RestoreDBInstanceFromDBSnapshot' => [ 'name' => 'RestoreDBInstanceFromDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceFromDBSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBInstanceFromDBSnapshotResult', 'resultWrapper' => 'RestoreDBInstanceFromDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'CertificateNotFoundFault', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], ], ], 'RestoreDBInstanceFromS3' => [ 'name' => 'RestoreDBInstanceFromS3', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceFromS3Message', ], 'output' => [ 'shape' => 'RestoreDBInstanceFromS3Result', 'resultWrapper' => 'RestoreDBInstanceFromS3Result', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'RestoreDBInstanceToPointInTime' => [ 'name' => 'RestoreDBInstanceToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBInstanceToPointInTimeResult', 'resultWrapper' => 'RestoreDBInstanceToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'PointInTimeRestoreNotEnabledFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'RevokeDBSecurityGroupIngress' => [ 'name' => 'RevokeDBSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeDBSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'RevokeDBSecurityGroupIngressResult', 'resultWrapper' => 'RevokeDBSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], ], ], 'StartActivityStream' => [ 'name' => 'StartActivityStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartActivityStreamRequest', ], 'output' => [ 'shape' => 'StartActivityStreamResponse', 'resultWrapper' => 'StartActivityStreamResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'StartDBCluster' => [ 'name' => 'StartDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBClusterMessage', ], 'output' => [ 'shape' => 'StartDBClusterResult', 'resultWrapper' => 'StartDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StartDBInstance' => [ 'name' => 'StartDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBInstanceMessage', ], 'output' => [ 'shape' => 'StartDBInstanceResult', 'resultWrapper' => 'StartDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'StartDBInstanceAutomatedBackupsReplication' => [ 'name' => 'StartDBInstanceAutomatedBackupsReplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBInstanceAutomatedBackupsReplicationMessage', ], 'output' => [ 'shape' => 'StartDBInstanceAutomatedBackupsReplicationResult', 'resultWrapper' => 'StartDBInstanceAutomatedBackupsReplicationResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBInstanceAutomatedBackupQuotaExceededFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], ], ], 'StartExportTask' => [ 'name' => 'StartExportTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartExportTaskMessage', ], 'output' => [ 'shape' => 'ExportTask', 'resultWrapper' => 'StartExportTaskResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'ExportTaskAlreadyExistsFault', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'IamRoleNotFoundFault', ], [ 'shape' => 'IamRoleMissingPermissionsFault', ], [ 'shape' => 'InvalidExportOnlyFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'InvalidExportSourceStateFault', ], ], ], 'StopActivityStream' => [ 'name' => 'StopActivityStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopActivityStreamRequest', ], 'output' => [ 'shape' => 'StopActivityStreamResponse', 'resultWrapper' => 'StopActivityStreamResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'StopDBCluster' => [ 'name' => 'StopDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBClusterMessage', ], 'output' => [ 'shape' => 'StopDBClusterResult', 'resultWrapper' => 'StopDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StopDBInstance' => [ 'name' => 'StopDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBInstanceMessage', ], 'output' => [ 'shape' => 'StopDBInstanceResult', 'resultWrapper' => 'StopDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'StopDBInstanceAutomatedBackupsReplication' => [ 'name' => 'StopDBInstanceAutomatedBackupsReplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBInstanceAutomatedBackupsReplicationMessage', ], 'output' => [ 'shape' => 'StopDBInstanceAutomatedBackupsReplicationResult', 'resultWrapper' => 'StopDBInstanceAutomatedBackupsReplicationResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'SwitchoverBlueGreenDeployment' => [ 'name' => 'SwitchoverBlueGreenDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SwitchoverBlueGreenDeploymentRequest', ], 'output' => [ 'shape' => 'SwitchoverBlueGreenDeploymentResponse', 'resultWrapper' => 'SwitchoverBlueGreenDeploymentResult', ], 'errors' => [ [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'InvalidBlueGreenDeploymentStateFault', ], ], ], 'SwitchoverGlobalCluster' => [ 'name' => 'SwitchoverGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SwitchoverGlobalClusterMessage', ], 'output' => [ 'shape' => 'SwitchoverGlobalClusterResult', 'resultWrapper' => 'SwitchoverGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'SwitchoverReadReplica' => [ 'name' => 'SwitchoverReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SwitchoverReadReplicaMessage', ], 'output' => [ 'shape' => 'SwitchoverReadReplicaResult', 'resultWrapper' => 'SwitchoverReadReplicaResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], ], 'shapes' => [ 'AccountAttributesMessage' => [ 'type' => 'structure', 'members' => [ 'AccountQuotas' => [ 'shape' => 'AccountQuotaList', ], ], ], 'AccountQuota' => [ 'type' => 'structure', 'members' => [ 'AccountQuotaName' => [ 'shape' => 'String', ], 'Used' => [ 'shape' => 'Long', ], 'Max' => [ 'shape' => 'Long', ], ], 'wrapper' => true, ], 'AccountQuotaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountQuota', 'locationName' => 'AccountQuota', ], ], 'ActivityStreamMode' => [ 'type' => 'string', 'enum' => [ 'sync', 'async', ], ], 'ActivityStreamModeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ActivityStreamPolicyStatus' => [ 'type' => 'string', 'enum' => [ 'locked', 'unlocked', 'locking-policy', 'unlocking-policy', ], ], 'ActivityStreamStatus' => [ 'type' => 'string', 'enum' => [ 'stopped', 'starting', 'started', 'stopping', ], ], 'AddRoleToDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'RoleArn', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'AddRoleToDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'RoleArn', 'FeatureName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'AddTagsToResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'Tags', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ApplyMethod' => [ 'type' => 'string', 'enum' => [ 'immediate', 'pending-reboot', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceIdentifier', 'ApplyAction', 'OptInType', ], 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'ApplyAction' => [ 'shape' => 'String', ], 'OptInType' => [ 'shape' => 'String', ], ], ], 'ApplyPendingMaintenanceActionResult' => [ 'type' => 'structure', 'members' => [ 'ResourcePendingMaintenanceActions' => [ 'shape' => 'ResourcePendingMaintenanceActions', ], ], ], 'Arn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'AttributeValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AttributeValue', ], ], 'AuditPolicyState' => [ 'type' => 'string', 'enum' => [ 'locked', 'unlocked', ], ], 'AuthScheme' => [ 'type' => 'string', 'enum' => [ 'SECRETS', ], ], 'AuthorizationAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizeDBSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'AuthorizeDBSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'AutomationMode' => [ 'type' => 'string', 'enum' => [ 'full', 'all-paused', ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', 'locationName' => 'AvailabilityZone', ], ], 'AvailabilityZones' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AvailabilityZone', ], ], 'AvailableProcessorFeature' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], ], ], 'AvailableProcessorFeatureList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailableProcessorFeature', 'locationName' => 'AvailableProcessorFeature', ], ], 'AwsBackupRecoveryPointArn' => [ 'type' => 'string', 'max' => 350, 'min' => 43, 'pattern' => '^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\\-]+:)?[a-z][a-z0-9\\-]{0,255}$', ], 'BacktrackDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'BacktrackTo', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackTo' => [ 'shape' => 'TStamp', ], 'Force' => [ 'shape' => 'BooleanOptional', ], 'UseEarliestTimeOnPointInTimeUnavailable' => [ 'shape' => 'BooleanOptional', ], ], ], 'BackupPolicyNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'deprecated' => true, 'deprecatedMessage' => 'Please avoid using this fault', 'error' => [ 'code' => 'BackupPolicyNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'BlueGreenDeployment' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeploymentIdentifier' => [ 'shape' => 'BlueGreenDeploymentIdentifier', ], 'BlueGreenDeploymentName' => [ 'shape' => 'BlueGreenDeploymentName', ], 'Source' => [ 'shape' => 'DatabaseArn', ], 'Target' => [ 'shape' => 'DatabaseArn', ], 'SwitchoverDetails' => [ 'shape' => 'SwitchoverDetailList', ], 'Tasks' => [ 'shape' => 'BlueGreenDeploymentTaskList', ], 'Status' => [ 'shape' => 'BlueGreenDeploymentStatus', ], 'StatusDetails' => [ 'shape' => 'BlueGreenDeploymentStatusDetails', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'DeleteTime' => [ 'shape' => 'TStamp', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'BlueGreenDeploymentAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'BlueGreenDeploymentAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'BlueGreenDeploymentIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z][0-9A-Za-z-:._]*', ], 'BlueGreenDeploymentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BlueGreenDeployment', ], ], 'BlueGreenDeploymentName' => [ 'type' => 'string', 'max' => 60, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'BlueGreenDeploymentNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'BlueGreenDeploymentNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'BlueGreenDeploymentStatus' => [ 'type' => 'string', ], 'BlueGreenDeploymentStatusDetails' => [ 'type' => 'string', ], 'BlueGreenDeploymentTask' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'BlueGreenDeploymentTaskName', ], 'Status' => [ 'shape' => 'BlueGreenDeploymentTaskStatus', ], ], ], 'BlueGreenDeploymentTaskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BlueGreenDeploymentTask', ], ], 'BlueGreenDeploymentTaskName' => [ 'type' => 'string', ], 'BlueGreenDeploymentTaskStatus' => [ 'type' => 'string', ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '.*', ], 'CACertificateIdentifiersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'CancelExportTaskMessage' => [ 'type' => 'structure', 'required' => [ 'ExportTaskIdentifier', ], 'members' => [ 'ExportTaskIdentifier' => [ 'shape' => 'String', ], ], ], 'Certificate' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'CertificateType' => [ 'shape' => 'String', ], 'Thumbprint' => [ 'shape' => 'String', ], 'ValidFrom' => [ 'shape' => 'TStamp', ], 'ValidTill' => [ 'shape' => 'TStamp', ], 'CertificateArn' => [ 'shape' => 'String', ], 'CustomerOverride' => [ 'shape' => 'BooleanOptional', ], 'CustomerOverrideValidTill' => [ 'shape' => 'TStamp', ], ], 'wrapper' => true, ], 'CertificateDetails' => [ 'type' => 'structure', 'members' => [ 'CAIdentifier' => [ 'shape' => 'String', ], 'ValidTill' => [ 'shape' => 'TStamp', ], ], ], 'CertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Certificate', 'locationName' => 'Certificate', ], ], 'CertificateMessage' => [ 'type' => 'structure', 'members' => [ 'DefaultCertificateForNewLaunches' => [ 'shape' => 'String', ], 'Certificates' => [ 'shape' => 'CertificateList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'CertificateNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CertificateNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CharacterSet' => [ 'type' => 'structure', 'members' => [ 'CharacterSetName' => [ 'shape' => 'String', ], 'CharacterSetDescription' => [ 'shape' => 'String', ], ], ], 'ClientPasswordAuthType' => [ 'type' => 'string', 'enum' => [ 'MYSQL_NATIVE_PASSWORD', 'POSTGRES_SCRAM_SHA_256', 'POSTGRES_MD5', 'SQL_SERVER_AUTHENTICATION', ], ], 'CloudwatchLogsExportConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableLogTypes' => [ 'shape' => 'LogTypeList', ], 'DisableLogTypes' => [ 'shape' => 'LogTypeList', ], ], ], 'ClusterPendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'PendingCloudwatchLogsExports' => [ 'shape' => 'PendingCloudwatchLogsExports', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'StorageType' => [ 'shape' => 'String', ], 'CertificateDetails' => [ 'shape' => 'CertificateDetails', ], ], ], 'ConnectionPoolConfiguration' => [ 'type' => 'structure', 'members' => [ 'MaxConnectionsPercent' => [ 'shape' => 'IntegerOptional', ], 'MaxIdleConnectionsPercent' => [ 'shape' => 'IntegerOptional', ], 'ConnectionBorrowTimeout' => [ 'shape' => 'IntegerOptional', ], 'SessionPinningFilters' => [ 'shape' => 'StringList', ], 'InitQuery' => [ 'shape' => 'String', ], ], ], 'ConnectionPoolConfigurationInfo' => [ 'type' => 'structure', 'members' => [ 'MaxConnectionsPercent' => [ 'shape' => 'Integer', ], 'MaxIdleConnectionsPercent' => [ 'shape' => 'Integer', ], 'ConnectionBorrowTimeout' => [ 'shape' => 'Integer', ], 'SessionPinningFilters' => [ 'shape' => 'StringList', ], 'InitQuery' => [ 'shape' => 'String', ], ], ], 'ContextAttribute' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'ContextAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContextAttribute', ], ], 'CopyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupDescription', ], 'members' => [ 'SourceDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CopyDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterSnapshotIdentifier', 'TargetDBClusterSnapshotIdentifier', ], 'members' => [ 'SourceDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CopyDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBParameterGroupIdentifier', 'TargetDBParameterGroupIdentifier', 'TargetDBParameterGroupDescription', ], 'members' => [ 'SourceDBParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroup' => [ 'shape' => 'DBParameterGroup', ], ], ], 'CopyDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBSnapshotIdentifier', 'TargetDBSnapshotIdentifier', ], 'members' => [ 'SourceDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'TargetCustomAvailabilityZone' => [ 'shape' => 'String', ], 'CopyOptionGroup' => [ 'shape' => 'BooleanOptional', ], ], ], 'CopyDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'CopyOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceOptionGroupIdentifier', 'TargetOptionGroupIdentifier', 'TargetOptionGroupDescription', ], 'members' => [ 'SourceOptionGroupIdentifier' => [ 'shape' => 'String', ], 'TargetOptionGroupIdentifier' => [ 'shape' => 'String', ], 'TargetOptionGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'CreateBlueGreenDeploymentRequest' => [ 'type' => 'structure', 'required' => [ 'BlueGreenDeploymentName', 'Source', ], 'members' => [ 'BlueGreenDeploymentName' => [ 'shape' => 'BlueGreenDeploymentName', ], 'Source' => [ 'shape' => 'DatabaseArn', ], 'TargetEngineVersion' => [ 'shape' => 'TargetEngineVersion', ], 'TargetDBParameterGroupName' => [ 'shape' => 'TargetDBParameterGroupName', ], 'TargetDBClusterParameterGroupName' => [ 'shape' => 'TargetDBClusterParameterGroupName', ], 'Tags' => [ 'shape' => 'TagList', ], 'TargetDBInstanceClass' => [ 'shape' => 'TargetDBInstanceClass', ], 'UpgradeTargetStorageConfig' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateBlueGreenDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeployment' => [ 'shape' => 'BlueGreenDeployment', ], ], ], 'CreateCustomDBEngineVersionFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CreateCustomDBEngineVersionFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CreateCustomDBEngineVersionMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', 'EngineVersion', ], 'members' => [ 'Engine' => [ 'shape' => 'CustomEngineName', ], 'EngineVersion' => [ 'shape' => 'CustomEngineVersion', ], 'DatabaseInstallationFilesS3BucketName' => [ 'shape' => 'BucketName', ], 'DatabaseInstallationFilesS3Prefix' => [ 'shape' => 'String255', ], 'ImageId' => [ 'shape' => 'String255', ], 'KMSKeyId' => [ 'shape' => 'KmsKeyIdOrArn', ], 'Description' => [ 'shape' => 'Description', ], 'Manifest' => [ 'shape' => 'CustomDBEngineVersionManifest', ], 'Tags' => [ 'shape' => 'TagList', ], 'SourceCustomDbEngineVersionIdentifier' => [ 'shape' => 'String255', ], 'UseAwsProvidedLatestImage' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'DBClusterEndpointIdentifier', 'EndpointType', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'EnableHttpEndpoint' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'EnableGlobalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableLimitlessDatabase' => [ 'shape' => 'BooleanOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'DBSystemId' => [ 'shape' => 'String', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'EnableLocalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'CreateDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CreateDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'CreateDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'DBClusterIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CreateDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', ], 'members' => [ 'DBName' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'Timezone' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'BackupTarget' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DBSystemId' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBInstanceReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'StorageType' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'ReplicaMode' => [ 'shape' => 'ReplicaMode', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'UpgradeStorageConfig' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'CreateDBInstanceReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroup' => [ 'shape' => 'DBParameterGroup', ], ], ], 'CreateDBProxyEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', 'DBProxyEndpointName', 'VpcSubnetIds', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'DBProxyName', ], 'DBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], 'VpcSubnetIds' => [ 'shape' => 'StringList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], 'TargetRole' => [ 'shape' => 'DBProxyEndpointTargetRole', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBProxyEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpoint' => [ 'shape' => 'DBProxyEndpoint', ], ], ], 'CreateDBProxyRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', 'EngineFamily', 'Auth', 'RoleArn', 'VpcSubnetIds', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'EngineFamily' => [ 'shape' => 'EngineFamily', ], 'Auth' => [ 'shape' => 'UserAuthConfigList', ], 'RoleArn' => [ 'shape' => 'String', ], 'VpcSubnetIds' => [ 'shape' => 'StringList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], 'RequireTLS' => [ 'shape' => 'Boolean', ], 'IdleClientTimeout' => [ 'shape' => 'IntegerOptional', ], 'DebugLogging' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBProxyResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxy' => [ 'shape' => 'DBProxy', ], ], ], 'CreateDBSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', 'DBSecurityGroupDescription', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSecurityGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'CreateDBShardGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBShardGroupIdentifier', 'DBClusterIdentifier', 'MaxACU', ], 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'ComputeRedundancy' => [ 'shape' => 'IntegerOptional', ], 'MaxACU' => [ 'shape' => 'DoubleOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', 'DBInstanceIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'CreateDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'DBSubnetGroupDescription', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'CreateEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SnsTopicArn', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'SourceIds' => [ 'shape' => 'SourceIdsList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'CreateGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'CreateIntegrationMessage' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'TargetArn', 'IntegrationName', ], 'members' => [ 'SourceArn' => [ 'shape' => 'SourceArn', ], 'TargetArn' => [ 'shape' => 'Arn', ], 'IntegrationName' => [ 'shape' => 'IntegrationName', ], 'KMSKeyId' => [ 'shape' => 'String', ], 'AdditionalEncryptionContext' => [ 'shape' => 'EncryptionContextMap', ], 'Tags' => [ 'shape' => 'TagList', ], 'DataFilter' => [ 'shape' => 'DataFilter', ], 'Description' => [ 'shape' => 'IntegrationDescription', ], ], ], 'CreateOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', 'EngineName', 'MajorEngineVersion', 'OptionGroupDescription', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'OptionGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'CreateTenantDatabaseMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'TenantDBName', 'MasterUsername', 'MasterUserPassword', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'SensitiveString', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTenantDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'TenantDatabase' => [ 'shape' => 'TenantDatabase', ], ], ], 'CustomAvailabilityZoneNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CustomAvailabilityZoneNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CustomDBEngineVersionAMI' => [ 'type' => 'structure', 'members' => [ 'ImageId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'CustomDBEngineVersionAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CustomDBEngineVersionAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CustomDBEngineVersionManifest' => [ 'type' => 'string', 'max' => 51000, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'CustomDBEngineVersionNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CustomDBEngineVersionNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CustomDBEngineVersionQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CustomDBEngineVersionQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CustomEngineName' => [ 'type' => 'string', 'max' => 35, 'min' => 1, 'pattern' => '^[A-Za-z0-9-]{1,35}$', ], 'CustomEngineVersion' => [ 'type' => 'string', 'max' => 60, 'min' => 1, 'pattern' => '^[a-z0-9_.-]{1,60}$', ], 'CustomEngineVersionStatus' => [ 'type' => 'string', 'enum' => [ 'available', 'inactive', 'inactive-except-restore', ], ], 'DBCluster' => [ 'type' => 'structure', 'members' => [ 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroup' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'AutomaticRestartTime' => [ 'shape' => 'TStamp', ], 'PercentProgress' => [ 'shape' => 'String', ], 'EarliestRestorableTime' => [ 'shape' => 'TStamp', ], 'Endpoint' => [ 'shape' => 'String', ], 'ReaderEndpoint' => [ 'shape' => 'String', ], 'CustomEndpoints' => [ 'shape' => 'StringList', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DBClusterOptionGroupMemberships' => [ 'shape' => 'DBClusterOptionGroupMemberships', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaIdentifiers' => [ 'shape' => 'ReadReplicaIdentifierList', ], 'StatusInfos' => [ 'shape' => 'DBClusterStatusInfoList', ], 'DBClusterMembers' => [ 'shape' => 'DBClusterMemberList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'HostedZoneId' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'DBClusterArn' => [ 'shape' => 'String', ], 'AssociatedRoles' => [ 'shape' => 'DBClusterRoles', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'BooleanOptional', ], 'CloneGroupId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'EarliestBacktrackTime' => [ 'shape' => 'TStamp', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'BacktrackConsumedChangeRecords' => [ 'shape' => 'LongOptional', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'Capacity' => [ 'shape' => 'IntegerOptional', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfigurationInfo' => [ 'shape' => 'ScalingConfigurationInfo', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'HttpEndpointEnabled' => [ 'shape' => 'BooleanOptional', ], 'ActivityStreamMode' => [ 'shape' => 'ActivityStreamMode', ], 'ActivityStreamStatus' => [ 'shape' => 'ActivityStreamStatus', ], 'ActivityStreamKmsKeyId' => [ 'shape' => 'String', ], 'ActivityStreamKinesisStreamName' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'CrossAccountClone' => [ 'shape' => 'BooleanOptional', ], 'DomainMemberships' => [ 'shape' => 'DomainMembershipList', ], 'TagList' => [ 'shape' => 'TagList', ], 'GlobalWriteForwardingStatus' => [ 'shape' => 'WriteForwardingStatus', ], 'GlobalWriteForwardingRequested' => [ 'shape' => 'BooleanOptional', ], 'PendingModifiedValues' => [ 'shape' => 'ClusterPendingModifiedValues', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'PerformanceInsightsEnabled' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfigurationInfo', ], 'NetworkType' => [ 'shape' => 'String', ], 'DBSystemId' => [ 'shape' => 'String', ], 'MasterUserSecret' => [ 'shape' => 'MasterUserSecret', ], 'IOOptimizedNextAllowedModificationTime' => [ 'shape' => 'TStamp', ], 'LocalWriteForwardingStatus' => [ 'shape' => 'LocalWriteForwardingStatus', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'String', ], 'LimitlessDatabase' => [ 'shape' => 'LimitlessDatabase', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'CertificateDetails' => [ 'shape' => 'CertificateDetails', ], ], 'wrapper' => true, ], 'DBClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterAutomatedBackup' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'DBClusterAutomatedBackupsArn' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreWindow' => [ 'shape' => 'RestoreWindow', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'Region' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBClusterArn' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EngineMode' => [ 'shape' => 'String', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'Port' => [ 'shape' => 'Integer', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterAutomatedBackupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterAutomatedBackup', 'locationName' => 'DBClusterAutomatedBackup', ], ], 'DBClusterAutomatedBackupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterAutomatedBackups' => [ 'shape' => 'DBClusterAutomatedBackupList', ], ], ], 'DBClusterAutomatedBackupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAutomatedBackupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterAutomatedBackupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAutomatedBackupQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterBacktrack' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackIdentifier' => [ 'shape' => 'String', ], 'BacktrackTo' => [ 'shape' => 'TStamp', ], 'BacktrackedFrom' => [ 'shape' => 'TStamp', ], 'BacktrackRequestCreationTime' => [ 'shape' => 'TStamp', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterBacktrackList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterBacktrack', 'locationName' => 'DBClusterBacktrack', ], ], 'DBClusterBacktrackMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterBacktracks' => [ 'shape' => 'DBClusterBacktrackList', ], ], ], 'DBClusterBacktrackNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterBacktrackNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterCapacityInfo' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'PendingCapacity' => [ 'shape' => 'IntegerOptional', ], 'CurrentCapacity' => [ 'shape' => 'IntegerOptional', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], ], ], 'DBClusterEndpoint' => [ 'type' => 'structure', 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointResourceIdentifier' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'CustomEndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], 'DBClusterEndpointArn' => [ 'shape' => 'String', ], ], ], 'DBClusterEndpointAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterEndpoint', 'locationName' => 'DBClusterEndpointList', ], ], 'DBClusterEndpointMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterEndpoints' => [ 'shape' => 'DBClusterEndpointList', ], ], ], 'DBClusterEndpointNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointNotFoundFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterEndpointQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z][0-9A-Za-z-:._]*', ], 'DBClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBCluster', 'locationName' => 'DBCluster', ], ], 'DBClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'IsClusterWriter' => [ 'shape' => 'Boolean', ], 'DBClusterParameterGroupStatus' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterMember', 'locationName' => 'DBClusterMember', ], ], 'DBClusterMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusters' => [ 'shape' => 'DBClusterList', ], ], ], 'DBClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterOptionGroupMemberships' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterOptionGroupStatus', 'locationName' => 'DBClusterOptionGroup', ], ], 'DBClusterOptionGroupStatus' => [ 'type' => 'structure', 'members' => [ 'DBClusterOptionGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBClusterParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterParameterGroup', 'locationName' => 'DBClusterParameterGroup', ], ], 'DBClusterParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterParameterGroups' => [ 'shape' => 'DBClusterParameterGroupList', ], ], ], 'DBClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'DBClusterRoleAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoleQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterRole', 'locationName' => 'DBClusterRole', ], ], 'DBClusterSnapshot' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'EngineMode' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'VpcId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBClusterSnapshotArn' => [ 'shape' => 'String', ], 'SourceDBClusterSnapshotArn' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'TagList' => [ 'shape' => 'TagList', ], 'DBSystemId' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], ], 'DBClusterSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshotAttribute', 'locationName' => 'DBClusterSnapshotAttribute', ], ], 'DBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotAttributes' => [ 'shape' => 'DBClusterSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBClusterSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshot', 'locationName' => 'DBClusterSnapshot', ], ], 'DBClusterSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterSnapshots' => [ 'shape' => 'DBClusterSnapshotList', ], ], ], 'DBClusterSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterStatusInfo' => [ 'type' => 'structure', 'members' => [ 'StatusType' => [ 'shape' => 'String', ], 'Normal' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DBClusterStatusInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterStatusInfo', 'locationName' => 'DBClusterStatusInfo', ], ], 'DBEngineVersion' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'DBEngineDescription' => [ 'shape' => 'String', ], 'DBEngineVersionDescription' => [ 'shape' => 'String', ], 'DefaultCharacterSet' => [ 'shape' => 'CharacterSet', ], 'Image' => [ 'shape' => 'CustomDBEngineVersionAMI', ], 'DBEngineMediaType' => [ 'shape' => 'String', ], 'SupportedCharacterSets' => [ 'shape' => 'SupportedCharacterSetsList', ], 'SupportedNcharCharacterSets' => [ 'shape' => 'SupportedCharacterSetsList', ], 'ValidUpgradeTarget' => [ 'shape' => 'ValidUpgradeTargetList', ], 'SupportedTimezones' => [ 'shape' => 'SupportedTimezonesList', ], 'ExportableLogTypes' => [ 'shape' => 'LogTypeList', ], 'SupportsLogExportsToCloudwatchLogs' => [ 'shape' => 'Boolean', ], 'SupportsReadReplica' => [ 'shape' => 'Boolean', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], 'SupportedFeatureNames' => [ 'shape' => 'FeatureNameList', ], 'Status' => [ 'shape' => 'String', ], 'SupportsParallelQuery' => [ 'shape' => 'Boolean', ], 'SupportsGlobalDatabases' => [ 'shape' => 'Boolean', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'DatabaseInstallationFilesS3BucketName' => [ 'shape' => 'String', ], 'DatabaseInstallationFilesS3Prefix' => [ 'shape' => 'String', ], 'DBEngineVersionArn' => [ 'shape' => 'String', ], 'KMSKeyId' => [ 'shape' => 'String', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'TagList' => [ 'shape' => 'TagList', ], 'SupportsBabelfish' => [ 'shape' => 'Boolean', ], 'CustomDBEngineVersionManifest' => [ 'shape' => 'CustomDBEngineVersionManifest', ], 'SupportsLimitlessDatabase' => [ 'shape' => 'Boolean', ], 'SupportsCertificateRotationWithoutRestart' => [ 'shape' => 'BooleanOptional', ], 'SupportedCACertificateIdentifiers' => [ 'shape' => 'CACertificateIdentifiersList', ], 'SupportsLocalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'SupportsIntegrations' => [ 'shape' => 'Boolean', ], ], ], 'DBEngineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBEngineVersion', 'locationName' => 'DBEngineVersion', ], ], 'DBEngineVersionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBEngineVersions' => [ 'shape' => 'DBEngineVersionList', ], ], ], 'DBInstance' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'DBInstanceStatus' => [ 'shape' => 'String', ], 'AutomaticRestartTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'Integer', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupMembershipList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'DBParameterGroups' => [ 'shape' => 'DBParameterGroupStatusList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'PendingModifiedValues', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'ReadReplicaSourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaDBInstanceIdentifiers' => [ 'shape' => 'ReadReplicaDBInstanceIdentifierList', ], 'ReadReplicaDBClusterIdentifiers' => [ 'shape' => 'ReadReplicaDBClusterIdentifierList', ], 'ReplicaMode' => [ 'shape' => 'ReplicaMode', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupMemberships' => [ 'shape' => 'OptionGroupMembershipList', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'SecondaryAvailabilityZone' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'Boolean', ], 'StatusInfos' => [ 'shape' => 'DBInstanceStatusInfoList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'DbInstancePort' => [ 'shape' => 'Integer', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DomainMemberships' => [ 'shape' => 'DomainMembershipList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'Boolean', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'EnhancedMonitoringResourceArn' => [ 'shape' => 'String', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceArn' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'PerformanceInsightsEnabled' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'AssociatedRoles' => [ 'shape' => 'DBInstanceRoles', ], 'ListenerEndpoint' => [ 'shape' => 'Endpoint', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'TagList' => [ 'shape' => 'TagList', ], 'DBInstanceAutomatedBackupsReplications' => [ 'shape' => 'DBInstanceAutomatedBackupsReplicationList', ], 'CustomerOwnedIpEnabled' => [ 'shape' => 'BooleanOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'String', ], 'ActivityStreamStatus' => [ 'shape' => 'ActivityStreamStatus', ], 'ActivityStreamKmsKeyId' => [ 'shape' => 'String', ], 'ActivityStreamKinesisStreamName' => [ 'shape' => 'String', ], 'ActivityStreamMode' => [ 'shape' => 'ActivityStreamMode', ], 'ActivityStreamEngineNativeAuditFieldsIncluded' => [ 'shape' => 'BooleanOptional', ], 'AutomationMode' => [ 'shape' => 'AutomationMode', ], 'ResumeFullAutomationModeTime' => [ 'shape' => 'TStamp', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'BackupTarget' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'ActivityStreamPolicyStatus' => [ 'shape' => 'ActivityStreamPolicyStatus', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'DBSystemId' => [ 'shape' => 'String', ], 'MasterUserSecret' => [ 'shape' => 'MasterUserSecret', ], 'CertificateDetails' => [ 'shape' => 'CertificateDetails', ], 'ReadReplicaSourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'Boolean', ], 'IsStorageConfigUpgradeAvailable' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], 'wrapper' => true, ], 'DBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackup' => [ 'type' => 'structure', 'members' => [ 'DBInstanceArn' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'Region' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RestoreWindow' => [ 'shape' => 'RestoreWindow', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'Encrypted' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackupsReplications' => [ 'shape' => 'DBInstanceAutomatedBackupsReplicationList', ], 'BackupTarget' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], 'wrapper' => true, ], 'DBInstanceAutomatedBackupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceAutomatedBackup', 'locationName' => 'DBInstanceAutomatedBackup', ], ], 'DBInstanceAutomatedBackupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackups' => [ 'shape' => 'DBInstanceAutomatedBackupList', ], ], ], 'DBInstanceAutomatedBackupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAutomatedBackupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAutomatedBackupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackupsReplication' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], ], ], 'DBInstanceAutomatedBackupsReplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceAutomatedBackupsReplication', 'locationName' => 'DBInstanceAutomatedBackupsReplication', ], ], 'DBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstance', 'locationName' => 'DBInstance', ], ], 'DBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstances' => [ 'shape' => 'DBInstanceList', ], ], ], 'DBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBInstanceRoleAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoleQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceRole', 'locationName' => 'DBInstanceRole', ], ], 'DBInstanceStatusInfo' => [ 'type' => 'structure', 'members' => [ 'StatusType' => [ 'shape' => 'String', ], 'Normal' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DBInstanceStatusInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceStatusInfo', 'locationName' => 'DBInstanceStatusInfo', ], ], 'DBLogFileNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBLogFileNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBParameterGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBParameterGroup', 'locationName' => 'DBParameterGroup', ], ], 'DBParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupStatus' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'ParameterApplyStatus' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBParameterGroupStatus', 'locationName' => 'DBParameterGroup', ], ], 'DBParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBParameterGroups' => [ 'shape' => 'DBParameterGroupList', ], ], ], 'DBProxy' => [ 'type' => 'structure', 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'DBProxyArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'DBProxyStatus', ], 'EngineFamily' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], 'VpcSubnetIds' => [ 'shape' => 'StringList', ], 'Auth' => [ 'shape' => 'UserAuthConfigInfoList', ], 'RoleArn' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'RequireTLS' => [ 'shape' => 'Boolean', ], 'IdleClientTimeout' => [ 'shape' => 'Integer', ], 'DebugLogging' => [ 'shape' => 'Boolean', ], 'CreatedDate' => [ 'shape' => 'TStamp', ], 'UpdatedDate' => [ 'shape' => 'TStamp', ], ], ], 'DBProxyAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyEndpoint' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpointName' => [ 'shape' => 'String', ], 'DBProxyEndpointArn' => [ 'shape' => 'String', ], 'DBProxyName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'DBProxyEndpointStatus', ], 'VpcId' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], 'VpcSubnetIds' => [ 'shape' => 'StringList', ], 'Endpoint' => [ 'shape' => 'String', ], 'CreatedDate' => [ 'shape' => 'TStamp', ], 'TargetRole' => [ 'shape' => 'DBProxyEndpointTargetRole', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'DBProxyEndpointAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyEndpointAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBProxyEndpoint', ], ], 'DBProxyEndpointName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'DBProxyEndpointNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyEndpointNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyEndpointQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyEndpointQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyEndpointStatus' => [ 'type' => 'string', 'enum' => [ 'available', 'modifying', 'incompatible-network', 'insufficient-resource-limits', 'creating', 'deleting', ], ], 'DBProxyEndpointTargetRole' => [ 'type' => 'string', 'enum' => [ 'READ_WRITE', 'READ_ONLY', ], ], 'DBProxyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBProxy', ], ], 'DBProxyName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'DBProxyNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyStatus' => [ 'type' => 'string', 'enum' => [ 'available', 'modifying', 'incompatible-network', 'insufficient-resource-limits', 'creating', 'deleting', 'suspended', 'suspending', 'reactivating', ], ], 'DBProxyTarget' => [ 'type' => 'structure', 'members' => [ 'TargetArn' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'TrackedClusterId' => [ 'shape' => 'String', ], 'RdsResourceId' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'Type' => [ 'shape' => 'TargetType', ], 'Role' => [ 'shape' => 'TargetRole', ], 'TargetHealth' => [ 'shape' => 'TargetHealth', ], ], ], 'DBProxyTargetAlreadyRegisteredFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyTargetAlreadyRegisteredFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyTargetGroup' => [ 'type' => 'structure', 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'TargetGroupArn' => [ 'shape' => 'String', ], 'IsDefault' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'ConnectionPoolConfig' => [ 'shape' => 'ConnectionPoolConfigurationInfo', ], 'CreatedDate' => [ 'shape' => 'TStamp', ], 'UpdatedDate' => [ 'shape' => 'TStamp', ], ], ], 'DBProxyTargetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyTargetGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyTargetNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyTargetNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBRecommendation' => [ 'type' => 'structure', 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'TypeId' => [ 'shape' => 'String', ], 'Severity' => [ 'shape' => 'String', ], 'ResourceArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'CreatedTime' => [ 'shape' => 'TStamp', ], 'UpdatedTime' => [ 'shape' => 'TStamp', ], 'Detection' => [ 'shape' => 'String', ], 'Recommendation' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'String', ], 'RecommendedActions' => [ 'shape' => 'RecommendedActionList', ], 'Category' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'TypeDetection' => [ 'shape' => 'String', ], 'TypeRecommendation' => [ 'shape' => 'String', ], 'Impact' => [ 'shape' => 'String', ], 'AdditionalInfo' => [ 'shape' => 'String', ], 'Links' => [ 'shape' => 'DocLinkList', ], 'IssueDetails' => [ 'shape' => 'IssueDetails', ], ], ], 'DBRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBRecommendation', ], ], 'DBRecommendationMessage' => [ 'type' => 'structure', 'members' => [ 'DBRecommendation' => [ 'shape' => 'DBRecommendation', ], ], ], 'DBRecommendationsMessage' => [ 'type' => 'structure', 'members' => [ 'DBRecommendations' => [ 'shape' => 'DBRecommendationList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBSecurityGroup' => [ 'type' => 'structure', 'members' => [ 'OwnerId' => [ 'shape' => 'String', ], 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'EC2SecurityGroups' => [ 'shape' => 'EC2SecurityGroupList', ], 'IPRanges' => [ 'shape' => 'IPRangeList', ], 'DBSecurityGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSecurityGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSecurityGroupMembership', 'locationName' => 'DBSecurityGroup', ], ], 'DBSecurityGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroups', ], ], ], 'DBSecurityGroupNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'DBSecurityGroupName', ], ], 'DBSecurityGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'QuotaExceeded.DBSecurityGroup', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSecurityGroup', 'locationName' => 'DBSecurityGroup', ], ], 'DBShardGroup' => [ 'type' => 'structure', 'members' => [ 'DBShardGroupResourceId' => [ 'shape' => 'String', ], 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'MaxACU' => [ 'shape' => 'DoubleOptional', ], 'ComputeRedundancy' => [ 'shape' => 'IntegerOptional', ], 'Status' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Endpoint' => [ 'shape' => 'String', ], ], ], 'DBShardGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBShardGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBShardGroupIdentifier' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'DBShardGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBShardGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBShardGroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBShardGroup', 'locationName' => 'DBShardGroup', ], ], 'DBSnapshot' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'SourceRegion' => [ 'shape' => 'String', ], 'SourceDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'Encrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBSnapshotArn' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'TagList' => [ 'shape' => 'TagList', ], 'OriginalSnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'SnapshotDatabaseTime' => [ 'shape' => 'TStamp', ], 'SnapshotTarget' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'DBSystemId' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'Boolean', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], 'wrapper' => true, ], 'DBSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], 'wrapper' => true, ], 'DBSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshotAttribute', 'locationName' => 'DBSnapshotAttribute', ], ], 'DBSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotAttributes' => [ 'shape' => 'DBSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshot', 'locationName' => 'DBSnapshot', ], ], 'DBSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSnapshots' => [ 'shape' => 'DBSnapshotList', ], ], ], 'DBSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotTenantDatabase' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'TenantDatabaseCreateTime' => [ 'shape' => 'TStamp', ], 'TenantDBName' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'TenantDatabaseResourceId' => [ 'shape' => 'String', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DBSnapshotTenantDatabaseARN' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'TagList' => [ 'shape' => 'TagList', ], ], 'wrapper' => true, ], 'DBSnapshotTenantDatabaseNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotTenantDatabaseNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotTenantDatabasesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshotTenantDatabase', 'locationName' => 'DBSnapshotTenantDatabase', ], ], 'DBSnapshotTenantDatabasesMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSnapshotTenantDatabases' => [ 'shape' => 'DBSnapshotTenantDatabasesList', ], ], ], 'DBSubnetGroup' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'SubnetGroupStatus' => [ 'shape' => 'String', ], 'Subnets' => [ 'shape' => 'SubnetList', ], 'DBSubnetGroupArn' => [ 'shape' => 'String', ], 'SupportedNetworkTypes' => [ 'shape' => 'StringList', ], ], 'wrapper' => true, ], 'DBSubnetGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupDoesNotCoverEnoughAZs' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupDoesNotCoverEnoughAZs', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSubnetGroups' => [ 'shape' => 'DBSubnetGroups', ], ], ], 'DBSubnetGroupNotAllowedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotAllowedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSubnetGroup', 'locationName' => 'DBSubnetGroup', ], ], 'DBSubnetQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBUpgradeDependencyFailureFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBUpgradeDependencyFailure', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DataFilter' => [ 'type' => 'string', 'max' => 25600, 'min' => 1, 'pattern' => '[a-zA-Z0-9_ "\\\\\\-$,*.:?+\\/]*', ], 'DatabaseArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:[A-Za-z][0-9A-Za-z-:._]*', ], 'DeleteBlueGreenDeploymentRequest' => [ 'type' => 'structure', 'required' => [ 'BlueGreenDeploymentIdentifier', ], 'members' => [ 'BlueGreenDeploymentIdentifier' => [ 'shape' => 'BlueGreenDeploymentIdentifier', ], 'DeleteTarget' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteBlueGreenDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeployment' => [ 'shape' => 'BlueGreenDeployment', ], ], ], 'DeleteCustomDBEngineVersionMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', 'EngineVersion', ], 'members' => [ 'Engine' => [ 'shape' => 'CustomEngineName', ], 'EngineVersion' => [ 'shape' => 'CustomEngineVersion', ], ], ], 'DeleteDBClusterAutomatedBackupMessage' => [ 'type' => 'structure', 'required' => [ 'DbClusterResourceId', ], 'members' => [ 'DbClusterResourceId' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterAutomatedBackupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterAutomatedBackup' => [ 'shape' => 'DBClusterAutomatedBackup', ], ], ], 'DeleteDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterEndpointIdentifier', ], 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DeleteAutomatedBackups' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'DeleteDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'DeleteDBInstanceAutomatedBackupMessage' => [ 'type' => 'structure', 'members' => [ 'DbiResourceId' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], ], ], 'DeleteDBInstanceAutomatedBackupResult' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackup' => [ 'shape' => 'DBInstanceAutomatedBackup', ], ], ], 'DeleteDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DeleteAutomatedBackups' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'DeleteDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBProxyEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyEndpointName', ], 'members' => [ 'DBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], ], ], 'DeleteDBProxyEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpoint' => [ 'shape' => 'DBProxyEndpoint', ], ], ], 'DeleteDBProxyRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], ], ], 'DeleteDBProxyResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxy' => [ 'shape' => 'DBProxy', ], ], ], 'DeleteDBSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBShardGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBShardGroupIdentifier', ], 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], ], ], 'DeleteDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'DeleteDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'DeleteGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'DeleteIntegrationMessage' => [ 'type' => 'structure', 'required' => [ 'IntegrationIdentifier', ], 'members' => [ 'IntegrationIdentifier' => [ 'shape' => 'IntegrationIdentifier', ], ], ], 'DeleteOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteTenantDatabaseMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'TenantDBName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteTenantDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'TenantDatabase' => [ 'shape' => 'TenantDatabase', ], ], ], 'DeregisterDBProxyTargetsRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'DBInstanceIdentifiers' => [ 'shape' => 'StringList', ], 'DBClusterIdentifiers' => [ 'shape' => 'StringList', ], ], ], 'DeregisterDBProxyTargetsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DescribeAccountAttributesMessage' => [ 'type' => 'structure', 'members' => [], ], 'DescribeBlueGreenDeploymentsRequest' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeploymentIdentifier' => [ 'shape' => 'BlueGreenDeploymentIdentifier', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeBlueGreenDeploymentsResponse' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeployments' => [ 'shape' => 'BlueGreenDeploymentList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeCertificatesMessage' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterAutomatedBackupsMessage' => [ 'type' => 'structure', 'members' => [ 'DbClusterResourceId' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterBacktracksMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterEndpointsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'DescribeDBClusterSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], ], ], 'DescribeDBClustersMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], ], ], 'DescribeDBEngineVersionsMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DefaultOnly' => [ 'shape' => 'Boolean', ], 'ListSupportedCharacterSets' => [ 'shape' => 'BooleanOptional', ], 'ListSupportedTimezones' => [ 'shape' => 'BooleanOptional', ], 'IncludeAll' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeDBInstanceAutomatedBackupsMessage' => [ 'type' => 'structure', 'members' => [ 'DbiResourceId' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], ], ], 'DescribeDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBLogFilesDetails' => [ 'type' => 'structure', 'members' => [ 'LogFileName' => [ 'shape' => 'String', ], 'LastWritten' => [ 'shape' => 'Long', ], 'Size' => [ 'shape' => 'Long', ], ], ], 'DescribeDBLogFilesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribeDBLogFilesDetails', 'locationName' => 'DescribeDBLogFilesDetails', ], ], 'DescribeDBLogFilesMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'FilenameContains' => [ 'shape' => 'String', ], 'FileLastWritten' => [ 'shape' => 'Long', ], 'FileSize' => [ 'shape' => 'Long', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBLogFilesResponse' => [ 'type' => 'structure', 'members' => [ 'DescribeDBLogFiles' => [ 'shape' => 'DescribeDBLogFilesList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBProxiesRequest' => [ 'type' => 'structure', 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBProxiesResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxies' => [ 'shape' => 'DBProxyList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBProxyEndpointsRequest' => [ 'type' => 'structure', 'members' => [ 'DBProxyName' => [ 'shape' => 'DBProxyName', ], 'DBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBProxyEndpointsResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpoints' => [ 'shape' => 'DBProxyEndpointList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBProxyTargetGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBProxyTargetGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'TargetGroups' => [ 'shape' => 'TargetGroupList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBProxyTargetsRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBProxyTargetsResponse' => [ 'type' => 'structure', 'members' => [ 'Targets' => [ 'shape' => 'TargetList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBRecommendationsMessage' => [ 'type' => 'structure', 'members' => [ 'LastUpdatedAfter' => [ 'shape' => 'TStamp', ], 'LastUpdatedBefore' => [ 'shape' => 'TStamp', ], 'Locale' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSecurityGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBShardGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBShardGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'DBShardGroups' => [ 'shape' => 'DBShardGroupsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotAttributesResult' => [ 'shape' => 'DBSnapshotAttributesResult', ], ], ], 'DescribeDBSnapshotTenantDatabasesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], 'DbiResourceId' => [ 'shape' => 'String', ], ], ], 'DescribeDBSubnetGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEngineDefaultParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeEventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEventsMessage' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'IntegerOptional', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeExportTasksMessage' => [ 'type' => 'structure', 'members' => [ 'ExportTaskIdentifier' => [ 'shape' => 'String', ], 'SourceArn' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], 'SourceType' => [ 'shape' => 'ExportSourceType', ], ], ], 'DescribeGlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeIntegrationsMessage' => [ 'type' => 'structure', 'members' => [ 'IntegrationIdentifier' => [ 'shape' => 'IntegrationIdentifier', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'DescribeIntegrationsResponse' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'Marker', ], 'Integrations' => [ 'shape' => 'IntegrationList', ], ], ], 'DescribeOptionGroupOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'EngineName', ], 'members' => [ 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeOptionGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], ], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', ], 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'AvailabilityZoneGroup' => [ 'shape' => 'String', ], 'Vpc' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribePendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], ], ], 'DescribeReservedDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'LeaseId' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeReservedDBInstancesOfferingsMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeSourceRegionsMessage' => [ 'type' => 'structure', 'members' => [ 'RegionName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeTenantDatabasesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], ], ], 'DescribeValidDBInstanceModificationsMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeValidDBInstanceModificationsResult' => [ 'type' => 'structure', 'members' => [ 'ValidDBInstanceModificationsMessage' => [ 'shape' => 'ValidDBInstanceModificationsMessage', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '.*', ], 'DisableHttpEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], ], ], 'DisableHttpEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'HttpEndpointEnabled' => [ 'shape' => 'Boolean', ], ], ], 'DocLink' => [ 'type' => 'structure', 'members' => [ 'Text' => [ 'shape' => 'String', ], 'Url' => [ 'shape' => 'String', ], ], ], 'DocLinkList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DocLink', ], ], 'DomainMembership' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'FQDN' => [ 'shape' => 'String', ], 'IAMRoleName' => [ 'shape' => 'String', ], 'OU' => [ 'shape' => 'String', ], 'AuthSecretArn' => [ 'shape' => 'String', ], 'DnsIps' => [ 'shape' => 'StringList', ], ], ], 'DomainMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainMembership', 'locationName' => 'DomainMembership', ], ], 'DomainNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DomainNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'Double' => [ 'type' => 'double', ], 'DoubleOptional' => [ 'type' => 'double', ], 'DoubleRange' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'Double', ], 'To' => [ 'shape' => 'Double', ], ], ], 'DoubleRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DoubleRange', 'locationName' => 'DoubleRange', ], ], 'DownloadDBLogFilePortionDetails' => [ 'type' => 'structure', 'members' => [ 'LogFileData' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'AdditionalDataPending' => [ 'shape' => 'Boolean', ], ], ], 'DownloadDBLogFilePortionMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'LogFileName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'LogFileName' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'NumberOfLines' => [ 'shape' => 'Integer', ], ], ], 'EC2SecurityGroup' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'EC2SecurityGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2SecurityGroup', 'locationName' => 'EC2SecurityGroup', ], ], 'Ec2ImagePropertiesNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'Ec2ImagePropertiesNotSupportedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EnableHttpEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], ], ], 'EnableHttpEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'HttpEndpointEnabled' => [ 'shape' => 'Boolean', ], ], ], 'EncryptionContextMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'HostedZoneId' => [ 'shape' => 'String', ], ], ], 'EngineDefaults' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], 'wrapper' => true, ], 'EngineFamily' => [ 'type' => 'string', 'enum' => [ 'MYSQL', 'POSTGRESQL', 'SQLSERVER', ], ], 'EngineModeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Event' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Message' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Date' => [ 'shape' => 'TStamp', ], 'SourceArn' => [ 'shape' => 'String', ], ], ], 'EventCategoriesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'EventCategory', ], ], 'EventCategoriesMap' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], ], 'wrapper' => true, ], 'EventCategoriesMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventCategoriesMap', 'locationName' => 'EventCategoriesMap', ], ], 'EventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'EventCategoriesMapList' => [ 'shape' => 'EventCategoriesMapList', ], ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', 'locationName' => 'Event', ], ], 'EventSubscription' => [ 'type' => 'structure', 'members' => [ 'CustomerAwsId' => [ 'shape' => 'String', ], 'CustSubscriptionId' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'SubscriptionCreationTime' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'SourceIdsList' => [ 'shape' => 'SourceIdsList', ], 'EventCategoriesList' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'EventSubscriptionArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'EventSubscriptionQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'EventSubscriptionQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EventSubscriptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventSubscription', 'locationName' => 'EventSubscription', ], ], 'EventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'EventSubscriptionsList' => [ 'shape' => 'EventSubscriptionsList', ], ], ], 'EventsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Events' => [ 'shape' => 'EventList', ], ], ], 'ExportSourceType' => [ 'type' => 'string', 'enum' => [ 'SNAPSHOT', 'CLUSTER', ], ], 'ExportTask' => [ 'type' => 'structure', 'members' => [ 'ExportTaskIdentifier' => [ 'shape' => 'String', ], 'SourceArn' => [ 'shape' => 'String', ], 'ExportOnly' => [ 'shape' => 'StringList', ], 'SnapshotTime' => [ 'shape' => 'TStamp', ], 'TaskStartTime' => [ 'shape' => 'TStamp', ], 'TaskEndTime' => [ 'shape' => 'TStamp', ], 'S3Bucket' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'IamRoleArn' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'TotalExtractedDataInGB' => [ 'shape' => 'Integer', ], 'FailureCause' => [ 'shape' => 'String', ], 'WarningMessage' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'ExportSourceType', ], ], ], 'ExportTaskAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ExportTaskAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ExportTaskNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ExportTaskNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ExportTasksList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportTask', 'locationName' => 'ExportTask', ], ], 'ExportTasksMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ExportTasks' => [ 'shape' => 'ExportTasksList', ], ], ], 'FailoverDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'FailoverDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'FailoverGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', 'TargetDbClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'TargetDbClusterIdentifier' => [ 'shape' => 'DBClusterIdentifier', ], 'AllowDataLoss' => [ 'shape' => 'BooleanOptional', ], 'Switchover' => [ 'shape' => 'BooleanOptional', ], ], ], 'FailoverGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'FailoverState' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FailoverStatus', ], 'FromDbClusterArn' => [ 'shape' => 'String', ], 'ToDbClusterArn' => [ 'shape' => 'String', ], 'IsDataLossAllowed' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'FailoverStatus' => [ 'type' => 'string', 'enum' => [ 'pending', 'failing-over', 'cancelling', ], ], 'FeatureNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', 'locationName' => 'Filter', ], ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'Value', ], ], 'GlobalCluster' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'GlobalClusterResourceId' => [ 'shape' => 'String', ], 'GlobalClusterArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterMembers' => [ 'shape' => 'GlobalClusterMemberList', ], 'FailoverState' => [ 'shape' => 'FailoverState', ], ], 'wrapper' => true, ], 'GlobalClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z][0-9A-Za-z-:._]*', ], 'GlobalClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalCluster', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBClusterArn' => [ 'shape' => 'String', ], 'Readers' => [ 'shape' => 'ReadersArnList', ], 'IsWriter' => [ 'shape' => 'Boolean', ], 'GlobalWriteForwardingStatus' => [ 'shape' => 'WriteForwardingStatus', ], 'SynchronizationStatus' => [ 'shape' => 'GlobalClusterMemberSynchronizationStatus', ], ], 'wrapper' => true, ], 'GlobalClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalClusterMember', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterMemberSynchronizationStatus' => [ 'type' => 'string', 'enum' => [ 'connected', 'pending-resync', ], ], 'GlobalClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'GlobalClusters' => [ 'shape' => 'GlobalClusterList', ], ], ], 'IAMAuthMode' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'REQUIRED', 'ENABLED', ], ], 'IPRange' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], ], ], 'IPRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPRange', 'locationName' => 'IPRange', ], ], 'IamRoleMissingPermissionsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IamRoleMissingPermissions', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IamRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IamRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'InstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientAvailableIPsInSubnetFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientAvailableIPsInSubnetFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBClusterCapacityFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBInstanceCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBInstanceCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientStorageClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientStorageClusterCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerOptional' => [ 'type' => 'integer', ], 'Integration' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'SourceArn', ], 'TargetArn' => [ 'shape' => 'Arn', ], 'IntegrationName' => [ 'shape' => 'IntegrationName', ], 'IntegrationArn' => [ 'shape' => 'IntegrationArn', ], 'KMSKeyId' => [ 'shape' => 'String', ], 'AdditionalEncryptionContext' => [ 'shape' => 'EncryptionContextMap', ], 'Status' => [ 'shape' => 'IntegrationStatus', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'Errors' => [ 'shape' => 'IntegrationErrorList', ], 'DataFilter' => [ 'shape' => 'DataFilter', ], 'Description' => [ 'shape' => 'IntegrationDescription', ], ], ], 'IntegrationAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IntegrationAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IntegrationArn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:rds(-[a-z]*)?:[a-z0-9\\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}', ], 'IntegrationConflictOperationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IntegrationConflictOperationFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IntegrationDescription' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '.*', ], 'IntegrationError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'IntegrationErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegrationError', 'locationName' => 'IntegrationError', ], ], 'IntegrationIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[a-zA-Z0-9_:\\-\\/]+', ], 'IntegrationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Integration', 'locationName' => 'Integration', ], ], 'IntegrationName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'IntegrationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IntegrationNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'IntegrationQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IntegrationQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IntegrationStatus' => [ 'type' => 'string', 'enum' => [ 'creating', 'active', 'modifying', 'failed', 'deleting', 'syncing', 'needs_attention', ], ], 'InvalidBlueGreenDeploymentStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidBlueGreenDeploymentStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCustomDBEngineVersionStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCustomDBEngineVersionStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterAutomatedBackupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterAutomatedBackupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterCapacityFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterEndpointStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterEndpointStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterSnapshotStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceAutomatedBackupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceAutomatedBackupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBParameterGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBParameterGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBProxyEndpointStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBProxyEndpointStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBProxyStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBProxyStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSecurityGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSecurityGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBShardGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBShardGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSnapshotState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidEventSubscriptionStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidEventSubscriptionState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidExportOnlyFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidExportOnly', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidExportSourceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidExportSourceState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidExportTaskStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidExportTaskStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidGlobalClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidGlobalClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidIntegrationStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidIntegrationStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidMaxAcuFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidMaxAcu', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidOptionGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidOptionGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidResourceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidResourceStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidRestoreFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidRestoreFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidS3BucketFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidS3BucketFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSubnet' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSubnet', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidVPCNetworkStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidVPCNetworkStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IssueDetails' => [ 'type' => 'structure', 'members' => [ 'PerformanceIssueDetails' => [ 'shape' => 'PerformanceIssueDetails', ], ], ], 'KMSKeyNotAccessibleFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'KMSKeyNotAccessibleFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'KmsKeyIdOrArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[a-zA-Z0-9_:\\-\\/]+', ], 'LimitlessDatabase' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'LimitlessDatabaseStatus', ], 'MinRequiredACU' => [ 'shape' => 'DoubleOptional', ], ], ], 'LimitlessDatabaseStatus' => [ 'type' => 'string', 'enum' => [ 'active', 'not-in-use', 'enabled', 'disabled', 'enabling', 'disabling', 'modifying-max-capacity', 'error', ], ], 'ListTagsForResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'LocalWriteForwardingStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', 'enabling', 'disabling', 'requested', ], ], 'LogTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Long' => [ 'type' => 'long', ], 'LongOptional' => [ 'type' => 'long', ], 'Marker' => [ 'type' => 'string', 'max' => 340, 'min' => 1, ], 'MasterUserSecret' => [ 'type' => 'structure', 'members' => [ 'SecretArn' => [ 'shape' => 'String', ], 'SecretStatus' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], ], ], 'MaxDBShardGroupLimitReached' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'MaxDBShardGroupLimitReached', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'MaxRecords' => [ 'type' => 'integer', 'max' => 100, 'min' => 20, ], 'Metric' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'References' => [ 'shape' => 'MetricReferenceList', ], 'StatisticsDetails' => [ 'shape' => 'String', ], 'MetricQuery' => [ 'shape' => 'MetricQuery', ], ], ], 'MetricList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Metric', ], ], 'MetricQuery' => [ 'type' => 'structure', 'members' => [ 'PerformanceInsightsMetricQuery' => [ 'shape' => 'PerformanceInsightsMetricQuery', ], ], ], 'MetricReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'ReferenceDetails' => [ 'shape' => 'ReferenceDetails', ], ], ], 'MetricReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricReference', ], ], 'MinimumEngineVersionPerAllowedValue' => [ 'type' => 'structure', 'members' => [ 'AllowedValue' => [ 'shape' => 'String', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], ], ], 'MinimumEngineVersionPerAllowedValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MinimumEngineVersionPerAllowedValue', 'locationName' => 'MinimumEngineVersionPerAllowedValue', ], ], 'ModifyActivityStreamRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'AuditPolicyState' => [ 'shape' => 'AuditPolicyState', ], ], ], 'ModifyActivityStreamResponse' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'String', ], 'KinesisStreamName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ActivityStreamStatus', ], 'Mode' => [ 'shape' => 'ActivityStreamMode', ], 'EngineNativeAuditFieldsIncluded' => [ 'shape' => 'BooleanOptional', ], 'PolicyStatus' => [ 'shape' => 'ActivityStreamPolicyStatus', ], ], ], 'ModifyCertificatesMessage' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'RemoveCustomerOverride' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyCertificatesResult' => [ 'type' => 'structure', 'members' => [ 'Certificate' => [ 'shape' => 'Certificate', ], ], ], 'ModifyCurrentDBClusterCapacityMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Capacity' => [ 'shape' => 'IntegerOptional', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], ], ], 'ModifyCustomDBEngineVersionMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', 'EngineVersion', ], 'members' => [ 'Engine' => [ 'shape' => 'CustomEngineName', ], 'EngineVersion' => [ 'shape' => 'CustomEngineVersion', ], 'Description' => [ 'shape' => 'Description', ], 'Status' => [ 'shape' => 'CustomEngineVersionStatus', ], ], ], 'ModifyDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterEndpointIdentifier', ], 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], ], ], 'ModifyDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'NewDBClusterIdentifier' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'DBInstanceParameterGroupName' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'EnableHttpEndpoint' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'EnableGlobalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'RotateMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'EngineMode' => [ 'shape' => 'String', ], 'AllowEngineModeChange' => [ 'shape' => 'Boolean', ], 'EnableLocalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'AwsBackupRecoveryPointArn', ], 'EnableLimitlessDatabase' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'ModifyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'Parameters', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'ModifyDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'NewDBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'DBPortNumber' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'DisableDomain' => [ 'shape' => 'BooleanOptional', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'CertificateRotationRestart' => [ 'shape' => 'BooleanOptional', ], 'ReplicaMode' => [ 'shape' => 'ReplicaMode', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'AwsBackupRecoveryPointArn', ], 'AutomationMode' => [ 'shape' => 'AutomationMode', ], 'ResumeFullAutomationModeMinutes' => [ 'shape' => 'IntegerOptional', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'RotateMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ModifyDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', 'Parameters', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBProxyEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyEndpointName', ], 'members' => [ 'DBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], 'NewDBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'ModifyDBProxyEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpoint' => [ 'shape' => 'DBProxyEndpoint', ], ], ], 'ModifyDBProxyRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'NewDBProxyName' => [ 'shape' => 'String', ], 'Auth' => [ 'shape' => 'UserAuthConfigList', ], 'RequireTLS' => [ 'shape' => 'BooleanOptional', ], 'IdleClientTimeout' => [ 'shape' => 'IntegerOptional', ], 'DebugLogging' => [ 'shape' => 'BooleanOptional', ], 'RoleArn' => [ 'shape' => 'String', ], 'SecurityGroups' => [ 'shape' => 'StringList', ], ], ], 'ModifyDBProxyResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxy' => [ 'shape' => 'DBProxy', ], ], ], 'ModifyDBProxyTargetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'TargetGroupName', 'DBProxyName', ], 'members' => [ 'TargetGroupName' => [ 'shape' => 'String', ], 'DBProxyName' => [ 'shape' => 'String', ], 'ConnectionPoolConfig' => [ 'shape' => 'ConnectionPoolConfiguration', ], 'NewName' => [ 'shape' => 'String', ], ], ], 'ModifyDBProxyTargetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyTargetGroup' => [ 'shape' => 'DBProxyTargetGroup', ], ], ], 'ModifyDBRecommendationMessage' => [ 'type' => 'structure', 'required' => [ 'RecommendationId', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'Locale' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'RecommendedActionUpdates' => [ 'shape' => 'RecommendedActionUpdateList', ], ], ], 'ModifyDBShardGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBShardGroupIdentifier', ], 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], 'MaxACU' => [ 'shape' => 'DoubleOptional', ], ], ], 'ModifyDBSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotAttributesResult' => [ 'shape' => 'DBSnapshotAttributesResult', ], ], ], 'ModifyDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'ModifyDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'ModifyDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], ], ], 'ModifyDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'ModifyEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'ModifyGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'NewGlobalClusterIdentifier' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'ModifyIntegrationMessage' => [ 'type' => 'structure', 'required' => [ 'IntegrationIdentifier', ], 'members' => [ 'IntegrationIdentifier' => [ 'shape' => 'IntegrationIdentifier', ], 'IntegrationName' => [ 'shape' => 'IntegrationName', ], 'DataFilter' => [ 'shape' => 'DataFilter', ], 'Description' => [ 'shape' => 'IntegrationDescription', ], ], ], 'ModifyOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'OptionsToInclude' => [ 'shape' => 'OptionConfigurationList', ], 'OptionsToRemove' => [ 'shape' => 'OptionNamesList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'ModifyOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'ModifyTenantDatabaseMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'TenantDBName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'SensitiveString', ], 'NewTenantDBName' => [ 'shape' => 'String', ], ], ], 'ModifyTenantDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'TenantDatabase' => [ 'shape' => 'TenantDatabase', ], ], ], 'NetworkTypeNotSupported' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NetworkTypeNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Option' => [ 'type' => 'structure', 'members' => [ 'OptionName' => [ 'shape' => 'String', ], 'OptionDescription' => [ 'shape' => 'String', ], 'Persistent' => [ 'shape' => 'Boolean', ], 'Permanent' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'OptionVersion' => [ 'shape' => 'String', ], 'OptionSettings' => [ 'shape' => 'OptionSettingConfigurationList', ], 'DBSecurityGroupMemberships' => [ 'shape' => 'DBSecurityGroupMembershipList', ], 'VpcSecurityGroupMemberships' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], ], ], 'OptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'OptionName', ], 'members' => [ 'OptionName' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'OptionVersion' => [ 'shape' => 'String', ], 'DBSecurityGroupMemberships' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupMemberships' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'OptionSettings' => [ 'shape' => 'OptionSettingsList', ], ], ], 'OptionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionConfiguration', 'locationName' => 'OptionConfiguration', ], ], 'OptionGroup' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'OptionGroupDescription' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'Options' => [ 'shape' => 'OptionsList', ], 'AllowsVpcAndNonVpcInstanceMemberships' => [ 'shape' => 'Boolean', ], 'VpcId' => [ 'shape' => 'String', ], 'OptionGroupArn' => [ 'shape' => 'String', ], 'SourceOptionGroup' => [ 'shape' => 'String', ], 'SourceAccountId' => [ 'shape' => 'String', ], 'CopyTimestamp' => [ 'shape' => 'TStamp', ], ], 'wrapper' => true, ], 'OptionGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroupMembership' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'OptionGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupMembership', 'locationName' => 'OptionGroupMembership', ], ], 'OptionGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroupOption' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'MinimumRequiredMinorEngineVersion' => [ 'shape' => 'String', ], 'PortRequired' => [ 'shape' => 'Boolean', ], 'DefaultPort' => [ 'shape' => 'IntegerOptional', ], 'OptionsDependedOn' => [ 'shape' => 'OptionsDependedOn', ], 'OptionsConflictsWith' => [ 'shape' => 'OptionsConflictsWith', ], 'Persistent' => [ 'shape' => 'Boolean', ], 'Permanent' => [ 'shape' => 'Boolean', ], 'RequiresAutoMinorEngineVersionUpgrade' => [ 'shape' => 'Boolean', ], 'VpcOnly' => [ 'shape' => 'Boolean', ], 'SupportsOptionVersionDowngrade' => [ 'shape' => 'BooleanOptional', ], 'OptionGroupOptionSettings' => [ 'shape' => 'OptionGroupOptionSettingsList', ], 'OptionGroupOptionVersions' => [ 'shape' => 'OptionGroupOptionVersionsList', ], 'CopyableCrossAccount' => [ 'shape' => 'BooleanOptional', ], ], ], 'OptionGroupOptionSetting' => [ 'type' => 'structure', 'members' => [ 'SettingName' => [ 'shape' => 'String', ], 'SettingDescription' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersionPerAllowedValue' => [ 'shape' => 'MinimumEngineVersionPerAllowedValueList', ], ], ], 'OptionGroupOptionSettingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupOptionSetting', 'locationName' => 'OptionGroupOptionSetting', ], ], 'OptionGroupOptionVersionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionVersion', 'locationName' => 'OptionVersion', ], ], 'OptionGroupOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupOption', 'locationName' => 'OptionGroupOption', ], ], 'OptionGroupOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OptionGroupOptions' => [ 'shape' => 'OptionGroupOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'OptionGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroups' => [ 'type' => 'structure', 'members' => [ 'OptionGroupsList' => [ 'shape' => 'OptionGroupsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'OptionGroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroup', 'locationName' => 'OptionGroup', ], ], 'OptionNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'OptionSetting' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'IsCollection' => [ 'shape' => 'Boolean', ], ], ], 'OptionSettingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionSetting', 'locationName' => 'OptionSetting', ], ], 'OptionSettingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionSetting', 'locationName' => 'OptionSetting', ], ], 'OptionVersion' => [ 'type' => 'structure', 'members' => [ 'Version' => [ 'shape' => 'String', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'OptionsConflictsWith' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OptionConflictName', ], ], 'OptionsDependedOn' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OptionName', ], ], 'OptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Option', 'locationName' => 'Option', ], ], 'OrderableDBInstanceOption' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'AvailabilityZoneGroup' => [ 'shape' => 'String', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'MultiAZCapable' => [ 'shape' => 'Boolean', ], 'ReadReplicaCapable' => [ 'shape' => 'Boolean', ], 'Vpc' => [ 'shape' => 'Boolean', ], 'SupportsStorageEncryption' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], 'SupportsIops' => [ 'shape' => 'Boolean', ], 'SupportsEnhancedMonitoring' => [ 'shape' => 'Boolean', ], 'SupportsIAMDatabaseAuthentication' => [ 'shape' => 'Boolean', ], 'SupportsPerformanceInsights' => [ 'shape' => 'Boolean', ], 'MinStorageSize' => [ 'shape' => 'IntegerOptional', ], 'MaxStorageSize' => [ 'shape' => 'IntegerOptional', ], 'MinIopsPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MaxIopsPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MinIopsPerGib' => [ 'shape' => 'DoubleOptional', ], 'MaxIopsPerGib' => [ 'shape' => 'DoubleOptional', ], 'AvailableProcessorFeatures' => [ 'shape' => 'AvailableProcessorFeatureList', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], 'SupportsStorageAutoscaling' => [ 'shape' => 'BooleanOptional', ], 'SupportsKerberosAuthentication' => [ 'shape' => 'BooleanOptional', ], 'OutpostCapable' => [ 'shape' => 'Boolean', ], 'SupportedActivityStreamModes' => [ 'shape' => 'ActivityStreamModeList', ], 'SupportsGlobalDatabases' => [ 'shape' => 'Boolean', ], 'SupportsClusters' => [ 'shape' => 'Boolean', ], 'SupportedNetworkTypes' => [ 'shape' => 'StringList', ], 'SupportsStorageThroughput' => [ 'shape' => 'Boolean', ], 'MinStorageThroughputPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MaxStorageThroughputPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MinStorageThroughputPerIops' => [ 'shape' => 'DoubleOptional', ], 'MaxStorageThroughputPerIops' => [ 'shape' => 'DoubleOptional', ], 'SupportsDedicatedLogVolume' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'OrderableDBInstanceOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderableDBInstanceOption', 'locationName' => 'OrderableDBInstanceOption', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OrderableDBInstanceOptions' => [ 'shape' => 'OrderableDBInstanceOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'Outpost' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String', ], ], ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'ApplyMethod' => [ 'shape' => 'ApplyMethod', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], ], ], 'ParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', 'locationName' => 'Parameter', ], ], 'PendingCloudwatchLogsExports' => [ 'type' => 'structure', 'members' => [ 'LogTypesToEnable' => [ 'shape' => 'LogTypeList', ], 'LogTypesToDisable' => [ 'shape' => 'LogTypeList', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'String', ], 'AutoAppliedAfterDate' => [ 'shape' => 'TStamp', ], 'ForcedApplyDate' => [ 'shape' => 'TStamp', ], 'OptInStatus' => [ 'shape' => 'String', ], 'CurrentApplyDate' => [ 'shape' => 'TStamp', ], 'Description' => [ 'shape' => 'String', ], ], ], 'PendingMaintenanceActionDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', 'locationName' => 'PendingMaintenanceAction', ], ], 'PendingMaintenanceActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePendingMaintenanceActions', 'locationName' => 'ResourcePendingMaintenanceActions', ], ], 'PendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'PendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActions', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'PendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'DBInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PendingCloudwatchLogsExports' => [ 'shape' => 'PendingCloudwatchLogsExports', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'BooleanOptional', ], 'AutomationMode' => [ 'shape' => 'AutomationMode', ], 'ResumeFullAutomationModeTime' => [ 'shape' => 'TStamp', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'Engine' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], ], 'PerformanceInsightsMetricDimensionGroup' => [ 'type' => 'structure', 'members' => [ 'Dimensions' => [ 'shape' => 'StringList', ], 'Group' => [ 'shape' => 'String', ], 'Limit' => [ 'shape' => 'Integer', ], ], ], 'PerformanceInsightsMetricQuery' => [ 'type' => 'structure', 'members' => [ 'GroupBy' => [ 'shape' => 'PerformanceInsightsMetricDimensionGroup', ], 'Metric' => [ 'shape' => 'String', ], ], ], 'PerformanceIssueDetails' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Metrics' => [ 'shape' => 'MetricList', ], 'Analysis' => [ 'shape' => 'String', ], ], ], 'PointInTimeRestoreNotEnabledFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'PointInTimeRestoreNotEnabled', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ProcessorFeature' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'ProcessorFeatureList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessorFeature', 'locationName' => 'ProcessorFeature', ], ], 'PromoteReadReplicaDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'PromoteReadReplicaDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'PromoteReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], ], ], 'PromoteReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ProvisionedIopsNotAvailableInAZFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ProvisionedIopsNotAvailableInAZFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'PurchaseReservedDBInstancesOfferingMessage' => [ 'type' => 'structure', 'required' => [ 'ReservedDBInstancesOfferingId', ], 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'DBInstanceCount' => [ 'shape' => 'IntegerOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PurchaseReservedDBInstancesOfferingResult' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstance' => [ 'shape' => 'ReservedDBInstance', ], ], ], 'Range' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'Integer', ], 'To' => [ 'shape' => 'Integer', ], 'Step' => [ 'shape' => 'IntegerOptional', ], ], ], 'RangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Range', 'locationName' => 'Range', ], ], 'RdsCustomClusterConfiguration' => [ 'type' => 'structure', 'members' => [ 'InterconnectSubnetId' => [ 'shape' => 'String', ], 'TransitGatewayMulticastDomainId' => [ 'shape' => 'String', ], 'ReplicaMode' => [ 'shape' => 'ReplicaMode', ], ], ], 'ReadReplicaDBClusterIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaDBClusterIdentifier', ], ], 'ReadReplicaDBInstanceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaDBInstanceIdentifier', ], ], 'ReadReplicaIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaIdentifier', ], ], 'ReadersArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RebootDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'RebootDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RebootDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'ForceFailover' => [ 'shape' => 'BooleanOptional', ], ], ], 'RebootDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RebootDBShardGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBShardGroupIdentifier', ], 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], ], ], 'RecommendedAction' => [ 'type' => 'structure', 'members' => [ 'ActionId' => [ 'shape' => 'String', ], 'Title' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Operation' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'RecommendedActionParameterList', ], 'ApplyModes' => [ 'shape' => 'StringList', ], 'Status' => [ 'shape' => 'String', ], 'IssueDetails' => [ 'shape' => 'IssueDetails', ], 'ContextAttributes' => [ 'shape' => 'ContextAttributeList', ], ], ], 'RecommendedActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendedAction', ], ], 'RecommendedActionParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'RecommendedActionParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendedActionParameter', ], ], 'RecommendedActionUpdate' => [ 'type' => 'structure', 'required' => [ 'ActionId', 'Status', ], 'members' => [ 'ActionId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'RecommendedActionUpdateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendedActionUpdate', ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', 'locationName' => 'RecurringCharge', ], ], 'ReferenceDetails' => [ 'type' => 'structure', 'members' => [ 'ScalarReferenceDetails' => [ 'shape' => 'ScalarReferenceDetails', ], ], ], 'RegisterDBProxyTargetsRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'DBInstanceIdentifiers' => [ 'shape' => 'StringList', ], 'DBClusterIdentifiers' => [ 'shape' => 'StringList', ], ], ], 'RegisterDBProxyTargetsResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyTargets' => [ 'shape' => 'TargetList', ], ], ], 'RemoveFromGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'DbClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveFromGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'RemoveRoleFromDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'RoleArn', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'RemoveRoleFromDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'RoleArn', 'FeatureName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'RemoveTagsFromResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'TagKeys', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'TagKeys' => [ 'shape' => 'KeyList', ], ], ], 'ReplicaMode' => [ 'type' => 'string', 'enum' => [ 'open-read-only', 'mounted', ], ], 'ReservedDBInstance' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'DBInstanceCount' => [ 'shape' => 'Integer', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'State' => [ 'shape' => 'String', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], 'ReservedDBInstanceArn' => [ 'shape' => 'String', ], 'LeaseId' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'ReservedDBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceAlreadyExists', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedDBInstance', 'locationName' => 'ReservedDBInstance', ], ], 'ReservedDBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedDBInstances' => [ 'shape' => 'ReservedDBInstanceList', ], ], ], 'ReservedDBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstancesOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], 'wrapper' => true, ], 'ReservedDBInstancesOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedDBInstancesOffering', 'locationName' => 'ReservedDBInstancesOffering', ], ], 'ReservedDBInstancesOfferingMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferings' => [ 'shape' => 'ReservedDBInstancesOfferingList', ], ], ], 'ReservedDBInstancesOfferingNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstancesOfferingNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResetDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResetDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ResourceNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourcePendingMaintenanceActions' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'PendingMaintenanceActionDetails' => [ 'shape' => 'PendingMaintenanceActionDetails', ], ], 'wrapper' => true, ], 'RestoreDBClusterFromS3Message' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', 'MasterUsername', 'SourceEngine', 'SourceEngineVersion', 'S3BucketName', 'S3IngestionRoleArn', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'SourceEngine' => [ 'shape' => 'String', ], 'SourceEngineVersion' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'S3IngestionRoleArn' => [ 'shape' => 'String', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], ], ], 'RestoreDBClusterFromS3Result' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SnapshotIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], ], ], 'RestoreDBClusterFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreType' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreToTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'EngineMode' => [ 'shape' => 'String', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'SourceDbClusterResourceId' => [ 'shape' => 'String', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], ], ], 'RestoreDBClusterToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBInstanceFromDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Domain' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'BackupTarget' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'RestoreDBInstanceFromDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreDBInstanceFromS3Message' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', 'SourceEngine', 'SourceEngineVersion', 'S3BucketName', 'S3IngestionRoleArn', ], 'members' => [ 'DBName' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'SourceEngine' => [ 'shape' => 'String', ], 'SourceEngineVersion' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'S3IngestionRoleArn' => [ 'shape' => 'String', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'RestoreDBInstanceFromS3Result' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreDBInstanceToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'TargetDBInstanceIdentifier', ], 'members' => [ 'SourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], 'RestoreTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'SourceDbiResourceId' => [ 'shape' => 'String', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'SourceDBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'BackupTarget' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'RestoreDBInstanceToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreWindow' => [ 'type' => 'structure', 'members' => [ 'EarliestTime' => [ 'shape' => 'TStamp', ], 'LatestTime' => [ 'shape' => 'TStamp', ], ], ], 'RevokeDBSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'RevokeDBSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'SNSInvalidTopicFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSInvalidTopic', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSNoAuthorizationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSNoAuthorization', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSTopicArnNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSTopicArnNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ScalarReferenceDetails' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'Double', ], ], ], 'ScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'IntegerOptional', ], 'MaxCapacity' => [ 'shape' => 'IntegerOptional', ], 'AutoPause' => [ 'shape' => 'BooleanOptional', ], 'SecondsUntilAutoPause' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], ], ], 'ScalingConfigurationInfo' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'IntegerOptional', ], 'MaxCapacity' => [ 'shape' => 'IntegerOptional', ], 'AutoPause' => [ 'shape' => 'BooleanOptional', ], 'SecondsUntilAutoPause' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], ], ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'ServerlessV2ScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'DoubleOptional', ], 'MaxCapacity' => [ 'shape' => 'DoubleOptional', ], ], ], 'ServerlessV2ScalingConfigurationInfo' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'DoubleOptional', ], 'MaxCapacity' => [ 'shape' => 'DoubleOptional', ], ], ], 'SharedSnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SharedSnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceArn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:rds(-[a-z]*)?:[a-z0-9\\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*', ], 'SourceClusterNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceClusterNotSupportedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceDatabaseNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceDatabaseNotSupportedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SourceId', ], ], 'SourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SourceRegion' => [ 'type' => 'structure', 'members' => [ 'RegionName' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'SupportsDBInstanceAutomatedBackupsReplication' => [ 'shape' => 'Boolean', ], ], ], 'SourceRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceRegion', 'locationName' => 'SourceRegion', ], ], 'SourceRegionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'SourceRegions' => [ 'shape' => 'SourceRegionList', ], ], ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'db-instance', 'db-parameter-group', 'db-security-group', 'db-snapshot', 'db-cluster', 'db-cluster-snapshot', 'custom-engine-version', 'db-proxy', 'blue-green-deployment', ], ], 'StartActivityStreamRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Mode', 'KmsKeyId', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'Mode' => [ 'shape' => 'ActivityStreamMode', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'BooleanOptional', ], 'EngineNativeAuditFieldsIncluded' => [ 'shape' => 'BooleanOptional', ], ], ], 'StartActivityStreamResponse' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'String', ], 'KinesisStreamName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ActivityStreamStatus', ], 'Mode' => [ 'shape' => 'ActivityStreamMode', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'EngineNativeAuditFieldsIncluded' => [ 'shape' => 'BooleanOptional', ], ], ], 'StartDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StartDBInstanceAutomatedBackupsReplicationMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBInstanceArn', ], 'members' => [ 'SourceDBInstanceArn' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], ], ], 'StartDBInstanceAutomatedBackupsReplicationResult' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackup' => [ 'shape' => 'DBInstanceAutomatedBackup', ], ], ], 'StartDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'StartExportTaskMessage' => [ 'type' => 'structure', 'required' => [ 'ExportTaskIdentifier', 'SourceArn', 'S3BucketName', 'IamRoleArn', 'KmsKeyId', ], 'members' => [ 'ExportTaskIdentifier' => [ 'shape' => 'String', ], 'SourceArn' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'IamRoleArn' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'ExportOnly' => [ 'shape' => 'StringList', ], ], ], 'StopActivityStreamRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'BooleanOptional', ], ], ], 'StopActivityStreamResponse' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'String', ], 'KinesisStreamName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ActivityStreamStatus', ], ], ], 'StopDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StopDBInstanceAutomatedBackupsReplicationMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBInstanceArn', ], 'members' => [ 'SourceDBInstanceArn' => [ 'shape' => 'String', ], ], ], 'StopDBInstanceAutomatedBackupsReplicationResult' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackup' => [ 'shape' => 'DBInstanceAutomatedBackup', ], ], ], 'StopDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'StorageQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'StorageTypeNotAvailableFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageTypeNotAvailableFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'StorageTypeNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageTypeNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'String255' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Subnet' => [ 'type' => 'structure', 'members' => [ 'SubnetIdentifier' => [ 'shape' => 'String', ], 'SubnetAvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'SubnetOutpost' => [ 'shape' => 'Outpost', ], 'SubnetStatus' => [ 'shape' => 'String', ], ], ], 'SubnetAlreadyInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetAlreadyInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetIdentifier', ], ], 'SubnetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subnet', 'locationName' => 'Subnet', ], ], 'SubscriptionAlreadyExistFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionAlreadyExist', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionCategoryNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionCategoryNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SupportedCharacterSetsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CharacterSet', 'locationName' => 'CharacterSet', ], ], 'SupportedTimezonesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Timezone', 'locationName' => 'Timezone', ], ], 'SwitchoverBlueGreenDeploymentRequest' => [ 'type' => 'structure', 'required' => [ 'BlueGreenDeploymentIdentifier', ], 'members' => [ 'BlueGreenDeploymentIdentifier' => [ 'shape' => 'BlueGreenDeploymentIdentifier', ], 'SwitchoverTimeout' => [ 'shape' => 'SwitchoverTimeout', ], ], ], 'SwitchoverBlueGreenDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeployment' => [ 'shape' => 'BlueGreenDeployment', ], ], ], 'SwitchoverDetail' => [ 'type' => 'structure', 'members' => [ 'SourceMember' => [ 'shape' => 'DatabaseArn', ], 'TargetMember' => [ 'shape' => 'DatabaseArn', ], 'Status' => [ 'shape' => 'SwitchoverDetailStatus', ], ], ], 'SwitchoverDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SwitchoverDetail', ], ], 'SwitchoverDetailStatus' => [ 'type' => 'string', ], 'SwitchoverGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', 'TargetDbClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'TargetDbClusterIdentifier' => [ 'shape' => 'DBClusterIdentifier', ], ], ], 'SwitchoverGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'SwitchoverReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'SwitchoverReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'SwitchoverTimeout' => [ 'type' => 'integer', 'min' => 30, ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'TagListMessage' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TargetDBClusterParameterGroupName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]', ], 'TargetDBInstanceClass' => [ 'type' => 'string', 'max' => 20, 'min' => 5, 'pattern' => 'db\\.[0-9a-z]{2,6}\\.[0-9a-z]{4,9}', ], 'TargetDBParameterGroupName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]', ], 'TargetEngineVersion' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[0-9A-Za-z-_.]+', ], 'TargetGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBProxyTargetGroup', ], ], 'TargetHealth' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'TargetState', ], 'Reason' => [ 'shape' => 'TargetHealthReason', ], 'Description' => [ 'shape' => 'String', ], ], ], 'TargetHealthReason' => [ 'type' => 'string', 'enum' => [ 'UNREACHABLE', 'CONNECTION_FAILED', 'AUTH_FAILURE', 'PENDING_PROXY_CAPACITY', 'INVALID_REPLICATION_STATE', ], ], 'TargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBProxyTarget', ], ], 'TargetRole' => [ 'type' => 'string', 'enum' => [ 'READ_WRITE', 'READ_ONLY', 'UNKNOWN', ], ], 'TargetState' => [ 'type' => 'string', 'enum' => [ 'REGISTERING', 'AVAILABLE', 'UNAVAILABLE', ], ], 'TargetType' => [ 'type' => 'string', 'enum' => [ 'RDS_INSTANCE', 'RDS_SERVERLESS_ENDPOINT', 'TRACKED_CLUSTER', ], ], 'TenantDatabase' => [ 'type' => 'structure', 'members' => [ 'TenantDatabaseCreateTime' => [ 'shape' => 'TStamp', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'TenantDatabaseResourceId' => [ 'shape' => 'String', ], 'TenantDatabaseARN' => [ 'shape' => 'String', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'PendingModifiedValues' => [ 'shape' => 'TenantDatabasePendingModifiedValues', ], 'TagList' => [ 'shape' => 'TagList', ], ], 'wrapper' => true, ], 'TenantDatabaseAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TenantDatabaseAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'TenantDatabaseNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TenantDatabaseNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'TenantDatabasePendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'MasterUserPassword' => [ 'shape' => 'SensitiveString', ], 'TenantDBName' => [ 'shape' => 'String', ], ], ], 'TenantDatabaseQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TenantDatabaseQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'TenantDatabasesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TenantDatabase', 'locationName' => 'TenantDatabase', ], ], 'TenantDatabasesMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'TenantDatabases' => [ 'shape' => 'TenantDatabasesList', ], ], ], 'Timezone' => [ 'type' => 'structure', 'members' => [ 'TimezoneName' => [ 'shape' => 'String', ], ], ], 'UnsupportedDBEngineVersionFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UnsupportedDBEngineVersion', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'UpgradeTarget' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'AutoUpgrade' => [ 'shape' => 'Boolean', ], 'IsMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], 'SupportsParallelQuery' => [ 'shape' => 'BooleanOptional', ], 'SupportsGlobalDatabases' => [ 'shape' => 'BooleanOptional', ], 'SupportsBabelfish' => [ 'shape' => 'BooleanOptional', ], 'SupportsLimitlessDatabase' => [ 'shape' => 'BooleanOptional', ], 'SupportsLocalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'SupportsIntegrations' => [ 'shape' => 'BooleanOptional', ], ], ], 'UserAuthConfig' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'String', ], 'UserName' => [ 'shape' => 'String', ], 'AuthScheme' => [ 'shape' => 'AuthScheme', ], 'SecretArn' => [ 'shape' => 'String', ], 'IAMAuth' => [ 'shape' => 'IAMAuthMode', ], 'ClientPasswordAuthType' => [ 'shape' => 'ClientPasswordAuthType', ], ], ], 'UserAuthConfigInfo' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'String', ], 'UserName' => [ 'shape' => 'String', ], 'AuthScheme' => [ 'shape' => 'AuthScheme', ], 'SecretArn' => [ 'shape' => 'String', ], 'IAMAuth' => [ 'shape' => 'IAMAuthMode', ], 'ClientPasswordAuthType' => [ 'shape' => 'ClientPasswordAuthType', ], ], ], 'UserAuthConfigInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserAuthConfigInfo', ], ], 'UserAuthConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserAuthConfig', ], ], 'ValidDBInstanceModificationsMessage' => [ 'type' => 'structure', 'members' => [ 'Storage' => [ 'shape' => 'ValidStorageOptionsList', ], 'ValidProcessorFeatures' => [ 'shape' => 'AvailableProcessorFeatureList', ], 'SupportsDedicatedLogVolume' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'ValidStorageOptions' => [ 'type' => 'structure', 'members' => [ 'StorageType' => [ 'shape' => 'String', ], 'StorageSize' => [ 'shape' => 'RangeList', ], 'ProvisionedIops' => [ 'shape' => 'RangeList', ], 'IopsToStorageRatio' => [ 'shape' => 'DoubleRangeList', ], 'SupportsStorageAutoscaling' => [ 'shape' => 'Boolean', ], 'ProvisionedStorageThroughput' => [ 'shape' => 'RangeList', ], 'StorageThroughputToIopsRatio' => [ 'shape' => 'DoubleRangeList', ], ], ], 'ValidStorageOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidStorageOptions', 'locationName' => 'ValidStorageOptions', ], ], 'ValidUpgradeTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeTarget', 'locationName' => 'UpgradeTarget', ], ], 'VpcSecurityGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'VpcSecurityGroupId', ], ], 'VpcSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'VpcSecurityGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'VpcSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcSecurityGroupMembership', 'locationName' => 'VpcSecurityGroupMembership', ], ], 'WriteForwardingStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', 'enabling', 'disabling', 'unknown', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2014-10-31', 'endpointPrefix' => 'rds', 'protocol' => 'query', 'protocols' => [ 'query', ], 'serviceAbbreviation' => 'Amazon RDS', 'serviceFullName' => 'Amazon Relational Database Service', 'serviceId' => 'RDS', 'signatureVersion' => 'v4', 'uid' => 'rds-2014-10-31', 'xmlNamespace' => 'http://rds.amazonaws.com/doc/2014-10-31/', ], 'operations' => [ 'AddRoleToDBCluster' => [ 'name' => 'AddRoleToDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddRoleToDBClusterMessage', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterRoleAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterRoleQuotaExceededFault', ], ], ], 'AddRoleToDBInstance' => [ 'name' => 'AddRoleToDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddRoleToDBInstanceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBInstanceRoleAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceRoleQuotaExceededFault', ], ], ], 'AddSourceIdentifierToSubscription' => [ 'name' => 'AddSourceIdentifierToSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddSourceIdentifierToSubscriptionMessage', ], 'output' => [ 'shape' => 'AddSourceIdentifierToSubscriptionResult', 'resultWrapper' => 'AddSourceIdentifierToSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'AddTagsToResource' => [ 'name' => 'AddTagsToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsToResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'DBSnapshotTenantDatabaseNotFoundFault', ], ], ], 'ApplyPendingMaintenanceAction' => [ 'name' => 'ApplyPendingMaintenanceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ApplyPendingMaintenanceActionMessage', ], 'output' => [ 'shape' => 'ApplyPendingMaintenanceActionResult', 'resultWrapper' => 'ApplyPendingMaintenanceActionResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'AuthorizeDBSecurityGroupIngress' => [ 'name' => 'AuthorizeDBSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AuthorizeDBSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'AuthorizeDBSecurityGroupIngressResult', 'resultWrapper' => 'AuthorizeDBSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'AuthorizationAlreadyExistsFault', ], [ 'shape' => 'AuthorizationQuotaExceededFault', ], ], ], 'BacktrackDBCluster' => [ 'name' => 'BacktrackDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BacktrackDBClusterMessage', ], 'output' => [ 'shape' => 'DBClusterBacktrack', 'resultWrapper' => 'BacktrackDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'CancelExportTask' => [ 'name' => 'CancelExportTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CancelExportTaskMessage', ], 'output' => [ 'shape' => 'ExportTask', 'resultWrapper' => 'CancelExportTaskResult', ], 'errors' => [ [ 'shape' => 'ExportTaskNotFoundFault', ], [ 'shape' => 'InvalidExportTaskStateFault', ], ], ], 'CopyDBClusterParameterGroup' => [ 'name' => 'CopyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBClusterParameterGroupResult', 'resultWrapper' => 'CopyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CopyDBClusterSnapshot' => [ 'name' => 'CopyDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBClusterSnapshotResult', 'resultWrapper' => 'CopyDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CopyDBParameterGroup' => [ 'name' => 'CopyDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBParameterGroupResult', 'resultWrapper' => 'CopyDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], ], ], 'CopyDBSnapshot' => [ 'name' => 'CopyDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBSnapshotResult', 'resultWrapper' => 'CopyDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'CustomAvailabilityZoneNotFoundFault', ], ], ], 'CopyOptionGroup' => [ 'name' => 'CopyOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyOptionGroupMessage', ], 'output' => [ 'shape' => 'CopyOptionGroupResult', 'resultWrapper' => 'CopyOptionGroupResult', ], 'errors' => [ [ 'shape' => 'OptionGroupAlreadyExistsFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'OptionGroupQuotaExceededFault', ], ], ], 'CreateBlueGreenDeployment' => [ 'name' => 'CreateBlueGreenDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBlueGreenDeploymentRequest', ], 'output' => [ 'shape' => 'CreateBlueGreenDeploymentResponse', 'resultWrapper' => 'CreateBlueGreenDeploymentResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'SourceDatabaseNotSupportedFault', ], [ 'shape' => 'SourceClusterNotSupportedFault', ], [ 'shape' => 'BlueGreenDeploymentAlreadyExistsFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'CreateCustomDBEngineVersion' => [ 'name' => 'CreateCustomDBEngineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCustomDBEngineVersionMessage', ], 'output' => [ 'shape' => 'DBEngineVersion', 'resultWrapper' => 'CreateCustomDBEngineVersionResult', ], 'errors' => [ [ 'shape' => 'CustomDBEngineVersionAlreadyExistsFault', ], [ 'shape' => 'CustomDBEngineVersionQuotaExceededFault', ], [ 'shape' => 'Ec2ImagePropertiesNotSupportedFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'CreateCustomDBEngineVersionFault', ], ], ], 'CreateDBCluster' => [ 'name' => 'CreateDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterMessage', ], 'output' => [ 'shape' => 'CreateDBClusterResult', 'resultWrapper' => 'CreateDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'CreateDBClusterEndpoint' => [ 'name' => 'CreateDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'CreateDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'DBClusterEndpointQuotaExceededFault', ], [ 'shape' => 'DBClusterEndpointAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'CreateDBClusterParameterGroup' => [ 'name' => 'CreateDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBClusterParameterGroupResult', 'resultWrapper' => 'CreateDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBClusterSnapshot' => [ 'name' => 'CreateDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBClusterSnapshotResult', 'resultWrapper' => 'CreateDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'CreateDBInstance' => [ 'name' => 'CreateDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceResult', 'resultWrapper' => 'CreateDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'CertificateNotFoundFault', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], ], ], 'CreateDBInstanceReadReplica' => [ 'name' => 'CreateDBInstanceReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceReadReplicaMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceReadReplicaResult', 'resultWrapper' => 'CreateDBInstanceReadReplicaResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotAllowedFault', ], [ 'shape' => 'InvalidDBSubnetGroupFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'CreateDBParameterGroup' => [ 'name' => 'CreateDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBParameterGroupResult', 'resultWrapper' => 'CreateDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBProxy' => [ 'name' => 'CreateDBProxy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBProxyRequest', ], 'output' => [ 'shape' => 'CreateDBProxyResponse', 'resultWrapper' => 'CreateDBProxyResult', ], 'errors' => [ [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBProxyAlreadyExistsFault', ], [ 'shape' => 'DBProxyQuotaExceededFault', ], ], ], 'CreateDBProxyEndpoint' => [ 'name' => 'CreateDBProxyEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBProxyEndpointRequest', ], 'output' => [ 'shape' => 'CreateDBProxyEndpointResponse', 'resultWrapper' => 'CreateDBProxyEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyEndpointAlreadyExistsFault', ], [ 'shape' => 'DBProxyEndpointQuotaExceededFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'CreateDBSecurityGroup' => [ 'name' => 'CreateDBSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSecurityGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSecurityGroupResult', 'resultWrapper' => 'CreateDBSecurityGroupResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupAlreadyExistsFault', ], [ 'shape' => 'DBSecurityGroupQuotaExceededFault', ], [ 'shape' => 'DBSecurityGroupNotSupportedFault', ], ], ], 'CreateDBShardGroup' => [ 'name' => 'CreateDBShardGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBShardGroupMessage', ], 'output' => [ 'shape' => 'DBShardGroup', 'resultWrapper' => 'CreateDBShardGroupResult', ], 'errors' => [ [ 'shape' => 'DBShardGroupAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'MaxDBShardGroupLimitReached', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidMaxAcuFault', ], [ 'shape' => 'UnsupportedDBEngineVersionFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], ], ], 'CreateDBSnapshot' => [ 'name' => 'CreateDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBSnapshotResult', 'resultWrapper' => 'CreateDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], ], ], 'CreateDBSubnetGroup' => [ 'name' => 'CreateDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSubnetGroupResult', 'resultWrapper' => 'CreateDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupAlreadyExistsFault', ], [ 'shape' => 'DBSubnetGroupQuotaExceededFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'CreateEventSubscription' => [ 'name' => 'CreateEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventSubscriptionMessage', ], 'output' => [ 'shape' => 'CreateEventSubscriptionResult', 'resultWrapper' => 'CreateEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionAlreadyExistFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'CreateGlobalCluster' => [ 'name' => 'CreateGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGlobalClusterMessage', ], 'output' => [ 'shape' => 'CreateGlobalClusterResult', 'resultWrapper' => 'CreateGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterAlreadyExistsFault', ], [ 'shape' => 'GlobalClusterQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'CreateIntegration' => [ 'name' => 'CreateIntegration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateIntegrationMessage', ], 'output' => [ 'shape' => 'Integration', 'resultWrapper' => 'CreateIntegrationResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'IntegrationAlreadyExistsFault', ], [ 'shape' => 'IntegrationQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'IntegrationConflictOperationFault', ], ], ], 'CreateOptionGroup' => [ 'name' => 'CreateOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOptionGroupMessage', ], 'output' => [ 'shape' => 'CreateOptionGroupResult', 'resultWrapper' => 'CreateOptionGroupResult', ], 'errors' => [ [ 'shape' => 'OptionGroupAlreadyExistsFault', ], [ 'shape' => 'OptionGroupQuotaExceededFault', ], ], ], 'CreateTenantDatabase' => [ 'name' => 'CreateTenantDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTenantDatabaseMessage', ], 'output' => [ 'shape' => 'CreateTenantDatabaseResult', 'resultWrapper' => 'CreateTenantDatabaseResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'TenantDatabaseAlreadyExistsFault', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], ], ], 'DeleteBlueGreenDeployment' => [ 'name' => 'DeleteBlueGreenDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBlueGreenDeploymentRequest', ], 'output' => [ 'shape' => 'DeleteBlueGreenDeploymentResponse', 'resultWrapper' => 'DeleteBlueGreenDeploymentResult', ], 'errors' => [ [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'InvalidBlueGreenDeploymentStateFault', ], ], ], 'DeleteCustomDBEngineVersion' => [ 'name' => 'DeleteCustomDBEngineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCustomDBEngineVersionMessage', ], 'output' => [ 'shape' => 'DBEngineVersion', 'resultWrapper' => 'DeleteCustomDBEngineVersionResult', ], 'errors' => [ [ 'shape' => 'CustomDBEngineVersionNotFoundFault', ], [ 'shape' => 'InvalidCustomDBEngineVersionStateFault', ], ], ], 'DeleteDBCluster' => [ 'name' => 'DeleteDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterResult', 'resultWrapper' => 'DeleteDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'DBClusterAutomatedBackupQuotaExceededFault', ], ], ], 'DeleteDBClusterAutomatedBackup' => [ 'name' => 'DeleteDBClusterAutomatedBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterAutomatedBackupMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterAutomatedBackupResult', 'resultWrapper' => 'DeleteDBClusterAutomatedBackupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterAutomatedBackupStateFault', ], [ 'shape' => 'DBClusterAutomatedBackupNotFoundFault', ], ], ], 'DeleteDBClusterEndpoint' => [ 'name' => 'DeleteDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'DeleteDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterEndpointStateFault', ], [ 'shape' => 'DBClusterEndpointNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'DeleteDBClusterParameterGroup' => [ 'name' => 'DeleteDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBClusterSnapshot' => [ 'name' => 'DeleteDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterSnapshotResult', 'resultWrapper' => 'DeleteDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DeleteDBInstance' => [ 'name' => 'DeleteDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceResult', 'resultWrapper' => 'DeleteDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBInstanceAutomatedBackupQuotaExceededFault', ], ], ], 'DeleteDBInstanceAutomatedBackup' => [ 'name' => 'DeleteDBInstanceAutomatedBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceAutomatedBackupMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceAutomatedBackupResult', 'resultWrapper' => 'DeleteDBInstanceAutomatedBackupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceAutomatedBackupStateFault', ], [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'DeleteDBParameterGroup' => [ 'name' => 'DeleteDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBProxy' => [ 'name' => 'DeleteDBProxy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBProxyRequest', ], 'output' => [ 'shape' => 'DeleteDBProxyResponse', 'resultWrapper' => 'DeleteDBProxyResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'DeleteDBProxyEndpoint' => [ 'name' => 'DeleteDBProxyEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBProxyEndpointRequest', ], 'output' => [ 'shape' => 'DeleteDBProxyEndpointResponse', 'resultWrapper' => 'DeleteDBProxyEndpointResult', ], 'errors' => [ [ 'shape' => 'DBProxyEndpointNotFoundFault', ], [ 'shape' => 'InvalidDBProxyEndpointStateFault', ], ], ], 'DeleteDBSecurityGroup' => [ 'name' => 'DeleteDBSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSecurityGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], ], ], 'DeleteDBShardGroup' => [ 'name' => 'DeleteDBShardGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBShardGroupMessage', ], 'output' => [ 'shape' => 'DBShardGroup', 'resultWrapper' => 'DeleteDBShardGroupResult', ], 'errors' => [ [ 'shape' => 'DBShardGroupNotFoundFault', ], [ 'shape' => 'InvalidDBShardGroupStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'DeleteDBSnapshot' => [ 'name' => 'DeleteDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBSnapshotResult', 'resultWrapper' => 'DeleteDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DeleteDBSubnetGroup' => [ 'name' => 'DeleteDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSubnetGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidDBSubnetStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DeleteEventSubscription' => [ 'name' => 'DeleteEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventSubscriptionMessage', ], 'output' => [ 'shape' => 'DeleteEventSubscriptionResult', 'resultWrapper' => 'DeleteEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'InvalidEventSubscriptionStateFault', ], ], ], 'DeleteGlobalCluster' => [ 'name' => 'DeleteGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGlobalClusterMessage', ], 'output' => [ 'shape' => 'DeleteGlobalClusterResult', 'resultWrapper' => 'DeleteGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'DeleteIntegration' => [ 'name' => 'DeleteIntegration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteIntegrationMessage', ], 'output' => [ 'shape' => 'Integration', 'resultWrapper' => 'DeleteIntegrationResult', ], 'errors' => [ [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'IntegrationConflictOperationFault', ], [ 'shape' => 'InvalidIntegrationStateFault', ], ], ], 'DeleteOptionGroup' => [ 'name' => 'DeleteOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOptionGroupMessage', ], 'errors' => [ [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'InvalidOptionGroupStateFault', ], ], ], 'DeleteTenantDatabase' => [ 'name' => 'DeleteTenantDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTenantDatabaseMessage', ], 'output' => [ 'shape' => 'DeleteTenantDatabaseResult', 'resultWrapper' => 'DeleteTenantDatabaseResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'DeregisterDBProxyTargets' => [ 'name' => 'DeregisterDBProxyTargets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterDBProxyTargetsRequest', ], 'output' => [ 'shape' => 'DeregisterDBProxyTargetsResponse', 'resultWrapper' => 'DeregisterDBProxyTargetsResult', ], 'errors' => [ [ 'shape' => 'DBProxyTargetNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'DescribeAccountAttributes' => [ 'name' => 'DescribeAccountAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAccountAttributesMessage', ], 'output' => [ 'shape' => 'AccountAttributesMessage', 'resultWrapper' => 'DescribeAccountAttributesResult', ], ], 'DescribeBlueGreenDeployments' => [ 'name' => 'DescribeBlueGreenDeployments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBlueGreenDeploymentsRequest', ], 'output' => [ 'shape' => 'DescribeBlueGreenDeploymentsResponse', 'resultWrapper' => 'DescribeBlueGreenDeploymentsResult', ], 'errors' => [ [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], ], ], 'DescribeCertificates' => [ 'name' => 'DescribeCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificatesMessage', ], 'output' => [ 'shape' => 'CertificateMessage', 'resultWrapper' => 'DescribeCertificatesResult', ], 'errors' => [ [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'DescribeDBClusterAutomatedBackups' => [ 'name' => 'DescribeDBClusterAutomatedBackups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterAutomatedBackupsMessage', ], 'output' => [ 'shape' => 'DBClusterAutomatedBackupMessage', 'resultWrapper' => 'DescribeDBClusterAutomatedBackupsResult', ], 'errors' => [ [ 'shape' => 'DBClusterAutomatedBackupNotFoundFault', ], ], ], 'DescribeDBClusterBacktracks' => [ 'name' => 'DescribeDBClusterBacktracks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterBacktracksMessage', ], 'output' => [ 'shape' => 'DBClusterBacktrackMessage', 'resultWrapper' => 'DescribeDBClusterBacktracksResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterBacktrackNotFoundFault', ], ], ], 'DescribeDBClusterEndpoints' => [ 'name' => 'DescribeDBClusterEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterEndpointsMessage', ], 'output' => [ 'shape' => 'DBClusterEndpointMessage', 'resultWrapper' => 'DescribeDBClusterEndpointsResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBClusterParameterGroups' => [ 'name' => 'DescribeDBClusterParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupsMessage', 'resultWrapper' => 'DescribeDBClusterParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterParameters' => [ 'name' => 'DescribeDBClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParametersMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupDetails', 'resultWrapper' => 'DescribeDBClusterParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterSnapshotAttributes' => [ 'name' => 'DescribeDBClusterSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBClusterSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusterSnapshots' => [ 'name' => 'DescribeDBClusterSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotsMessage', ], 'output' => [ 'shape' => 'DBClusterSnapshotMessage', 'resultWrapper' => 'DescribeDBClusterSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusters' => [ 'name' => 'DescribeDBClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClustersMessage', ], 'output' => [ 'shape' => 'DBClusterMessage', 'resultWrapper' => 'DescribeDBClustersResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBEngineVersions' => [ 'name' => 'DescribeDBEngineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBEngineVersionsMessage', ], 'output' => [ 'shape' => 'DBEngineVersionMessage', 'resultWrapper' => 'DescribeDBEngineVersionsResult', ], ], 'DescribeDBInstanceAutomatedBackups' => [ 'name' => 'DescribeDBInstanceAutomatedBackups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstanceAutomatedBackupsMessage', ], 'output' => [ 'shape' => 'DBInstanceAutomatedBackupMessage', 'resultWrapper' => 'DescribeDBInstanceAutomatedBackupsResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'DescribeDBInstances' => [ 'name' => 'DescribeDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstancesMessage', ], 'output' => [ 'shape' => 'DBInstanceMessage', 'resultWrapper' => 'DescribeDBInstancesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBLogFiles' => [ 'name' => 'DescribeDBLogFiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBLogFilesMessage', ], 'output' => [ 'shape' => 'DescribeDBLogFilesResponse', 'resultWrapper' => 'DescribeDBLogFilesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBParameterGroups' => [ 'name' => 'DescribeDBParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBParameterGroupsMessage', 'resultWrapper' => 'DescribeDBParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBParameters' => [ 'name' => 'DescribeDBParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBParametersMessage', ], 'output' => [ 'shape' => 'DBParameterGroupDetails', 'resultWrapper' => 'DescribeDBParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBProxies' => [ 'name' => 'DescribeDBProxies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBProxiesRequest', ], 'output' => [ 'shape' => 'DescribeDBProxiesResponse', 'resultWrapper' => 'DescribeDBProxiesResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], ], ], 'DescribeDBProxyEndpoints' => [ 'name' => 'DescribeDBProxyEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBProxyEndpointsRequest', ], 'output' => [ 'shape' => 'DescribeDBProxyEndpointsResponse', 'resultWrapper' => 'DescribeDBProxyEndpointsResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyEndpointNotFoundFault', ], ], ], 'DescribeDBProxyTargetGroups' => [ 'name' => 'DescribeDBProxyTargetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBProxyTargetGroupsRequest', ], 'output' => [ 'shape' => 'DescribeDBProxyTargetGroupsResponse', 'resultWrapper' => 'DescribeDBProxyTargetGroupsResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'DescribeDBProxyTargets' => [ 'name' => 'DescribeDBProxyTargets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBProxyTargetsRequest', ], 'output' => [ 'shape' => 'DescribeDBProxyTargetsResponse', 'resultWrapper' => 'DescribeDBProxyTargetsResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'DescribeDBRecommendations' => [ 'name' => 'DescribeDBRecommendations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBRecommendationsMessage', ], 'output' => [ 'shape' => 'DBRecommendationsMessage', 'resultWrapper' => 'DescribeDBRecommendationsResult', ], ], 'DescribeDBSecurityGroups' => [ 'name' => 'DescribeDBSecurityGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSecurityGroupsMessage', ], 'output' => [ 'shape' => 'DBSecurityGroupMessage', 'resultWrapper' => 'DescribeDBSecurityGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], ], ], 'DescribeDBShardGroups' => [ 'name' => 'DescribeDBShardGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBShardGroupsMessage', ], 'output' => [ 'shape' => 'DescribeDBShardGroupsResponse', 'resultWrapper' => 'DescribeDBShardGroupsResult', ], 'errors' => [ [ 'shape' => 'DBShardGroupNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBSnapshotAttributes' => [ 'name' => 'DescribeDBSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSnapshotTenantDatabases' => [ 'name' => 'DescribeDBSnapshotTenantDatabases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotTenantDatabasesMessage', ], 'output' => [ 'shape' => 'DBSnapshotTenantDatabasesMessage', 'resultWrapper' => 'DescribeDBSnapshotTenantDatabasesResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSnapshots' => [ 'name' => 'DescribeDBSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotsMessage', ], 'output' => [ 'shape' => 'DBSnapshotMessage', 'resultWrapper' => 'DescribeDBSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSubnetGroups' => [ 'name' => 'DescribeDBSubnetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSubnetGroupsMessage', ], 'output' => [ 'shape' => 'DBSubnetGroupMessage', 'resultWrapper' => 'DescribeDBSubnetGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DescribeEngineDefaultClusterParameters' => [ 'name' => 'DescribeEngineDefaultClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultClusterParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultClusterParametersResult', 'resultWrapper' => 'DescribeEngineDefaultClusterParametersResult', ], ], 'DescribeEngineDefaultParameters' => [ 'name' => 'DescribeEngineDefaultParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultParametersResult', 'resultWrapper' => 'DescribeEngineDefaultParametersResult', ], ], 'DescribeEventCategories' => [ 'name' => 'DescribeEventCategories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventCategoriesMessage', ], 'output' => [ 'shape' => 'EventCategoriesMessage', 'resultWrapper' => 'DescribeEventCategoriesResult', ], ], 'DescribeEventSubscriptions' => [ 'name' => 'DescribeEventSubscriptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventSubscriptionsMessage', ], 'output' => [ 'shape' => 'EventSubscriptionsMessage', 'resultWrapper' => 'DescribeEventSubscriptionsResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], ], ], 'DescribeEvents' => [ 'name' => 'DescribeEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventsMessage', ], 'output' => [ 'shape' => 'EventsMessage', 'resultWrapper' => 'DescribeEventsResult', ], ], 'DescribeExportTasks' => [ 'name' => 'DescribeExportTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExportTasksMessage', ], 'output' => [ 'shape' => 'ExportTasksMessage', 'resultWrapper' => 'DescribeExportTasksResult', ], 'errors' => [ [ 'shape' => 'ExportTaskNotFoundFault', ], ], ], 'DescribeGlobalClusters' => [ 'name' => 'DescribeGlobalClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGlobalClustersMessage', ], 'output' => [ 'shape' => 'GlobalClustersMessage', 'resultWrapper' => 'DescribeGlobalClustersResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], ], ], 'DescribeIntegrations' => [ 'name' => 'DescribeIntegrations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeIntegrationsMessage', ], 'output' => [ 'shape' => 'DescribeIntegrationsResponse', 'resultWrapper' => 'DescribeIntegrationsResult', ], 'errors' => [ [ 'shape' => 'IntegrationNotFoundFault', ], ], ], 'DescribeOptionGroupOptions' => [ 'name' => 'DescribeOptionGroupOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptionGroupOptionsMessage', ], 'output' => [ 'shape' => 'OptionGroupOptionsMessage', 'resultWrapper' => 'DescribeOptionGroupOptionsResult', ], ], 'DescribeOptionGroups' => [ 'name' => 'DescribeOptionGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptionGroupsMessage', ], 'output' => [ 'shape' => 'OptionGroups', 'resultWrapper' => 'DescribeOptionGroupsResult', ], 'errors' => [ [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'DescribeOrderableDBInstanceOptions' => [ 'name' => 'DescribeOrderableDBInstanceOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrderableDBInstanceOptionsMessage', ], 'output' => [ 'shape' => 'OrderableDBInstanceOptionsMessage', 'resultWrapper' => 'DescribeOrderableDBInstanceOptionsResult', ], ], 'DescribePendingMaintenanceActions' => [ 'name' => 'DescribePendingMaintenanceActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePendingMaintenanceActionsMessage', ], 'output' => [ 'shape' => 'PendingMaintenanceActionsMessage', 'resultWrapper' => 'DescribePendingMaintenanceActionsResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], ], ], 'DescribeReservedDBInstances' => [ 'name' => 'DescribeReservedDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedDBInstancesMessage', ], 'output' => [ 'shape' => 'ReservedDBInstanceMessage', 'resultWrapper' => 'DescribeReservedDBInstancesResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstanceNotFoundFault', ], ], ], 'DescribeReservedDBInstancesOfferings' => [ 'name' => 'DescribeReservedDBInstancesOfferings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedDBInstancesOfferingsMessage', ], 'output' => [ 'shape' => 'ReservedDBInstancesOfferingMessage', 'resultWrapper' => 'DescribeReservedDBInstancesOfferingsResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstancesOfferingNotFoundFault', ], ], ], 'DescribeSourceRegions' => [ 'name' => 'DescribeSourceRegions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSourceRegionsMessage', ], 'output' => [ 'shape' => 'SourceRegionMessage', 'resultWrapper' => 'DescribeSourceRegionsResult', ], ], 'DescribeTenantDatabases' => [ 'name' => 'DescribeTenantDatabases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTenantDatabasesMessage', ], 'output' => [ 'shape' => 'TenantDatabasesMessage', 'resultWrapper' => 'DescribeTenantDatabasesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeValidDBInstanceModifications' => [ 'name' => 'DescribeValidDBInstanceModifications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeValidDBInstanceModificationsMessage', ], 'output' => [ 'shape' => 'DescribeValidDBInstanceModificationsResult', 'resultWrapper' => 'DescribeValidDBInstanceModificationsResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'DisableHttpEndpoint' => [ 'name' => 'DisableHttpEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableHttpEndpointRequest', ], 'output' => [ 'shape' => 'DisableHttpEndpointResponse', 'resultWrapper' => 'DisableHttpEndpointResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidResourceStateFault', ], ], ], 'DownloadDBLogFilePortion' => [ 'name' => 'DownloadDBLogFilePortion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DownloadDBLogFilePortionMessage', ], 'output' => [ 'shape' => 'DownloadDBLogFilePortionDetails', 'resultWrapper' => 'DownloadDBLogFilePortionResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBLogFileNotFoundFault', ], ], ], 'EnableHttpEndpoint' => [ 'name' => 'EnableHttpEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableHttpEndpointRequest', ], 'output' => [ 'shape' => 'EnableHttpEndpointResponse', 'resultWrapper' => 'EnableHttpEndpointResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidResourceStateFault', ], ], ], 'FailoverDBCluster' => [ 'name' => 'FailoverDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverDBClusterMessage', ], 'output' => [ 'shape' => 'FailoverDBClusterResult', 'resultWrapper' => 'FailoverDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'FailoverGlobalCluster' => [ 'name' => 'FailoverGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverGlobalClusterMessage', ], 'output' => [ 'shape' => 'FailoverGlobalClusterResult', 'resultWrapper' => 'FailoverGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'DBSnapshotTenantDatabaseNotFoundFault', ], ], ], 'ModifyActivityStream' => [ 'name' => 'ModifyActivityStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyActivityStreamRequest', ], 'output' => [ 'shape' => 'ModifyActivityStreamResponse', 'resultWrapper' => 'ModifyActivityStreamResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'ModifyCertificates' => [ 'name' => 'ModifyCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCertificatesMessage', ], 'output' => [ 'shape' => 'ModifyCertificatesResult', 'resultWrapper' => 'ModifyCertificatesResult', ], 'errors' => [ [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'ModifyCurrentDBClusterCapacity' => [ 'name' => 'ModifyCurrentDBClusterCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCurrentDBClusterCapacityMessage', ], 'output' => [ 'shape' => 'DBClusterCapacityInfo', 'resultWrapper' => 'ModifyCurrentDBClusterCapacityResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterCapacityFault', ], ], ], 'ModifyCustomDBEngineVersion' => [ 'name' => 'ModifyCustomDBEngineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCustomDBEngineVersionMessage', ], 'output' => [ 'shape' => 'DBEngineVersion', 'resultWrapper' => 'ModifyCustomDBEngineVersionResult', ], 'errors' => [ [ 'shape' => 'CustomDBEngineVersionNotFoundFault', ], [ 'shape' => 'InvalidCustomDBEngineVersionStateFault', ], ], ], 'ModifyDBCluster' => [ 'name' => 'ModifyDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterResult', 'resultWrapper' => 'ModifyDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'StorageTypeNotAvailableFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'ModifyDBClusterEndpoint' => [ 'name' => 'ModifyDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'ModifyDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterEndpointStateFault', ], [ 'shape' => 'DBClusterEndpointNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ModifyDBClusterParameterGroup' => [ 'name' => 'ModifyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBClusterSnapshotAttribute' => [ 'name' => 'ModifyDBClusterSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBClusterSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBInstance' => [ 'name' => 'ModifyDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBInstanceMessage', ], 'output' => [ 'shape' => 'ModifyDBInstanceResult', 'resultWrapper' => 'ModifyDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBUpgradeDependencyFailureFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'CertificateNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], ], ], 'ModifyDBParameterGroup' => [ 'name' => 'ModifyDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBParameterGroupMessage', ], 'output' => [ 'shape' => 'DBParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBProxy' => [ 'name' => 'ModifyDBProxy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBProxyRequest', ], 'output' => [ 'shape' => 'ModifyDBProxyResponse', 'resultWrapper' => 'ModifyDBProxyResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyAlreadyExistsFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'ModifyDBProxyEndpoint' => [ 'name' => 'ModifyDBProxyEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBProxyEndpointRequest', ], 'output' => [ 'shape' => 'ModifyDBProxyEndpointResponse', 'resultWrapper' => 'ModifyDBProxyEndpointResult', ], 'errors' => [ [ 'shape' => 'DBProxyEndpointNotFoundFault', ], [ 'shape' => 'DBProxyEndpointAlreadyExistsFault', ], [ 'shape' => 'InvalidDBProxyEndpointStateFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'ModifyDBProxyTargetGroup' => [ 'name' => 'ModifyDBProxyTargetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBProxyTargetGroupRequest', ], 'output' => [ 'shape' => 'ModifyDBProxyTargetGroupResponse', 'resultWrapper' => 'ModifyDBProxyTargetGroupResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], ], ], 'ModifyDBRecommendation' => [ 'name' => 'ModifyDBRecommendation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBRecommendationMessage', ], 'output' => [ 'shape' => 'DBRecommendationMessage', 'resultWrapper' => 'ModifyDBRecommendationResult', ], 'errors' => [], ], 'ModifyDBShardGroup' => [ 'name' => 'ModifyDBShardGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBShardGroupMessage', ], 'output' => [ 'shape' => 'DBShardGroup', 'resultWrapper' => 'ModifyDBShardGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBShardGroupAlreadyExistsFault', ], [ 'shape' => 'DBShardGroupNotFoundFault', ], [ 'shape' => 'InvalidMaxAcuFault', ], ], ], 'ModifyDBSnapshot' => [ 'name' => 'ModifyDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSnapshotMessage', ], 'output' => [ 'shape' => 'ModifyDBSnapshotResult', 'resultWrapper' => 'ModifyDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'ModifyDBSnapshotAttribute' => [ 'name' => 'ModifyDBSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBSubnetGroup' => [ 'name' => 'ModifyDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'ModifyDBSubnetGroupResult', 'resultWrapper' => 'ModifyDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'SubnetAlreadyInUse', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'ModifyEventSubscription' => [ 'name' => 'ModifyEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyEventSubscriptionMessage', ], 'output' => [ 'shape' => 'ModifyEventSubscriptionResult', 'resultWrapper' => 'ModifyEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], ], ], 'ModifyGlobalCluster' => [ 'name' => 'ModifyGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyGlobalClusterMessage', ], 'output' => [ 'shape' => 'ModifyGlobalClusterResult', 'resultWrapper' => 'ModifyGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ModifyIntegration' => [ 'name' => 'ModifyIntegration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyIntegrationMessage', ], 'output' => [ 'shape' => 'Integration', 'resultWrapper' => 'ModifyIntegrationResult', ], 'errors' => [ [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'InvalidIntegrationStateFault', ], [ 'shape' => 'IntegrationConflictOperationFault', ], ], ], 'ModifyOptionGroup' => [ 'name' => 'ModifyOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyOptionGroupMessage', ], 'output' => [ 'shape' => 'ModifyOptionGroupResult', 'resultWrapper' => 'ModifyOptionGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidOptionGroupStateFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'ModifyTenantDatabase' => [ 'name' => 'ModifyTenantDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyTenantDatabaseMessage', ], 'output' => [ 'shape' => 'ModifyTenantDatabaseResult', 'resultWrapper' => 'ModifyTenantDatabaseResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'TenantDatabaseAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'PromoteReadReplica' => [ 'name' => 'PromoteReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PromoteReadReplicaMessage', ], 'output' => [ 'shape' => 'PromoteReadReplicaResult', 'resultWrapper' => 'PromoteReadReplicaResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'PromoteReadReplicaDBCluster' => [ 'name' => 'PromoteReadReplicaDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PromoteReadReplicaDBClusterMessage', ], 'output' => [ 'shape' => 'PromoteReadReplicaDBClusterResult', 'resultWrapper' => 'PromoteReadReplicaDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'PurchaseReservedDBInstancesOffering' => [ 'name' => 'PurchaseReservedDBInstancesOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PurchaseReservedDBInstancesOfferingMessage', ], 'output' => [ 'shape' => 'PurchaseReservedDBInstancesOfferingResult', 'resultWrapper' => 'PurchaseReservedDBInstancesOfferingResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstancesOfferingNotFoundFault', ], [ 'shape' => 'ReservedDBInstanceAlreadyExistsFault', ], [ 'shape' => 'ReservedDBInstanceQuotaExceededFault', ], ], ], 'RebootDBCluster' => [ 'name' => 'RebootDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBClusterMessage', ], 'output' => [ 'shape' => 'RebootDBClusterResult', 'resultWrapper' => 'RebootDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'RebootDBInstance' => [ 'name' => 'RebootDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBInstanceMessage', ], 'output' => [ 'shape' => 'RebootDBInstanceResult', 'resultWrapper' => 'RebootDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'RebootDBShardGroup' => [ 'name' => 'RebootDBShardGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBShardGroupMessage', ], 'output' => [ 'shape' => 'DBShardGroup', 'resultWrapper' => 'RebootDBShardGroupResult', ], 'errors' => [ [ 'shape' => 'DBShardGroupNotFoundFault', ], [ 'shape' => 'InvalidDBShardGroupStateFault', ], ], ], 'RegisterDBProxyTargets' => [ 'name' => 'RegisterDBProxyTargets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterDBProxyTargetsRequest', ], 'output' => [ 'shape' => 'RegisterDBProxyTargetsResponse', 'resultWrapper' => 'RegisterDBProxyTargetsResult', ], 'errors' => [ [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBProxyTargetAlreadyRegisteredFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBProxyStateFault', ], [ 'shape' => 'InsufficientAvailableIPsInSubnetFault', ], ], ], 'RemoveFromGlobalCluster' => [ 'name' => 'RemoveFromGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveFromGlobalClusterMessage', ], 'output' => [ 'shape' => 'RemoveFromGlobalClusterResult', 'resultWrapper' => 'RemoveFromGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'RemoveRoleFromDBCluster' => [ 'name' => 'RemoveRoleFromDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveRoleFromDBClusterMessage', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterRoleNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'RemoveRoleFromDBInstance' => [ 'name' => 'RemoveRoleFromDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveRoleFromDBInstanceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBInstanceRoleNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'RemoveSourceIdentifierFromSubscription' => [ 'name' => 'RemoveSourceIdentifierFromSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionMessage', ], 'output' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionResult', 'resultWrapper' => 'RemoveSourceIdentifierFromSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'RemoveTagsFromResource' => [ 'name' => 'RemoveTagsFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsFromResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBProxyNotFoundFault', ], [ 'shape' => 'DBProxyTargetGroupNotFoundFault', ], [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'IntegrationNotFoundFault', ], [ 'shape' => 'TenantDatabaseNotFoundFault', ], [ 'shape' => 'DBSnapshotTenantDatabaseNotFoundFault', ], ], ], 'ResetDBClusterParameterGroup' => [ 'name' => 'ResetDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ResetDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'ResetDBParameterGroup' => [ 'name' => 'ResetDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBParameterGroupMessage', ], 'output' => [ 'shape' => 'DBParameterGroupNameMessage', 'resultWrapper' => 'ResetDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'RestoreDBClusterFromS3' => [ 'name' => 'RestoreDBClusterFromS3', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromS3Message', ], 'output' => [ 'shape' => 'RestoreDBClusterFromS3Result', 'resultWrapper' => 'RestoreDBClusterFromS3Result', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], ], ], 'RestoreDBClusterFromSnapshot' => [ 'name' => 'RestoreDBClusterFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterFromSnapshotResult', 'resultWrapper' => 'RestoreDBClusterFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], ], ], 'RestoreDBClusterToPointInTime' => [ 'name' => 'RestoreDBClusterToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterToPointInTimeResult', 'resultWrapper' => 'RestoreDBClusterToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'DBClusterAutomatedBackupNotFoundFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], ], ], 'RestoreDBInstanceFromDBSnapshot' => [ 'name' => 'RestoreDBInstanceFromDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceFromDBSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBInstanceFromDBSnapshotResult', 'resultWrapper' => 'RestoreDBInstanceFromDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'CertificateNotFoundFault', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], ], ], 'RestoreDBInstanceFromS3' => [ 'name' => 'RestoreDBInstanceFromS3', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceFromS3Message', ], 'output' => [ 'shape' => 'RestoreDBInstanceFromS3Result', 'resultWrapper' => 'RestoreDBInstanceFromS3Result', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'RestoreDBInstanceToPointInTime' => [ 'name' => 'RestoreDBInstanceToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBInstanceToPointInTimeResult', 'resultWrapper' => 'RestoreDBInstanceToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'PointInTimeRestoreNotEnabledFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], [ 'shape' => 'NetworkTypeNotSupported', ], [ 'shape' => 'TenantDatabaseQuotaExceededFault', ], [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'RevokeDBSecurityGroupIngress' => [ 'name' => 'RevokeDBSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeDBSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'RevokeDBSecurityGroupIngressResult', 'resultWrapper' => 'RevokeDBSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], ], ], 'StartActivityStream' => [ 'name' => 'StartActivityStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartActivityStreamRequest', ], 'output' => [ 'shape' => 'StartActivityStreamResponse', 'resultWrapper' => 'StartActivityStreamResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'StartDBCluster' => [ 'name' => 'StartDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBClusterMessage', ], 'output' => [ 'shape' => 'StartDBClusterResult', 'resultWrapper' => 'StartDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StartDBInstance' => [ 'name' => 'StartDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBInstanceMessage', ], 'output' => [ 'shape' => 'StartDBInstanceResult', 'resultWrapper' => 'StartDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'StartDBInstanceAutomatedBackupsReplication' => [ 'name' => 'StartDBInstanceAutomatedBackupsReplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBInstanceAutomatedBackupsReplicationMessage', ], 'output' => [ 'shape' => 'StartDBInstanceAutomatedBackupsReplicationResult', 'resultWrapper' => 'StartDBInstanceAutomatedBackupsReplicationResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBInstanceAutomatedBackupQuotaExceededFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], ], ], 'StartExportTask' => [ 'name' => 'StartExportTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartExportTaskMessage', ], 'output' => [ 'shape' => 'ExportTask', 'resultWrapper' => 'StartExportTaskResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'ExportTaskAlreadyExistsFault', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'IamRoleNotFoundFault', ], [ 'shape' => 'IamRoleMissingPermissionsFault', ], [ 'shape' => 'InvalidExportOnlyFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'InvalidExportSourceStateFault', ], ], ], 'StopActivityStream' => [ 'name' => 'StopActivityStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopActivityStreamRequest', ], 'output' => [ 'shape' => 'StopActivityStreamResponse', 'resultWrapper' => 'StopActivityStreamResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'StopDBCluster' => [ 'name' => 'StopDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBClusterMessage', ], 'output' => [ 'shape' => 'StopDBClusterResult', 'resultWrapper' => 'StopDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StopDBInstance' => [ 'name' => 'StopDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBInstanceMessage', ], 'output' => [ 'shape' => 'StopDBInstanceResult', 'resultWrapper' => 'StopDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'StopDBInstanceAutomatedBackupsReplication' => [ 'name' => 'StopDBInstanceAutomatedBackupsReplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBInstanceAutomatedBackupsReplicationMessage', ], 'output' => [ 'shape' => 'StopDBInstanceAutomatedBackupsReplicationResult', 'resultWrapper' => 'StopDBInstanceAutomatedBackupsReplicationResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'SwitchoverBlueGreenDeployment' => [ 'name' => 'SwitchoverBlueGreenDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SwitchoverBlueGreenDeploymentRequest', ], 'output' => [ 'shape' => 'SwitchoverBlueGreenDeploymentResponse', 'resultWrapper' => 'SwitchoverBlueGreenDeploymentResult', ], 'errors' => [ [ 'shape' => 'BlueGreenDeploymentNotFoundFault', ], [ 'shape' => 'InvalidBlueGreenDeploymentStateFault', ], ], ], 'SwitchoverGlobalCluster' => [ 'name' => 'SwitchoverGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SwitchoverGlobalClusterMessage', ], 'output' => [ 'shape' => 'SwitchoverGlobalClusterResult', 'resultWrapper' => 'SwitchoverGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'SwitchoverReadReplica' => [ 'name' => 'SwitchoverReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SwitchoverReadReplicaMessage', ], 'output' => [ 'shape' => 'SwitchoverReadReplicaResult', 'resultWrapper' => 'SwitchoverReadReplicaResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], ], 'shapes' => [ 'AccountAttributesMessage' => [ 'type' => 'structure', 'members' => [ 'AccountQuotas' => [ 'shape' => 'AccountQuotaList', ], ], ], 'AccountQuota' => [ 'type' => 'structure', 'members' => [ 'AccountQuotaName' => [ 'shape' => 'String', ], 'Used' => [ 'shape' => 'Long', ], 'Max' => [ 'shape' => 'Long', ], ], 'wrapper' => true, ], 'AccountQuotaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountQuota', 'locationName' => 'AccountQuota', ], ], 'ActivityStreamMode' => [ 'type' => 'string', 'enum' => [ 'sync', 'async', ], ], 'ActivityStreamModeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ActivityStreamPolicyStatus' => [ 'type' => 'string', 'enum' => [ 'locked', 'unlocked', 'locking-policy', 'unlocking-policy', ], ], 'ActivityStreamStatus' => [ 'type' => 'string', 'enum' => [ 'stopped', 'starting', 'started', 'stopping', ], ], 'AddRoleToDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'RoleArn', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'AddRoleToDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'RoleArn', 'FeatureName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'AddTagsToResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'Tags', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ApplyMethod' => [ 'type' => 'string', 'enum' => [ 'immediate', 'pending-reboot', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceIdentifier', 'ApplyAction', 'OptInType', ], 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'ApplyAction' => [ 'shape' => 'String', ], 'OptInType' => [ 'shape' => 'String', ], ], ], 'ApplyPendingMaintenanceActionResult' => [ 'type' => 'structure', 'members' => [ 'ResourcePendingMaintenanceActions' => [ 'shape' => 'ResourcePendingMaintenanceActions', ], ], ], 'Arn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'AttributeValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AttributeValue', ], ], 'AuditPolicyState' => [ 'type' => 'string', 'enum' => [ 'locked', 'unlocked', ], ], 'AuthScheme' => [ 'type' => 'string', 'enum' => [ 'SECRETS', ], ], 'AuthorizationAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizeDBSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'AuthorizeDBSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'AutomationMode' => [ 'type' => 'string', 'enum' => [ 'full', 'all-paused', ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', 'locationName' => 'AvailabilityZone', ], ], 'AvailabilityZones' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AvailabilityZone', ], ], 'AvailableProcessorFeature' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], ], ], 'AvailableProcessorFeatureList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailableProcessorFeature', 'locationName' => 'AvailableProcessorFeature', ], ], 'AwsBackupRecoveryPointArn' => [ 'type' => 'string', 'max' => 350, 'min' => 43, 'pattern' => '^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\\-]+:)?[a-z][a-z0-9\\-]{0,255}$', ], 'BacktrackDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'BacktrackTo', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackTo' => [ 'shape' => 'TStamp', ], 'Force' => [ 'shape' => 'BooleanOptional', ], 'UseEarliestTimeOnPointInTimeUnavailable' => [ 'shape' => 'BooleanOptional', ], ], ], 'BackupPolicyNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'deprecated' => true, 'deprecatedMessage' => 'Please avoid using this fault', 'error' => [ 'code' => 'BackupPolicyNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'BlueGreenDeployment' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeploymentIdentifier' => [ 'shape' => 'BlueGreenDeploymentIdentifier', ], 'BlueGreenDeploymentName' => [ 'shape' => 'BlueGreenDeploymentName', ], 'Source' => [ 'shape' => 'DatabaseArn', ], 'Target' => [ 'shape' => 'DatabaseArn', ], 'SwitchoverDetails' => [ 'shape' => 'SwitchoverDetailList', ], 'Tasks' => [ 'shape' => 'BlueGreenDeploymentTaskList', ], 'Status' => [ 'shape' => 'BlueGreenDeploymentStatus', ], 'StatusDetails' => [ 'shape' => 'BlueGreenDeploymentStatusDetails', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'DeleteTime' => [ 'shape' => 'TStamp', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'BlueGreenDeploymentAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'BlueGreenDeploymentAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'BlueGreenDeploymentIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z][0-9A-Za-z-:._]*', ], 'BlueGreenDeploymentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BlueGreenDeployment', ], ], 'BlueGreenDeploymentName' => [ 'type' => 'string', 'max' => 60, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'BlueGreenDeploymentNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'BlueGreenDeploymentNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'BlueGreenDeploymentStatus' => [ 'type' => 'string', ], 'BlueGreenDeploymentStatusDetails' => [ 'type' => 'string', ], 'BlueGreenDeploymentTask' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'BlueGreenDeploymentTaskName', ], 'Status' => [ 'shape' => 'BlueGreenDeploymentTaskStatus', ], ], ], 'BlueGreenDeploymentTaskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BlueGreenDeploymentTask', ], ], 'BlueGreenDeploymentTaskName' => [ 'type' => 'string', ], 'BlueGreenDeploymentTaskStatus' => [ 'type' => 'string', ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '.*', ], 'CACertificateIdentifiersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'CancelExportTaskMessage' => [ 'type' => 'structure', 'required' => [ 'ExportTaskIdentifier', ], 'members' => [ 'ExportTaskIdentifier' => [ 'shape' => 'String', ], ], ], 'Certificate' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'CertificateType' => [ 'shape' => 'String', ], 'Thumbprint' => [ 'shape' => 'String', ], 'ValidFrom' => [ 'shape' => 'TStamp', ], 'ValidTill' => [ 'shape' => 'TStamp', ], 'CertificateArn' => [ 'shape' => 'String', ], 'CustomerOverride' => [ 'shape' => 'BooleanOptional', ], 'CustomerOverrideValidTill' => [ 'shape' => 'TStamp', ], ], 'wrapper' => true, ], 'CertificateDetails' => [ 'type' => 'structure', 'members' => [ 'CAIdentifier' => [ 'shape' => 'String', ], 'ValidTill' => [ 'shape' => 'TStamp', ], ], ], 'CertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Certificate', 'locationName' => 'Certificate', ], ], 'CertificateMessage' => [ 'type' => 'structure', 'members' => [ 'DefaultCertificateForNewLaunches' => [ 'shape' => 'String', ], 'Certificates' => [ 'shape' => 'CertificateList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'CertificateNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CertificateNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CharacterSet' => [ 'type' => 'structure', 'members' => [ 'CharacterSetName' => [ 'shape' => 'String', ], 'CharacterSetDescription' => [ 'shape' => 'String', ], ], ], 'ClientPasswordAuthType' => [ 'type' => 'string', 'enum' => [ 'MYSQL_NATIVE_PASSWORD', 'POSTGRES_SCRAM_SHA_256', 'POSTGRES_MD5', 'SQL_SERVER_AUTHENTICATION', ], ], 'CloudwatchLogsExportConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableLogTypes' => [ 'shape' => 'LogTypeList', ], 'DisableLogTypes' => [ 'shape' => 'LogTypeList', ], ], ], 'ClusterPendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'PendingCloudwatchLogsExports' => [ 'shape' => 'PendingCloudwatchLogsExports', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'StorageType' => [ 'shape' => 'String', ], 'CertificateDetails' => [ 'shape' => 'CertificateDetails', ], ], ], 'ConnectionPoolConfiguration' => [ 'type' => 'structure', 'members' => [ 'MaxConnectionsPercent' => [ 'shape' => 'IntegerOptional', ], 'MaxIdleConnectionsPercent' => [ 'shape' => 'IntegerOptional', ], 'ConnectionBorrowTimeout' => [ 'shape' => 'IntegerOptional', ], 'SessionPinningFilters' => [ 'shape' => 'StringList', ], 'InitQuery' => [ 'shape' => 'String', ], ], ], 'ConnectionPoolConfigurationInfo' => [ 'type' => 'structure', 'members' => [ 'MaxConnectionsPercent' => [ 'shape' => 'Integer', ], 'MaxIdleConnectionsPercent' => [ 'shape' => 'Integer', ], 'ConnectionBorrowTimeout' => [ 'shape' => 'Integer', ], 'SessionPinningFilters' => [ 'shape' => 'StringList', ], 'InitQuery' => [ 'shape' => 'String', ], ], ], 'ContextAttribute' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'ContextAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContextAttribute', ], ], 'CopyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupDescription', ], 'members' => [ 'SourceDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CopyDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterSnapshotIdentifier', 'TargetDBClusterSnapshotIdentifier', ], 'members' => [ 'SourceDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CopyDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBParameterGroupIdentifier', 'TargetDBParameterGroupIdentifier', 'TargetDBParameterGroupDescription', ], 'members' => [ 'SourceDBParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroup' => [ 'shape' => 'DBParameterGroup', ], ], ], 'CopyDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBSnapshotIdentifier', 'TargetDBSnapshotIdentifier', ], 'members' => [ 'SourceDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'TargetCustomAvailabilityZone' => [ 'shape' => 'String', ], 'CopyOptionGroup' => [ 'shape' => 'BooleanOptional', ], ], ], 'CopyDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'CopyOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceOptionGroupIdentifier', 'TargetOptionGroupIdentifier', 'TargetOptionGroupDescription', ], 'members' => [ 'SourceOptionGroupIdentifier' => [ 'shape' => 'String', ], 'TargetOptionGroupIdentifier' => [ 'shape' => 'String', ], 'TargetOptionGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'CreateBlueGreenDeploymentRequest' => [ 'type' => 'structure', 'required' => [ 'BlueGreenDeploymentName', 'Source', ], 'members' => [ 'BlueGreenDeploymentName' => [ 'shape' => 'BlueGreenDeploymentName', ], 'Source' => [ 'shape' => 'DatabaseArn', ], 'TargetEngineVersion' => [ 'shape' => 'TargetEngineVersion', ], 'TargetDBParameterGroupName' => [ 'shape' => 'TargetDBParameterGroupName', ], 'TargetDBClusterParameterGroupName' => [ 'shape' => 'TargetDBClusterParameterGroupName', ], 'Tags' => [ 'shape' => 'TagList', ], 'TargetDBInstanceClass' => [ 'shape' => 'TargetDBInstanceClass', ], 'UpgradeTargetStorageConfig' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateBlueGreenDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeployment' => [ 'shape' => 'BlueGreenDeployment', ], ], ], 'CreateCustomDBEngineVersionFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CreateCustomDBEngineVersionFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CreateCustomDBEngineVersionMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', 'EngineVersion', ], 'members' => [ 'Engine' => [ 'shape' => 'CustomEngineName', ], 'EngineVersion' => [ 'shape' => 'CustomEngineVersion', ], 'DatabaseInstallationFilesS3BucketName' => [ 'shape' => 'BucketName', ], 'DatabaseInstallationFilesS3Prefix' => [ 'shape' => 'String255', ], 'ImageId' => [ 'shape' => 'String255', ], 'KMSKeyId' => [ 'shape' => 'KmsKeyIdOrArn', ], 'Description' => [ 'shape' => 'Description', ], 'Manifest' => [ 'shape' => 'CustomDBEngineVersionManifest', ], 'Tags' => [ 'shape' => 'TagList', ], 'SourceCustomDbEngineVersionIdentifier' => [ 'shape' => 'String255', ], 'UseAwsProvidedLatestImage' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'DBClusterEndpointIdentifier', 'EndpointType', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'EnableHttpEndpoint' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'EnableGlobalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableLimitlessDatabase' => [ 'shape' => 'BooleanOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'DBSystemId' => [ 'shape' => 'String', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'EnableLocalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], ], 'CreateDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CreateDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'CreateDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'DBClusterIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CreateDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', ], 'members' => [ 'DBName' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'Timezone' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'BackupTarget' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DBSystemId' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], ], 'CreateDBInstanceReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'StorageType' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'ReplicaMode' => [ 'shape' => 'ReplicaMode', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'UpgradeStorageConfig' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'CreateDBInstanceReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroup' => [ 'shape' => 'DBParameterGroup', ], ], ], 'CreateDBProxyEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', 'DBProxyEndpointName', 'VpcSubnetIds', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'DBProxyName', ], 'DBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], 'VpcSubnetIds' => [ 'shape' => 'StringList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], 'TargetRole' => [ 'shape' => 'DBProxyEndpointTargetRole', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBProxyEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpoint' => [ 'shape' => 'DBProxyEndpoint', ], ], ], 'CreateDBProxyRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', 'EngineFamily', 'Auth', 'RoleArn', 'VpcSubnetIds', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'EngineFamily' => [ 'shape' => 'EngineFamily', ], 'Auth' => [ 'shape' => 'UserAuthConfigList', ], 'RoleArn' => [ 'shape' => 'String', ], 'VpcSubnetIds' => [ 'shape' => 'StringList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], 'RequireTLS' => [ 'shape' => 'Boolean', ], 'IdleClientTimeout' => [ 'shape' => 'IntegerOptional', ], 'DebugLogging' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBProxyResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxy' => [ 'shape' => 'DBProxy', ], ], ], 'CreateDBSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', 'DBSecurityGroupDescription', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSecurityGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'CreateDBShardGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBShardGroupIdentifier', 'DBClusterIdentifier', 'MaxACU', ], 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'ComputeRedundancy' => [ 'shape' => 'IntegerOptional', ], 'MaxACU' => [ 'shape' => 'DoubleOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', 'DBInstanceIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'CreateDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'DBSubnetGroupDescription', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'CreateEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SnsTopicArn', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'SourceIds' => [ 'shape' => 'SourceIdsList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'CreateGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'CreateIntegrationMessage' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'TargetArn', 'IntegrationName', ], 'members' => [ 'SourceArn' => [ 'shape' => 'SourceArn', ], 'TargetArn' => [ 'shape' => 'Arn', ], 'IntegrationName' => [ 'shape' => 'IntegrationName', ], 'KMSKeyId' => [ 'shape' => 'String', ], 'AdditionalEncryptionContext' => [ 'shape' => 'EncryptionContextMap', ], 'Tags' => [ 'shape' => 'TagList', ], 'DataFilter' => [ 'shape' => 'DataFilter', ], 'Description' => [ 'shape' => 'IntegrationDescription', ], ], ], 'CreateOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', 'EngineName', 'MajorEngineVersion', 'OptionGroupDescription', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'OptionGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'CreateTenantDatabaseMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'TenantDBName', 'MasterUsername', 'MasterUserPassword', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'SensitiveString', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTenantDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'TenantDatabase' => [ 'shape' => 'TenantDatabase', ], ], ], 'CustomAvailabilityZoneNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CustomAvailabilityZoneNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CustomDBEngineVersionAMI' => [ 'type' => 'structure', 'members' => [ 'ImageId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'CustomDBEngineVersionAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CustomDBEngineVersionAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CustomDBEngineVersionManifest' => [ 'type' => 'string', 'max' => 51000, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'CustomDBEngineVersionNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CustomDBEngineVersionNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CustomDBEngineVersionQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CustomDBEngineVersionQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CustomEngineName' => [ 'type' => 'string', 'max' => 35, 'min' => 1, 'pattern' => '^[A-Za-z0-9-]{1,35}$', ], 'CustomEngineVersion' => [ 'type' => 'string', 'max' => 60, 'min' => 1, 'pattern' => '^[a-z0-9_.-]{1,60}$', ], 'CustomEngineVersionStatus' => [ 'type' => 'string', 'enum' => [ 'available', 'inactive', 'inactive-except-restore', ], ], 'DBCluster' => [ 'type' => 'structure', 'members' => [ 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroup' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'AutomaticRestartTime' => [ 'shape' => 'TStamp', ], 'PercentProgress' => [ 'shape' => 'String', ], 'EarliestRestorableTime' => [ 'shape' => 'TStamp', ], 'Endpoint' => [ 'shape' => 'String', ], 'ReaderEndpoint' => [ 'shape' => 'String', ], 'CustomEndpoints' => [ 'shape' => 'StringList', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DBClusterOptionGroupMemberships' => [ 'shape' => 'DBClusterOptionGroupMemberships', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaIdentifiers' => [ 'shape' => 'ReadReplicaIdentifierList', ], 'StatusInfos' => [ 'shape' => 'DBClusterStatusInfoList', ], 'DBClusterMembers' => [ 'shape' => 'DBClusterMemberList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'HostedZoneId' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'DBClusterArn' => [ 'shape' => 'String', ], 'AssociatedRoles' => [ 'shape' => 'DBClusterRoles', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'BooleanOptional', ], 'CloneGroupId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'EarliestBacktrackTime' => [ 'shape' => 'TStamp', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'BacktrackConsumedChangeRecords' => [ 'shape' => 'LongOptional', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'Capacity' => [ 'shape' => 'IntegerOptional', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfigurationInfo' => [ 'shape' => 'ScalingConfigurationInfo', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'HttpEndpointEnabled' => [ 'shape' => 'BooleanOptional', ], 'ActivityStreamMode' => [ 'shape' => 'ActivityStreamMode', ], 'ActivityStreamStatus' => [ 'shape' => 'ActivityStreamStatus', ], 'ActivityStreamKmsKeyId' => [ 'shape' => 'String', ], 'ActivityStreamKinesisStreamName' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'CrossAccountClone' => [ 'shape' => 'BooleanOptional', ], 'DomainMemberships' => [ 'shape' => 'DomainMembershipList', ], 'TagList' => [ 'shape' => 'TagList', ], 'GlobalWriteForwardingStatus' => [ 'shape' => 'WriteForwardingStatus', ], 'GlobalWriteForwardingRequested' => [ 'shape' => 'BooleanOptional', ], 'PendingModifiedValues' => [ 'shape' => 'ClusterPendingModifiedValues', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'PerformanceInsightsEnabled' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfigurationInfo', ], 'NetworkType' => [ 'shape' => 'String', ], 'DBSystemId' => [ 'shape' => 'String', ], 'MasterUserSecret' => [ 'shape' => 'MasterUserSecret', ], 'IOOptimizedNextAllowedModificationTime' => [ 'shape' => 'TStamp', ], 'LocalWriteForwardingStatus' => [ 'shape' => 'LocalWriteForwardingStatus', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'String', ], 'LimitlessDatabase' => [ 'shape' => 'LimitlessDatabase', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'CertificateDetails' => [ 'shape' => 'CertificateDetails', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterAutomatedBackup' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'DBClusterAutomatedBackupsArn' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreWindow' => [ 'shape' => 'RestoreWindow', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'Region' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBClusterArn' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EngineMode' => [ 'shape' => 'String', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'Port' => [ 'shape' => 'Integer', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterAutomatedBackupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterAutomatedBackup', 'locationName' => 'DBClusterAutomatedBackup', ], ], 'DBClusterAutomatedBackupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterAutomatedBackups' => [ 'shape' => 'DBClusterAutomatedBackupList', ], ], ], 'DBClusterAutomatedBackupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAutomatedBackupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterAutomatedBackupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAutomatedBackupQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterBacktrack' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackIdentifier' => [ 'shape' => 'String', ], 'BacktrackTo' => [ 'shape' => 'TStamp', ], 'BacktrackedFrom' => [ 'shape' => 'TStamp', ], 'BacktrackRequestCreationTime' => [ 'shape' => 'TStamp', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterBacktrackList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterBacktrack', 'locationName' => 'DBClusterBacktrack', ], ], 'DBClusterBacktrackMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterBacktracks' => [ 'shape' => 'DBClusterBacktrackList', ], ], ], 'DBClusterBacktrackNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterBacktrackNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterCapacityInfo' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'PendingCapacity' => [ 'shape' => 'IntegerOptional', ], 'CurrentCapacity' => [ 'shape' => 'IntegerOptional', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], ], ], 'DBClusterEndpoint' => [ 'type' => 'structure', 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointResourceIdentifier' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'CustomEndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], 'DBClusterEndpointArn' => [ 'shape' => 'String', ], ], ], 'DBClusterEndpointAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterEndpoint', 'locationName' => 'DBClusterEndpointList', ], ], 'DBClusterEndpointMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterEndpoints' => [ 'shape' => 'DBClusterEndpointList', ], ], ], 'DBClusterEndpointNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointNotFoundFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterEndpointQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z][0-9A-Za-z-:._]*', ], 'DBClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBCluster', 'locationName' => 'DBCluster', ], ], 'DBClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'IsClusterWriter' => [ 'shape' => 'Boolean', ], 'DBClusterParameterGroupStatus' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterMember', 'locationName' => 'DBClusterMember', ], ], 'DBClusterMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusters' => [ 'shape' => 'DBClusterList', ], ], ], 'DBClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterOptionGroupMemberships' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterOptionGroupStatus', 'locationName' => 'DBClusterOptionGroup', ], ], 'DBClusterOptionGroupStatus' => [ 'type' => 'structure', 'members' => [ 'DBClusterOptionGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBClusterParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterParameterGroup', 'locationName' => 'DBClusterParameterGroup', ], ], 'DBClusterParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterParameterGroups' => [ 'shape' => 'DBClusterParameterGroupList', ], ], ], 'DBClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'DBClusterRoleAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoleQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterRole', 'locationName' => 'DBClusterRole', ], ], 'DBClusterSnapshot' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'EngineMode' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'VpcId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBClusterSnapshotArn' => [ 'shape' => 'String', ], 'SourceDBClusterSnapshotArn' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'TagList' => [ 'shape' => 'TagList', ], 'DBSystemId' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], ], 'DBClusterSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshotAttribute', 'locationName' => 'DBClusterSnapshotAttribute', ], ], 'DBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotAttributes' => [ 'shape' => 'DBClusterSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBClusterSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshot', 'locationName' => 'DBClusterSnapshot', ], ], 'DBClusterSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterSnapshots' => [ 'shape' => 'DBClusterSnapshotList', ], ], ], 'DBClusterSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterStatusInfo' => [ 'type' => 'structure', 'members' => [ 'StatusType' => [ 'shape' => 'String', ], 'Normal' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DBClusterStatusInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterStatusInfo', 'locationName' => 'DBClusterStatusInfo', ], ], 'DBEngineVersion' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'DBEngineDescription' => [ 'shape' => 'String', ], 'DBEngineVersionDescription' => [ 'shape' => 'String', ], 'DefaultCharacterSet' => [ 'shape' => 'CharacterSet', ], 'Image' => [ 'shape' => 'CustomDBEngineVersionAMI', ], 'DBEngineMediaType' => [ 'shape' => 'String', ], 'SupportedCharacterSets' => [ 'shape' => 'SupportedCharacterSetsList', ], 'SupportedNcharCharacterSets' => [ 'shape' => 'SupportedCharacterSetsList', ], 'ValidUpgradeTarget' => [ 'shape' => 'ValidUpgradeTargetList', ], 'SupportedTimezones' => [ 'shape' => 'SupportedTimezonesList', ], 'ExportableLogTypes' => [ 'shape' => 'LogTypeList', ], 'SupportsLogExportsToCloudwatchLogs' => [ 'shape' => 'Boolean', ], 'SupportsReadReplica' => [ 'shape' => 'Boolean', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], 'SupportedFeatureNames' => [ 'shape' => 'FeatureNameList', ], 'Status' => [ 'shape' => 'String', ], 'SupportsParallelQuery' => [ 'shape' => 'Boolean', ], 'SupportsGlobalDatabases' => [ 'shape' => 'Boolean', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'DatabaseInstallationFilesS3BucketName' => [ 'shape' => 'String', ], 'DatabaseInstallationFilesS3Prefix' => [ 'shape' => 'String', ], 'DBEngineVersionArn' => [ 'shape' => 'String', ], 'KMSKeyId' => [ 'shape' => 'String', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'TagList' => [ 'shape' => 'TagList', ], 'SupportsBabelfish' => [ 'shape' => 'Boolean', ], 'CustomDBEngineVersionManifest' => [ 'shape' => 'CustomDBEngineVersionManifest', ], 'SupportsLimitlessDatabase' => [ 'shape' => 'Boolean', ], 'SupportsCertificateRotationWithoutRestart' => [ 'shape' => 'BooleanOptional', ], 'SupportedCACertificateIdentifiers' => [ 'shape' => 'CACertificateIdentifiersList', ], 'SupportsLocalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'SupportsIntegrations' => [ 'shape' => 'Boolean', ], ], ], 'DBEngineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBEngineVersion', 'locationName' => 'DBEngineVersion', ], ], 'DBEngineVersionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBEngineVersions' => [ 'shape' => 'DBEngineVersionList', ], ], ], 'DBInstance' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'DBInstanceStatus' => [ 'shape' => 'String', ], 'AutomaticRestartTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'Integer', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupMembershipList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'DBParameterGroups' => [ 'shape' => 'DBParameterGroupStatusList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'PendingModifiedValues', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'ReadReplicaSourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaDBInstanceIdentifiers' => [ 'shape' => 'ReadReplicaDBInstanceIdentifierList', ], 'ReadReplicaDBClusterIdentifiers' => [ 'shape' => 'ReadReplicaDBClusterIdentifierList', ], 'ReplicaMode' => [ 'shape' => 'ReplicaMode', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupMemberships' => [ 'shape' => 'OptionGroupMembershipList', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'SecondaryAvailabilityZone' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'Boolean', ], 'StatusInfos' => [ 'shape' => 'DBInstanceStatusInfoList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'DbInstancePort' => [ 'shape' => 'Integer', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DomainMemberships' => [ 'shape' => 'DomainMembershipList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'Boolean', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'EnhancedMonitoringResourceArn' => [ 'shape' => 'String', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceArn' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'PerformanceInsightsEnabled' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'AssociatedRoles' => [ 'shape' => 'DBInstanceRoles', ], 'ListenerEndpoint' => [ 'shape' => 'Endpoint', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'TagList' => [ 'shape' => 'TagList', ], 'DBInstanceAutomatedBackupsReplications' => [ 'shape' => 'DBInstanceAutomatedBackupsReplicationList', ], 'CustomerOwnedIpEnabled' => [ 'shape' => 'BooleanOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'String', ], 'ActivityStreamStatus' => [ 'shape' => 'ActivityStreamStatus', ], 'ActivityStreamKmsKeyId' => [ 'shape' => 'String', ], 'ActivityStreamKinesisStreamName' => [ 'shape' => 'String', ], 'ActivityStreamMode' => [ 'shape' => 'ActivityStreamMode', ], 'ActivityStreamEngineNativeAuditFieldsIncluded' => [ 'shape' => 'BooleanOptional', ], 'AutomationMode' => [ 'shape' => 'AutomationMode', ], 'ResumeFullAutomationModeTime' => [ 'shape' => 'TStamp', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'BackupTarget' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'ActivityStreamPolicyStatus' => [ 'shape' => 'ActivityStreamPolicyStatus', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'DBSystemId' => [ 'shape' => 'String', ], 'MasterUserSecret' => [ 'shape' => 'MasterUserSecret', ], 'CertificateDetails' => [ 'shape' => 'CertificateDetails', ], 'ReadReplicaSourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'Boolean', ], 'IsStorageConfigUpgradeAvailable' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackup' => [ 'type' => 'structure', 'members' => [ 'DBInstanceArn' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'Region' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RestoreWindow' => [ 'shape' => 'RestoreWindow', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'Encrypted' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackupsReplications' => [ 'shape' => 'DBInstanceAutomatedBackupsReplicationList', ], 'BackupTarget' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], 'wrapper' => true, ], 'DBInstanceAutomatedBackupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceAutomatedBackup', 'locationName' => 'DBInstanceAutomatedBackup', ], ], 'DBInstanceAutomatedBackupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackups' => [ 'shape' => 'DBInstanceAutomatedBackupList', ], ], ], 'DBInstanceAutomatedBackupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAutomatedBackupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAutomatedBackupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackupsReplication' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], ], ], 'DBInstanceAutomatedBackupsReplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceAutomatedBackupsReplication', 'locationName' => 'DBInstanceAutomatedBackupsReplication', ], ], 'DBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstance', 'locationName' => 'DBInstance', ], ], 'DBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstances' => [ 'shape' => 'DBInstanceList', ], ], ], 'DBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBInstanceRoleAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoleQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceRole', 'locationName' => 'DBInstanceRole', ], ], 'DBInstanceStatusInfo' => [ 'type' => 'structure', 'members' => [ 'StatusType' => [ 'shape' => 'String', ], 'Normal' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DBInstanceStatusInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceStatusInfo', 'locationName' => 'DBInstanceStatusInfo', ], ], 'DBLogFileNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBLogFileNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBParameterGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBParameterGroup', 'locationName' => 'DBParameterGroup', ], ], 'DBParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupStatus' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'ParameterApplyStatus' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBParameterGroupStatus', 'locationName' => 'DBParameterGroup', ], ], 'DBParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBParameterGroups' => [ 'shape' => 'DBParameterGroupList', ], ], ], 'DBProxy' => [ 'type' => 'structure', 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'DBProxyArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'DBProxyStatus', ], 'EngineFamily' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], 'VpcSubnetIds' => [ 'shape' => 'StringList', ], 'Auth' => [ 'shape' => 'UserAuthConfigInfoList', ], 'RoleArn' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'RequireTLS' => [ 'shape' => 'Boolean', ], 'IdleClientTimeout' => [ 'shape' => 'Integer', ], 'DebugLogging' => [ 'shape' => 'Boolean', ], 'CreatedDate' => [ 'shape' => 'TStamp', ], 'UpdatedDate' => [ 'shape' => 'TStamp', ], ], ], 'DBProxyAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyEndpoint' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpointName' => [ 'shape' => 'String', ], 'DBProxyEndpointArn' => [ 'shape' => 'String', ], 'DBProxyName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'DBProxyEndpointStatus', ], 'VpcId' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], 'VpcSubnetIds' => [ 'shape' => 'StringList', ], 'Endpoint' => [ 'shape' => 'String', ], 'CreatedDate' => [ 'shape' => 'TStamp', ], 'TargetRole' => [ 'shape' => 'DBProxyEndpointTargetRole', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'DBProxyEndpointAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyEndpointAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBProxyEndpoint', ], ], 'DBProxyEndpointName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'DBProxyEndpointNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyEndpointNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyEndpointQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyEndpointQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyEndpointStatus' => [ 'type' => 'string', 'enum' => [ 'available', 'modifying', 'incompatible-network', 'insufficient-resource-limits', 'creating', 'deleting', ], ], 'DBProxyEndpointTargetRole' => [ 'type' => 'string', 'enum' => [ 'READ_WRITE', 'READ_ONLY', ], ], 'DBProxyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBProxy', ], ], 'DBProxyName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'DBProxyNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyStatus' => [ 'type' => 'string', 'enum' => [ 'available', 'modifying', 'incompatible-network', 'insufficient-resource-limits', 'creating', 'deleting', 'suspended', 'suspending', 'reactivating', ], ], 'DBProxyTarget' => [ 'type' => 'structure', 'members' => [ 'TargetArn' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'TrackedClusterId' => [ 'shape' => 'String', ], 'RdsResourceId' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'Type' => [ 'shape' => 'TargetType', ], 'Role' => [ 'shape' => 'TargetRole', ], 'TargetHealth' => [ 'shape' => 'TargetHealth', ], ], ], 'DBProxyTargetAlreadyRegisteredFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyTargetAlreadyRegisteredFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyTargetGroup' => [ 'type' => 'structure', 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'TargetGroupArn' => [ 'shape' => 'String', ], 'IsDefault' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'ConnectionPoolConfig' => [ 'shape' => 'ConnectionPoolConfigurationInfo', ], 'CreatedDate' => [ 'shape' => 'TStamp', ], 'UpdatedDate' => [ 'shape' => 'TStamp', ], ], ], 'DBProxyTargetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyTargetGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBProxyTargetNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBProxyTargetNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBRecommendation' => [ 'type' => 'structure', 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'TypeId' => [ 'shape' => 'String', ], 'Severity' => [ 'shape' => 'String', ], 'ResourceArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'CreatedTime' => [ 'shape' => 'TStamp', ], 'UpdatedTime' => [ 'shape' => 'TStamp', ], 'Detection' => [ 'shape' => 'String', ], 'Recommendation' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'String', ], 'RecommendedActions' => [ 'shape' => 'RecommendedActionList', ], 'Category' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'TypeDetection' => [ 'shape' => 'String', ], 'TypeRecommendation' => [ 'shape' => 'String', ], 'Impact' => [ 'shape' => 'String', ], 'AdditionalInfo' => [ 'shape' => 'String', ], 'Links' => [ 'shape' => 'DocLinkList', ], 'IssueDetails' => [ 'shape' => 'IssueDetails', ], ], ], 'DBRecommendationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBRecommendation', ], ], 'DBRecommendationMessage' => [ 'type' => 'structure', 'members' => [ 'DBRecommendation' => [ 'shape' => 'DBRecommendation', ], ], ], 'DBRecommendationsMessage' => [ 'type' => 'structure', 'members' => [ 'DBRecommendations' => [ 'shape' => 'DBRecommendationList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBSecurityGroup' => [ 'type' => 'structure', 'members' => [ 'OwnerId' => [ 'shape' => 'String', ], 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'EC2SecurityGroups' => [ 'shape' => 'EC2SecurityGroupList', ], 'IPRanges' => [ 'shape' => 'IPRangeList', ], 'DBSecurityGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSecurityGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSecurityGroupMembership', 'locationName' => 'DBSecurityGroup', ], ], 'DBSecurityGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroups', ], ], ], 'DBSecurityGroupNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'DBSecurityGroupName', ], ], 'DBSecurityGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'QuotaExceeded.DBSecurityGroup', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSecurityGroup', 'locationName' => 'DBSecurityGroup', ], ], 'DBShardGroup' => [ 'type' => 'structure', 'members' => [ 'DBShardGroupResourceId' => [ 'shape' => 'String', ], 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'MaxACU' => [ 'shape' => 'DoubleOptional', ], 'ComputeRedundancy' => [ 'shape' => 'IntegerOptional', ], 'Status' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Endpoint' => [ 'shape' => 'String', ], ], ], 'DBShardGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBShardGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBShardGroupIdentifier' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'DBShardGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBShardGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBShardGroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBShardGroup', 'locationName' => 'DBShardGroup', ], ], 'DBSnapshot' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'SourceRegion' => [ 'shape' => 'String', ], 'SourceDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'Encrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBSnapshotArn' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'TagList' => [ 'shape' => 'TagList', ], 'OriginalSnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'SnapshotDatabaseTime' => [ 'shape' => 'TStamp', ], 'SnapshotTarget' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'DBSystemId' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'Boolean', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], 'wrapper' => true, ], 'DBSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], 'wrapper' => true, ], 'DBSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshotAttribute', 'locationName' => 'DBSnapshotAttribute', ], ], 'DBSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotAttributes' => [ 'shape' => 'DBSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshot', 'locationName' => 'DBSnapshot', ], ], 'DBSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSnapshots' => [ 'shape' => 'DBSnapshotList', ], ], ], 'DBSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotTenantDatabase' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'TenantDatabaseCreateTime' => [ 'shape' => 'TStamp', ], 'TenantDBName' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'TenantDatabaseResourceId' => [ 'shape' => 'String', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DBSnapshotTenantDatabaseARN' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'TagList' => [ 'shape' => 'TagList', ], ], 'wrapper' => true, ], 'DBSnapshotTenantDatabaseNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotTenantDatabaseNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotTenantDatabasesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshotTenantDatabase', 'locationName' => 'DBSnapshotTenantDatabase', ], ], 'DBSnapshotTenantDatabasesMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSnapshotTenantDatabases' => [ 'shape' => 'DBSnapshotTenantDatabasesList', ], ], ], 'DBSubnetGroup' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'SubnetGroupStatus' => [ 'shape' => 'String', ], 'Subnets' => [ 'shape' => 'SubnetList', ], 'DBSubnetGroupArn' => [ 'shape' => 'String', ], 'SupportedNetworkTypes' => [ 'shape' => 'StringList', ], ], 'wrapper' => true, ], 'DBSubnetGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupDoesNotCoverEnoughAZs' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupDoesNotCoverEnoughAZs', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSubnetGroups' => [ 'shape' => 'DBSubnetGroups', ], ], ], 'DBSubnetGroupNotAllowedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotAllowedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSubnetGroup', 'locationName' => 'DBSubnetGroup', ], ], 'DBSubnetQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBUpgradeDependencyFailureFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBUpgradeDependencyFailure', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DataFilter' => [ 'type' => 'string', 'max' => 25600, 'min' => 1, 'pattern' => '[a-zA-Z0-9_ "\\\\\\-$,*.:?+\\/]*', ], 'DatabaseArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:[A-Za-z][0-9A-Za-z-:._]*', ], 'DeleteBlueGreenDeploymentRequest' => [ 'type' => 'structure', 'required' => [ 'BlueGreenDeploymentIdentifier', ], 'members' => [ 'BlueGreenDeploymentIdentifier' => [ 'shape' => 'BlueGreenDeploymentIdentifier', ], 'DeleteTarget' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteBlueGreenDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeployment' => [ 'shape' => 'BlueGreenDeployment', ], ], ], 'DeleteCustomDBEngineVersionMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', 'EngineVersion', ], 'members' => [ 'Engine' => [ 'shape' => 'CustomEngineName', ], 'EngineVersion' => [ 'shape' => 'CustomEngineVersion', ], ], ], 'DeleteDBClusterAutomatedBackupMessage' => [ 'type' => 'structure', 'required' => [ 'DbClusterResourceId', ], 'members' => [ 'DbClusterResourceId' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterAutomatedBackupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterAutomatedBackup' => [ 'shape' => 'DBClusterAutomatedBackup', ], ], ], 'DeleteDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterEndpointIdentifier', ], 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DeleteAutomatedBackups' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'DeleteDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'DeleteDBInstanceAutomatedBackupMessage' => [ 'type' => 'structure', 'members' => [ 'DbiResourceId' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], ], ], 'DeleteDBInstanceAutomatedBackupResult' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackup' => [ 'shape' => 'DBInstanceAutomatedBackup', ], ], ], 'DeleteDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DeleteAutomatedBackups' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'DeleteDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBProxyEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyEndpointName', ], 'members' => [ 'DBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], ], ], 'DeleteDBProxyEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpoint' => [ 'shape' => 'DBProxyEndpoint', ], ], ], 'DeleteDBProxyRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], ], ], 'DeleteDBProxyResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxy' => [ 'shape' => 'DBProxy', ], ], ], 'DeleteDBSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBShardGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBShardGroupIdentifier', ], 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], ], ], 'DeleteDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'DeleteDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'DeleteGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'DeleteIntegrationMessage' => [ 'type' => 'structure', 'required' => [ 'IntegrationIdentifier', ], 'members' => [ 'IntegrationIdentifier' => [ 'shape' => 'IntegrationIdentifier', ], ], ], 'DeleteOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteTenantDatabaseMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'TenantDBName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteTenantDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'TenantDatabase' => [ 'shape' => 'TenantDatabase', ], ], ], 'DeregisterDBProxyTargetsRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'DBInstanceIdentifiers' => [ 'shape' => 'StringList', ], 'DBClusterIdentifiers' => [ 'shape' => 'StringList', ], ], ], 'DeregisterDBProxyTargetsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DescribeAccountAttributesMessage' => [ 'type' => 'structure', 'members' => [], ], 'DescribeBlueGreenDeploymentsRequest' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeploymentIdentifier' => [ 'shape' => 'BlueGreenDeploymentIdentifier', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeBlueGreenDeploymentsResponse' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeployments' => [ 'shape' => 'BlueGreenDeploymentList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeCertificatesMessage' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterAutomatedBackupsMessage' => [ 'type' => 'structure', 'members' => [ 'DbClusterResourceId' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterBacktracksMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterEndpointsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'DescribeDBClusterSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], ], ], 'DescribeDBClustersMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], ], ], 'DescribeDBEngineVersionsMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DefaultOnly' => [ 'shape' => 'Boolean', ], 'ListSupportedCharacterSets' => [ 'shape' => 'BooleanOptional', ], 'ListSupportedTimezones' => [ 'shape' => 'BooleanOptional', ], 'IncludeAll' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeDBInstanceAutomatedBackupsMessage' => [ 'type' => 'structure', 'members' => [ 'DbiResourceId' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], ], ], 'DescribeDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBLogFilesDetails' => [ 'type' => 'structure', 'members' => [ 'LogFileName' => [ 'shape' => 'String', ], 'LastWritten' => [ 'shape' => 'Long', ], 'Size' => [ 'shape' => 'Long', ], ], ], 'DescribeDBLogFilesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribeDBLogFilesDetails', 'locationName' => 'DescribeDBLogFilesDetails', ], ], 'DescribeDBLogFilesMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'FilenameContains' => [ 'shape' => 'String', ], 'FileLastWritten' => [ 'shape' => 'Long', ], 'FileSize' => [ 'shape' => 'Long', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBLogFilesResponse' => [ 'type' => 'structure', 'members' => [ 'DescribeDBLogFiles' => [ 'shape' => 'DescribeDBLogFilesList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBProxiesRequest' => [ 'type' => 'structure', 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBProxiesResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxies' => [ 'shape' => 'DBProxyList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBProxyEndpointsRequest' => [ 'type' => 'structure', 'members' => [ 'DBProxyName' => [ 'shape' => 'DBProxyName', ], 'DBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBProxyEndpointsResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpoints' => [ 'shape' => 'DBProxyEndpointList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBProxyTargetGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBProxyTargetGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'TargetGroups' => [ 'shape' => 'TargetGroupList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBProxyTargetsRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBProxyTargetsResponse' => [ 'type' => 'structure', 'members' => [ 'Targets' => [ 'shape' => 'TargetList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBRecommendationsMessage' => [ 'type' => 'structure', 'members' => [ 'LastUpdatedAfter' => [ 'shape' => 'TStamp', ], 'LastUpdatedBefore' => [ 'shape' => 'TStamp', ], 'Locale' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSecurityGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBShardGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], ], ], 'DescribeDBShardGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'DBShardGroups' => [ 'shape' => 'DBShardGroupsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotAttributesResult' => [ 'shape' => 'DBSnapshotAttributesResult', ], ], ], 'DescribeDBSnapshotTenantDatabasesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], 'DbiResourceId' => [ 'shape' => 'String', ], ], ], 'DescribeDBSubnetGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEngineDefaultParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeEventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEventsMessage' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'IntegerOptional', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeExportTasksMessage' => [ 'type' => 'structure', 'members' => [ 'ExportTaskIdentifier' => [ 'shape' => 'String', ], 'SourceArn' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'MaxRecords', ], 'SourceType' => [ 'shape' => 'ExportSourceType', ], ], ], 'DescribeGlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeIntegrationsMessage' => [ 'type' => 'structure', 'members' => [ 'IntegrationIdentifier' => [ 'shape' => 'IntegrationIdentifier', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'DescribeIntegrationsResponse' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'Marker', ], 'Integrations' => [ 'shape' => 'IntegrationList', ], ], ], 'DescribeOptionGroupOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'EngineName', ], 'members' => [ 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeOptionGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], ], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', ], 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'AvailabilityZoneGroup' => [ 'shape' => 'String', ], 'Vpc' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribePendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], ], ], 'DescribeReservedDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'LeaseId' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeReservedDBInstancesOfferingsMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeSourceRegionsMessage' => [ 'type' => 'structure', 'members' => [ 'RegionName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeTenantDatabasesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], ], ], 'DescribeValidDBInstanceModificationsMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeValidDBInstanceModificationsResult' => [ 'type' => 'structure', 'members' => [ 'ValidDBInstanceModificationsMessage' => [ 'shape' => 'ValidDBInstanceModificationsMessage', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '.*', ], 'DisableHttpEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], ], ], 'DisableHttpEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'HttpEndpointEnabled' => [ 'shape' => 'Boolean', ], ], ], 'DocLink' => [ 'type' => 'structure', 'members' => [ 'Text' => [ 'shape' => 'String', ], 'Url' => [ 'shape' => 'String', ], ], ], 'DocLinkList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DocLink', ], ], 'DomainMembership' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'FQDN' => [ 'shape' => 'String', ], 'IAMRoleName' => [ 'shape' => 'String', ], 'OU' => [ 'shape' => 'String', ], 'AuthSecretArn' => [ 'shape' => 'String', ], 'DnsIps' => [ 'shape' => 'StringList', ], ], ], 'DomainMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainMembership', 'locationName' => 'DomainMembership', ], ], 'DomainNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DomainNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'Double' => [ 'type' => 'double', ], 'DoubleOptional' => [ 'type' => 'double', ], 'DoubleRange' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'Double', ], 'To' => [ 'shape' => 'Double', ], ], ], 'DoubleRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DoubleRange', 'locationName' => 'DoubleRange', ], ], 'DownloadDBLogFilePortionDetails' => [ 'type' => 'structure', 'members' => [ 'LogFileData' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'AdditionalDataPending' => [ 'shape' => 'Boolean', ], ], ], 'DownloadDBLogFilePortionMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'LogFileName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'LogFileName' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'NumberOfLines' => [ 'shape' => 'Integer', ], ], ], 'EC2SecurityGroup' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'EC2SecurityGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2SecurityGroup', 'locationName' => 'EC2SecurityGroup', ], ], 'Ec2ImagePropertiesNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'Ec2ImagePropertiesNotSupportedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EnableHttpEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], ], ], 'EnableHttpEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'HttpEndpointEnabled' => [ 'shape' => 'Boolean', ], ], ], 'EncryptionContextMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'HostedZoneId' => [ 'shape' => 'String', ], ], ], 'EngineDefaults' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], 'wrapper' => true, ], 'EngineFamily' => [ 'type' => 'string', 'enum' => [ 'MYSQL', 'POSTGRESQL', 'SQLSERVER', ], ], 'EngineModeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Event' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Message' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Date' => [ 'shape' => 'TStamp', ], 'SourceArn' => [ 'shape' => 'String', ], ], ], 'EventCategoriesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'EventCategory', ], ], 'EventCategoriesMap' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], ], 'wrapper' => true, ], 'EventCategoriesMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventCategoriesMap', 'locationName' => 'EventCategoriesMap', ], ], 'EventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'EventCategoriesMapList' => [ 'shape' => 'EventCategoriesMapList', ], ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', 'locationName' => 'Event', ], ], 'EventSubscription' => [ 'type' => 'structure', 'members' => [ 'CustomerAwsId' => [ 'shape' => 'String', ], 'CustSubscriptionId' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'SubscriptionCreationTime' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'SourceIdsList' => [ 'shape' => 'SourceIdsList', ], 'EventCategoriesList' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'EventSubscriptionArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'EventSubscriptionQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'EventSubscriptionQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EventSubscriptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventSubscription', 'locationName' => 'EventSubscription', ], ], 'EventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'EventSubscriptionsList' => [ 'shape' => 'EventSubscriptionsList', ], ], ], 'EventsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Events' => [ 'shape' => 'EventList', ], ], ], 'ExportSourceType' => [ 'type' => 'string', 'enum' => [ 'SNAPSHOT', 'CLUSTER', ], ], 'ExportTask' => [ 'type' => 'structure', 'members' => [ 'ExportTaskIdentifier' => [ 'shape' => 'String', ], 'SourceArn' => [ 'shape' => 'String', ], 'ExportOnly' => [ 'shape' => 'StringList', ], 'SnapshotTime' => [ 'shape' => 'TStamp', ], 'TaskStartTime' => [ 'shape' => 'TStamp', ], 'TaskEndTime' => [ 'shape' => 'TStamp', ], 'S3Bucket' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'IamRoleArn' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'TotalExtractedDataInGB' => [ 'shape' => 'Integer', ], 'FailureCause' => [ 'shape' => 'String', ], 'WarningMessage' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'ExportSourceType', ], ], ], 'ExportTaskAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ExportTaskAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ExportTaskNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ExportTaskNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ExportTasksList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportTask', 'locationName' => 'ExportTask', ], ], 'ExportTasksMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ExportTasks' => [ 'shape' => 'ExportTasksList', ], ], ], 'FailoverDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'FailoverDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'FailoverGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', 'TargetDbClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'TargetDbClusterIdentifier' => [ 'shape' => 'DBClusterIdentifier', ], 'AllowDataLoss' => [ 'shape' => 'BooleanOptional', ], 'Switchover' => [ 'shape' => 'BooleanOptional', ], ], ], 'FailoverGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'FailoverState' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FailoverStatus', ], 'FromDbClusterArn' => [ 'shape' => 'String', ], 'ToDbClusterArn' => [ 'shape' => 'String', ], 'IsDataLossAllowed' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'FailoverStatus' => [ 'type' => 'string', 'enum' => [ 'pending', 'failing-over', 'cancelling', ], ], 'FeatureNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', 'locationName' => 'Filter', ], ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'Value', ], ], 'GlobalCluster' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'GlobalClusterResourceId' => [ 'shape' => 'String', ], 'GlobalClusterArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterMembers' => [ 'shape' => 'GlobalClusterMemberList', ], 'FailoverState' => [ 'shape' => 'FailoverState', ], ], 'wrapper' => true, ], 'GlobalClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z][0-9A-Za-z-:._]*', ], 'GlobalClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalCluster', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBClusterArn' => [ 'shape' => 'String', ], 'Readers' => [ 'shape' => 'ReadersArnList', ], 'IsWriter' => [ 'shape' => 'Boolean', ], 'GlobalWriteForwardingStatus' => [ 'shape' => 'WriteForwardingStatus', ], 'SynchronizationStatus' => [ 'shape' => 'GlobalClusterMemberSynchronizationStatus', ], ], 'wrapper' => true, ], 'GlobalClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalClusterMember', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterMemberSynchronizationStatus' => [ 'type' => 'string', 'enum' => [ 'connected', 'pending-resync', ], ], 'GlobalClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'GlobalClusters' => [ 'shape' => 'GlobalClusterList', ], ], ], 'IAMAuthMode' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'REQUIRED', 'ENABLED', ], ], 'IPRange' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], ], ], 'IPRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPRange', 'locationName' => 'IPRange', ], ], 'IamRoleMissingPermissionsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IamRoleMissingPermissions', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IamRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IamRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'InstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientAvailableIPsInSubnetFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientAvailableIPsInSubnetFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBClusterCapacityFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBInstanceCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBInstanceCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientStorageClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientStorageClusterCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerOptional' => [ 'type' => 'integer', ], 'Integration' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'SourceArn', ], 'TargetArn' => [ 'shape' => 'Arn', ], 'IntegrationName' => [ 'shape' => 'IntegrationName', ], 'IntegrationArn' => [ 'shape' => 'IntegrationArn', ], 'KMSKeyId' => [ 'shape' => 'String', ], 'AdditionalEncryptionContext' => [ 'shape' => 'EncryptionContextMap', ], 'Status' => [ 'shape' => 'IntegrationStatus', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'Errors' => [ 'shape' => 'IntegrationErrorList', ], 'DataFilter' => [ 'shape' => 'DataFilter', ], 'Description' => [ 'shape' => 'IntegrationDescription', ], ], ], 'IntegrationAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IntegrationAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IntegrationArn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:rds(-[a-z]*)?:[a-z0-9\\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}', ], 'IntegrationConflictOperationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IntegrationConflictOperationFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IntegrationDescription' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '.*', ], 'IntegrationError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'IntegrationErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegrationError', 'locationName' => 'IntegrationError', ], ], 'IntegrationIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[a-zA-Z0-9_:\\-\\/]+', ], 'IntegrationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Integration', 'locationName' => 'Integration', ], ], 'IntegrationName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*', ], 'IntegrationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IntegrationNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'IntegrationQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'IntegrationQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IntegrationStatus' => [ 'type' => 'string', 'enum' => [ 'creating', 'active', 'modifying', 'failed', 'deleting', 'syncing', 'needs_attention', ], ], 'InvalidBlueGreenDeploymentStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidBlueGreenDeploymentStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCustomDBEngineVersionStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCustomDBEngineVersionStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterAutomatedBackupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterAutomatedBackupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterCapacityFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterEndpointStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterEndpointStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterSnapshotStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceAutomatedBackupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceAutomatedBackupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBParameterGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBParameterGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBProxyEndpointStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBProxyEndpointStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBProxyStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBProxyStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSecurityGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSecurityGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBShardGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBShardGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSnapshotState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidEventSubscriptionStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidEventSubscriptionState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidExportOnlyFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidExportOnly', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidExportSourceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidExportSourceState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidExportTaskStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidExportTaskStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidGlobalClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidGlobalClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidIntegrationStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidIntegrationStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidMaxAcuFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidMaxAcu', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidOptionGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidOptionGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidResourceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidResourceStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidRestoreFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidRestoreFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidS3BucketFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidS3BucketFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSubnet' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSubnet', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidVPCNetworkStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidVPCNetworkStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IssueDetails' => [ 'type' => 'structure', 'members' => [ 'PerformanceIssueDetails' => [ 'shape' => 'PerformanceIssueDetails', ], ], ], 'KMSKeyNotAccessibleFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'KMSKeyNotAccessibleFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'KmsKeyIdOrArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[a-zA-Z0-9_:\\-\\/]+', ], 'LimitlessDatabase' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'LimitlessDatabaseStatus', ], 'MinRequiredACU' => [ 'shape' => 'DoubleOptional', ], ], ], 'LimitlessDatabaseStatus' => [ 'type' => 'string', 'enum' => [ 'active', 'not-in-use', 'enabled', 'disabled', 'enabling', 'disabling', 'modifying-max-capacity', 'error', ], ], 'ListTagsForResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'LocalWriteForwardingStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', 'enabling', 'disabling', 'requested', ], ], 'LogTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Long' => [ 'type' => 'long', ], 'LongOptional' => [ 'type' => 'long', ], 'Marker' => [ 'type' => 'string', 'max' => 340, 'min' => 1, ], 'MasterUserSecret' => [ 'type' => 'structure', 'members' => [ 'SecretArn' => [ 'shape' => 'String', ], 'SecretStatus' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], ], ], 'MaxDBShardGroupLimitReached' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'MaxDBShardGroupLimitReached', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'MaxRecords' => [ 'type' => 'integer', 'max' => 100, 'min' => 20, ], 'Metric' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'References' => [ 'shape' => 'MetricReferenceList', ], 'StatisticsDetails' => [ 'shape' => 'String', ], 'MetricQuery' => [ 'shape' => 'MetricQuery', ], ], ], 'MetricList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Metric', ], ], 'MetricQuery' => [ 'type' => 'structure', 'members' => [ 'PerformanceInsightsMetricQuery' => [ 'shape' => 'PerformanceInsightsMetricQuery', ], ], ], 'MetricReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'ReferenceDetails' => [ 'shape' => 'ReferenceDetails', ], ], ], 'MetricReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricReference', ], ], 'MinimumEngineVersionPerAllowedValue' => [ 'type' => 'structure', 'members' => [ 'AllowedValue' => [ 'shape' => 'String', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], ], ], 'MinimumEngineVersionPerAllowedValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MinimumEngineVersionPerAllowedValue', 'locationName' => 'MinimumEngineVersionPerAllowedValue', ], ], 'ModifyActivityStreamRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'AuditPolicyState' => [ 'shape' => 'AuditPolicyState', ], ], ], 'ModifyActivityStreamResponse' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'String', ], 'KinesisStreamName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ActivityStreamStatus', ], 'Mode' => [ 'shape' => 'ActivityStreamMode', ], 'EngineNativeAuditFieldsIncluded' => [ 'shape' => 'BooleanOptional', ], 'PolicyStatus' => [ 'shape' => 'ActivityStreamPolicyStatus', ], ], ], 'ModifyCertificatesMessage' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'RemoveCustomerOverride' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyCertificatesResult' => [ 'type' => 'structure', 'members' => [ 'Certificate' => [ 'shape' => 'Certificate', ], ], ], 'ModifyCurrentDBClusterCapacityMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Capacity' => [ 'shape' => 'IntegerOptional', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], ], ], 'ModifyCustomDBEngineVersionMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', 'EngineVersion', ], 'members' => [ 'Engine' => [ 'shape' => 'CustomEngineName', ], 'EngineVersion' => [ 'shape' => 'CustomEngineVersion', ], 'Description' => [ 'shape' => 'Description', ], 'Status' => [ 'shape' => 'CustomEngineVersionStatus', ], ], ], 'ModifyDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterEndpointIdentifier', ], 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], ], ], 'ModifyDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'NewDBClusterIdentifier' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'DBInstanceParameterGroupName' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'EnableHttpEndpoint' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'EnableGlobalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'RotateMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'EngineMode' => [ 'shape' => 'String', ], 'AllowEngineModeChange' => [ 'shape' => 'Boolean', ], 'EnableLocalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'AwsBackupRecoveryPointArn', ], 'EnableLimitlessDatabase' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'ModifyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'Parameters', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'ModifyDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'NewDBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'DBPortNumber' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'DisableDomain' => [ 'shape' => 'BooleanOptional', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'CertificateRotationRestart' => [ 'shape' => 'BooleanOptional', ], 'ReplicaMode' => [ 'shape' => 'ReplicaMode', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'AwsBackupRecoveryPointArn' => [ 'shape' => 'AwsBackupRecoveryPointArn', ], 'AutomationMode' => [ 'shape' => 'AutomationMode', ], 'ResumeFullAutomationModeMinutes' => [ 'shape' => 'IntegerOptional', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'RotateMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ModifyDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', 'Parameters', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBProxyEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyEndpointName', ], 'members' => [ 'DBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], 'NewDBProxyEndpointName' => [ 'shape' => 'DBProxyEndpointName', ], 'VpcSecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'ModifyDBProxyEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyEndpoint' => [ 'shape' => 'DBProxyEndpoint', ], ], ], 'ModifyDBProxyRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'NewDBProxyName' => [ 'shape' => 'String', ], 'Auth' => [ 'shape' => 'UserAuthConfigList', ], 'RequireTLS' => [ 'shape' => 'BooleanOptional', ], 'IdleClientTimeout' => [ 'shape' => 'IntegerOptional', ], 'DebugLogging' => [ 'shape' => 'BooleanOptional', ], 'RoleArn' => [ 'shape' => 'String', ], 'SecurityGroups' => [ 'shape' => 'StringList', ], ], ], 'ModifyDBProxyResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxy' => [ 'shape' => 'DBProxy', ], ], ], 'ModifyDBProxyTargetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'TargetGroupName', 'DBProxyName', ], 'members' => [ 'TargetGroupName' => [ 'shape' => 'String', ], 'DBProxyName' => [ 'shape' => 'String', ], 'ConnectionPoolConfig' => [ 'shape' => 'ConnectionPoolConfiguration', ], 'NewName' => [ 'shape' => 'String', ], ], ], 'ModifyDBProxyTargetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyTargetGroup' => [ 'shape' => 'DBProxyTargetGroup', ], ], ], 'ModifyDBRecommendationMessage' => [ 'type' => 'structure', 'required' => [ 'RecommendationId', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'Locale' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'RecommendedActionUpdates' => [ 'shape' => 'RecommendedActionUpdateList', ], ], ], 'ModifyDBShardGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBShardGroupIdentifier', ], 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], 'MaxACU' => [ 'shape' => 'DoubleOptional', ], ], ], 'ModifyDBSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotAttributesResult' => [ 'shape' => 'DBSnapshotAttributesResult', ], ], ], 'ModifyDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'ModifyDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'ModifyDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], ], ], 'ModifyDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'ModifyEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'ModifyGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'NewGlobalClusterIdentifier' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'ModifyIntegrationMessage' => [ 'type' => 'structure', 'required' => [ 'IntegrationIdentifier', ], 'members' => [ 'IntegrationIdentifier' => [ 'shape' => 'IntegrationIdentifier', ], 'IntegrationName' => [ 'shape' => 'IntegrationName', ], 'DataFilter' => [ 'shape' => 'DataFilter', ], 'Description' => [ 'shape' => 'IntegrationDescription', ], ], ], 'ModifyOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'OptionsToInclude' => [ 'shape' => 'OptionConfigurationList', ], 'OptionsToRemove' => [ 'shape' => 'OptionNamesList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'ModifyOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'ModifyTenantDatabaseMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'TenantDBName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'SensitiveString', ], 'NewTenantDBName' => [ 'shape' => 'String', ], ], ], 'ModifyTenantDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'TenantDatabase' => [ 'shape' => 'TenantDatabase', ], ], ], 'NetworkTypeNotSupported' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NetworkTypeNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Option' => [ 'type' => 'structure', 'members' => [ 'OptionName' => [ 'shape' => 'String', ], 'OptionDescription' => [ 'shape' => 'String', ], 'Persistent' => [ 'shape' => 'Boolean', ], 'Permanent' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'OptionVersion' => [ 'shape' => 'String', ], 'OptionSettings' => [ 'shape' => 'OptionSettingConfigurationList', ], 'DBSecurityGroupMemberships' => [ 'shape' => 'DBSecurityGroupMembershipList', ], 'VpcSecurityGroupMemberships' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], ], ], 'OptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'OptionName', ], 'members' => [ 'OptionName' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'OptionVersion' => [ 'shape' => 'String', ], 'DBSecurityGroupMemberships' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupMemberships' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'OptionSettings' => [ 'shape' => 'OptionSettingsList', ], ], ], 'OptionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionConfiguration', 'locationName' => 'OptionConfiguration', ], ], 'OptionGroup' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'OptionGroupDescription' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'Options' => [ 'shape' => 'OptionsList', ], 'AllowsVpcAndNonVpcInstanceMemberships' => [ 'shape' => 'Boolean', ], 'VpcId' => [ 'shape' => 'String', ], 'OptionGroupArn' => [ 'shape' => 'String', ], 'SourceOptionGroup' => [ 'shape' => 'String', ], 'SourceAccountId' => [ 'shape' => 'String', ], 'CopyTimestamp' => [ 'shape' => 'TStamp', ], ], 'wrapper' => true, ], 'OptionGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroupMembership' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'OptionGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupMembership', 'locationName' => 'OptionGroupMembership', ], ], 'OptionGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroupOption' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'MinimumRequiredMinorEngineVersion' => [ 'shape' => 'String', ], 'PortRequired' => [ 'shape' => 'Boolean', ], 'DefaultPort' => [ 'shape' => 'IntegerOptional', ], 'OptionsDependedOn' => [ 'shape' => 'OptionsDependedOn', ], 'OptionsConflictsWith' => [ 'shape' => 'OptionsConflictsWith', ], 'Persistent' => [ 'shape' => 'Boolean', ], 'Permanent' => [ 'shape' => 'Boolean', ], 'RequiresAutoMinorEngineVersionUpgrade' => [ 'shape' => 'Boolean', ], 'VpcOnly' => [ 'shape' => 'Boolean', ], 'SupportsOptionVersionDowngrade' => [ 'shape' => 'BooleanOptional', ], 'OptionGroupOptionSettings' => [ 'shape' => 'OptionGroupOptionSettingsList', ], 'OptionGroupOptionVersions' => [ 'shape' => 'OptionGroupOptionVersionsList', ], 'CopyableCrossAccount' => [ 'shape' => 'BooleanOptional', ], ], ], 'OptionGroupOptionSetting' => [ 'type' => 'structure', 'members' => [ 'SettingName' => [ 'shape' => 'String', ], 'SettingDescription' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersionPerAllowedValue' => [ 'shape' => 'MinimumEngineVersionPerAllowedValueList', ], ], ], 'OptionGroupOptionSettingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupOptionSetting', 'locationName' => 'OptionGroupOptionSetting', ], ], 'OptionGroupOptionVersionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionVersion', 'locationName' => 'OptionVersion', ], ], 'OptionGroupOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupOption', 'locationName' => 'OptionGroupOption', ], ], 'OptionGroupOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OptionGroupOptions' => [ 'shape' => 'OptionGroupOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'OptionGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroups' => [ 'type' => 'structure', 'members' => [ 'OptionGroupsList' => [ 'shape' => 'OptionGroupsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'OptionGroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroup', 'locationName' => 'OptionGroup', ], ], 'OptionNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'OptionSetting' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'IsCollection' => [ 'shape' => 'Boolean', ], ], ], 'OptionSettingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionSetting', 'locationName' => 'OptionSetting', ], ], 'OptionSettingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionSetting', 'locationName' => 'OptionSetting', ], ], 'OptionVersion' => [ 'type' => 'structure', 'members' => [ 'Version' => [ 'shape' => 'String', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'OptionsConflictsWith' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OptionConflictName', ], ], 'OptionsDependedOn' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OptionName', ], ], 'OptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Option', 'locationName' => 'Option', ], ], 'OrderableDBInstanceOption' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'AvailabilityZoneGroup' => [ 'shape' => 'String', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'MultiAZCapable' => [ 'shape' => 'Boolean', ], 'ReadReplicaCapable' => [ 'shape' => 'Boolean', ], 'Vpc' => [ 'shape' => 'Boolean', ], 'SupportsStorageEncryption' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], 'SupportsIops' => [ 'shape' => 'Boolean', ], 'SupportsEnhancedMonitoring' => [ 'shape' => 'Boolean', ], 'SupportsIAMDatabaseAuthentication' => [ 'shape' => 'Boolean', ], 'SupportsPerformanceInsights' => [ 'shape' => 'Boolean', ], 'MinStorageSize' => [ 'shape' => 'IntegerOptional', ], 'MaxStorageSize' => [ 'shape' => 'IntegerOptional', ], 'MinIopsPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MaxIopsPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MinIopsPerGib' => [ 'shape' => 'DoubleOptional', ], 'MaxIopsPerGib' => [ 'shape' => 'DoubleOptional', ], 'AvailableProcessorFeatures' => [ 'shape' => 'AvailableProcessorFeatureList', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], 'SupportsStorageAutoscaling' => [ 'shape' => 'BooleanOptional', ], 'SupportsKerberosAuthentication' => [ 'shape' => 'BooleanOptional', ], 'OutpostCapable' => [ 'shape' => 'Boolean', ], 'SupportedActivityStreamModes' => [ 'shape' => 'ActivityStreamModeList', ], 'SupportsGlobalDatabases' => [ 'shape' => 'Boolean', ], 'SupportsClusters' => [ 'shape' => 'Boolean', ], 'SupportedNetworkTypes' => [ 'shape' => 'StringList', ], 'SupportsStorageThroughput' => [ 'shape' => 'Boolean', ], 'MinStorageThroughputPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MaxStorageThroughputPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MinStorageThroughputPerIops' => [ 'shape' => 'DoubleOptional', ], 'MaxStorageThroughputPerIops' => [ 'shape' => 'DoubleOptional', ], 'SupportsDedicatedLogVolume' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'OrderableDBInstanceOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderableDBInstanceOption', 'locationName' => 'OrderableDBInstanceOption', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OrderableDBInstanceOptions' => [ 'shape' => 'OrderableDBInstanceOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'Outpost' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String', ], ], ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'ApplyMethod' => [ 'shape' => 'ApplyMethod', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], ], ], 'ParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', 'locationName' => 'Parameter', ], ], 'PendingCloudwatchLogsExports' => [ 'type' => 'structure', 'members' => [ 'LogTypesToEnable' => [ 'shape' => 'LogTypeList', ], 'LogTypesToDisable' => [ 'shape' => 'LogTypeList', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'String', ], 'AutoAppliedAfterDate' => [ 'shape' => 'TStamp', ], 'ForcedApplyDate' => [ 'shape' => 'TStamp', ], 'OptInStatus' => [ 'shape' => 'String', ], 'CurrentApplyDate' => [ 'shape' => 'TStamp', ], 'Description' => [ 'shape' => 'String', ], ], ], 'PendingMaintenanceActionDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', 'locationName' => 'PendingMaintenanceAction', ], ], 'PendingMaintenanceActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePendingMaintenanceActions', 'locationName' => 'ResourcePendingMaintenanceActions', ], ], 'PendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'PendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActions', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'PendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'DBInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PendingCloudwatchLogsExports' => [ 'shape' => 'PendingCloudwatchLogsExports', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'BooleanOptional', ], 'AutomationMode' => [ 'shape' => 'AutomationMode', ], 'ResumeFullAutomationModeTime' => [ 'shape' => 'TStamp', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'Engine' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'MultiTenant' => [ 'shape' => 'BooleanOptional', ], ], ], 'PerformanceInsightsMetricDimensionGroup' => [ 'type' => 'structure', 'members' => [ 'Dimensions' => [ 'shape' => 'StringList', ], 'Group' => [ 'shape' => 'String', ], 'Limit' => [ 'shape' => 'Integer', ], ], ], 'PerformanceInsightsMetricQuery' => [ 'type' => 'structure', 'members' => [ 'GroupBy' => [ 'shape' => 'PerformanceInsightsMetricDimensionGroup', ], 'Metric' => [ 'shape' => 'String', ], ], ], 'PerformanceIssueDetails' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Metrics' => [ 'shape' => 'MetricList', ], 'Analysis' => [ 'shape' => 'String', ], ], ], 'PointInTimeRestoreNotEnabledFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'PointInTimeRestoreNotEnabled', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ProcessorFeature' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'ProcessorFeatureList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessorFeature', 'locationName' => 'ProcessorFeature', ], ], 'PromoteReadReplicaDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'PromoteReadReplicaDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'PromoteReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], ], ], 'PromoteReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ProvisionedIopsNotAvailableInAZFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ProvisionedIopsNotAvailableInAZFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'PurchaseReservedDBInstancesOfferingMessage' => [ 'type' => 'structure', 'required' => [ 'ReservedDBInstancesOfferingId', ], 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'DBInstanceCount' => [ 'shape' => 'IntegerOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PurchaseReservedDBInstancesOfferingResult' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstance' => [ 'shape' => 'ReservedDBInstance', ], ], ], 'Range' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'Integer', ], 'To' => [ 'shape' => 'Integer', ], 'Step' => [ 'shape' => 'IntegerOptional', ], ], ], 'RangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Range', 'locationName' => 'Range', ], ], 'RdsCustomClusterConfiguration' => [ 'type' => 'structure', 'members' => [ 'InterconnectSubnetId' => [ 'shape' => 'String', ], 'TransitGatewayMulticastDomainId' => [ 'shape' => 'String', ], 'ReplicaMode' => [ 'shape' => 'ReplicaMode', ], ], ], 'ReadReplicaDBClusterIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaDBClusterIdentifier', ], ], 'ReadReplicaDBInstanceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaDBInstanceIdentifier', ], ], 'ReadReplicaIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaIdentifier', ], ], 'ReadersArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RebootDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'RebootDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RebootDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'ForceFailover' => [ 'shape' => 'BooleanOptional', ], ], ], 'RebootDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RebootDBShardGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBShardGroupIdentifier', ], 'members' => [ 'DBShardGroupIdentifier' => [ 'shape' => 'DBShardGroupIdentifier', ], ], ], 'RecommendedAction' => [ 'type' => 'structure', 'members' => [ 'ActionId' => [ 'shape' => 'String', ], 'Title' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Operation' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'RecommendedActionParameterList', ], 'ApplyModes' => [ 'shape' => 'StringList', ], 'Status' => [ 'shape' => 'String', ], 'IssueDetails' => [ 'shape' => 'IssueDetails', ], 'ContextAttributes' => [ 'shape' => 'ContextAttributeList', ], ], ], 'RecommendedActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendedAction', ], ], 'RecommendedActionParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'RecommendedActionParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendedActionParameter', ], ], 'RecommendedActionUpdate' => [ 'type' => 'structure', 'required' => [ 'ActionId', 'Status', ], 'members' => [ 'ActionId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'RecommendedActionUpdateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendedActionUpdate', ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', 'locationName' => 'RecurringCharge', ], ], 'ReferenceDetails' => [ 'type' => 'structure', 'members' => [ 'ScalarReferenceDetails' => [ 'shape' => 'ScalarReferenceDetails', ], ], ], 'RegisterDBProxyTargetsRequest' => [ 'type' => 'structure', 'required' => [ 'DBProxyName', ], 'members' => [ 'DBProxyName' => [ 'shape' => 'String', ], 'TargetGroupName' => [ 'shape' => 'String', ], 'DBInstanceIdentifiers' => [ 'shape' => 'StringList', ], 'DBClusterIdentifiers' => [ 'shape' => 'StringList', ], ], ], 'RegisterDBProxyTargetsResponse' => [ 'type' => 'structure', 'members' => [ 'DBProxyTargets' => [ 'shape' => 'TargetList', ], ], ], 'RemoveFromGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'DbClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveFromGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'RemoveRoleFromDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'RoleArn', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'RemoveRoleFromDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'RoleArn', 'FeatureName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'RemoveTagsFromResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'TagKeys', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'TagKeys' => [ 'shape' => 'KeyList', ], ], ], 'ReplicaMode' => [ 'type' => 'string', 'enum' => [ 'open-read-only', 'mounted', ], ], 'ReservedDBInstance' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'DBInstanceCount' => [ 'shape' => 'Integer', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'State' => [ 'shape' => 'String', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], 'ReservedDBInstanceArn' => [ 'shape' => 'String', ], 'LeaseId' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'ReservedDBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceAlreadyExists', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedDBInstance', 'locationName' => 'ReservedDBInstance', ], ], 'ReservedDBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedDBInstances' => [ 'shape' => 'ReservedDBInstanceList', ], ], ], 'ReservedDBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstancesOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], 'wrapper' => true, ], 'ReservedDBInstancesOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedDBInstancesOffering', 'locationName' => 'ReservedDBInstancesOffering', ], ], 'ReservedDBInstancesOfferingMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferings' => [ 'shape' => 'ReservedDBInstancesOfferingList', ], ], ], 'ReservedDBInstancesOfferingNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstancesOfferingNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResetDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResetDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ResourceNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourcePendingMaintenanceActions' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'PendingMaintenanceActionDetails' => [ 'shape' => 'PendingMaintenanceActionDetails', ], ], 'wrapper' => true, ], 'RestoreDBClusterFromS3Message' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', 'MasterUsername', 'SourceEngine', 'SourceEngineVersion', 'S3BucketName', 'S3IngestionRoleArn', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'SourceEngine' => [ 'shape' => 'String', ], 'SourceEngineVersion' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'S3IngestionRoleArn' => [ 'shape' => 'String', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], ], 'RestoreDBClusterFromS3Result' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SnapshotIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], ], 'RestoreDBClusterFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreType' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreToTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'EngineMode' => [ 'shape' => 'String', ], 'DBClusterInstanceClass' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'ServerlessV2ScalingConfiguration' => [ 'shape' => 'ServerlessV2ScalingConfiguration', ], 'NetworkType' => [ 'shape' => 'String', ], 'SourceDbClusterResourceId' => [ 'shape' => 'String', ], 'RdsCustomClusterConfiguration' => [ 'shape' => 'RdsCustomClusterConfiguration', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], ], 'RestoreDBClusterToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBInstanceFromDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Domain' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'BackupTarget' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], ], 'RestoreDBInstanceFromDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreDBInstanceFromS3Message' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', 'SourceEngine', 'SourceEngineVersion', 'S3BucketName', 'S3IngestionRoleArn', ], 'members' => [ 'DBName' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'SourceEngine' => [ 'shape' => 'String', ], 'SourceEngineVersion' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'S3IngestionRoleArn' => [ 'shape' => 'String', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'ManageMasterUserPassword' => [ 'shape' => 'BooleanOptional', ], 'MasterUserSecretKmsKeyId' => [ 'shape' => 'String', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], ], 'RestoreDBInstanceFromS3Result' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreDBInstanceToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'TargetDBInstanceIdentifier', ], 'members' => [ 'SourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], 'RestoreTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'DomainFqdn' => [ 'shape' => 'String', ], 'DomainOu' => [ 'shape' => 'String', ], 'DomainAuthSecretArn' => [ 'shape' => 'String', ], 'DomainDnsIps' => [ 'shape' => 'StringList', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'SourceDbiResourceId' => [ 'shape' => 'String', ], 'MaxAllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'SourceDBInstanceAutomatedBackupsArn' => [ 'shape' => 'String', ], 'EnableCustomerOwnedIp' => [ 'shape' => 'BooleanOptional', ], 'CustomIamInstanceProfile' => [ 'shape' => 'String', ], 'BackupTarget' => [ 'shape' => 'String', ], 'NetworkType' => [ 'shape' => 'String', ], 'StorageThroughput' => [ 'shape' => 'IntegerOptional', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DedicatedLogVolume' => [ 'shape' => 'BooleanOptional', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'EngineLifecycleSupport' => [ 'shape' => 'String', ], ], ], 'RestoreDBInstanceToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreWindow' => [ 'type' => 'structure', 'members' => [ 'EarliestTime' => [ 'shape' => 'TStamp', ], 'LatestTime' => [ 'shape' => 'TStamp', ], ], ], 'RevokeDBSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'RevokeDBSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'SNSInvalidTopicFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSInvalidTopic', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSNoAuthorizationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSNoAuthorization', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSTopicArnNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSTopicArnNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ScalarReferenceDetails' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'Double', ], ], ], 'ScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'IntegerOptional', ], 'MaxCapacity' => [ 'shape' => 'IntegerOptional', ], 'AutoPause' => [ 'shape' => 'BooleanOptional', ], 'SecondsUntilAutoPause' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], ], ], 'ScalingConfigurationInfo' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'IntegerOptional', ], 'MaxCapacity' => [ 'shape' => 'IntegerOptional', ], 'AutoPause' => [ 'shape' => 'BooleanOptional', ], 'SecondsUntilAutoPause' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], ], ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'ServerlessV2ScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'DoubleOptional', ], 'MaxCapacity' => [ 'shape' => 'DoubleOptional', ], ], ], 'ServerlessV2ScalingConfigurationInfo' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'DoubleOptional', ], 'MaxCapacity' => [ 'shape' => 'DoubleOptional', ], ], ], 'SharedSnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SharedSnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceArn' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:rds(-[a-z]*)?:[a-z0-9\\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*', ], 'SourceClusterNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceClusterNotSupportedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceDatabaseNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceDatabaseNotSupportedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SourceId', ], ], 'SourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SourceRegion' => [ 'type' => 'structure', 'members' => [ 'RegionName' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'SupportsDBInstanceAutomatedBackupsReplication' => [ 'shape' => 'Boolean', ], ], ], 'SourceRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceRegion', 'locationName' => 'SourceRegion', ], ], 'SourceRegionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'SourceRegions' => [ 'shape' => 'SourceRegionList', ], ], ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'db-instance', 'db-parameter-group', 'db-security-group', 'db-snapshot', 'db-cluster', 'db-cluster-snapshot', 'custom-engine-version', 'db-proxy', 'blue-green-deployment', ], ], 'StartActivityStreamRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Mode', 'KmsKeyId', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'Mode' => [ 'shape' => 'ActivityStreamMode', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'BooleanOptional', ], 'EngineNativeAuditFieldsIncluded' => [ 'shape' => 'BooleanOptional', ], ], ], 'StartActivityStreamResponse' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'String', ], 'KinesisStreamName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ActivityStreamStatus', ], 'Mode' => [ 'shape' => 'ActivityStreamMode', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'EngineNativeAuditFieldsIncluded' => [ 'shape' => 'BooleanOptional', ], ], ], 'StartDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StartDBInstanceAutomatedBackupsReplicationMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBInstanceArn', ], 'members' => [ 'SourceDBInstanceArn' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], ], ], 'StartDBInstanceAutomatedBackupsReplicationResult' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackup' => [ 'shape' => 'DBInstanceAutomatedBackup', ], ], ], 'StartDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'StartExportTaskMessage' => [ 'type' => 'structure', 'required' => [ 'ExportTaskIdentifier', 'SourceArn', 'S3BucketName', 'IamRoleArn', 'KmsKeyId', ], 'members' => [ 'ExportTaskIdentifier' => [ 'shape' => 'String', ], 'SourceArn' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'IamRoleArn' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'ExportOnly' => [ 'shape' => 'StringList', ], ], ], 'StopActivityStreamRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'BooleanOptional', ], ], ], 'StopActivityStreamResponse' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'String', ], 'KinesisStreamName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ActivityStreamStatus', ], ], ], 'StopDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StopDBInstanceAutomatedBackupsReplicationMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBInstanceArn', ], 'members' => [ 'SourceDBInstanceArn' => [ 'shape' => 'String', ], ], ], 'StopDBInstanceAutomatedBackupsReplicationResult' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackup' => [ 'shape' => 'DBInstanceAutomatedBackup', ], ], ], 'StopDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'StorageQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'StorageTypeNotAvailableFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageTypeNotAvailableFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'StorageTypeNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageTypeNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'String255' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Subnet' => [ 'type' => 'structure', 'members' => [ 'SubnetIdentifier' => [ 'shape' => 'String', ], 'SubnetAvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'SubnetOutpost' => [ 'shape' => 'Outpost', ], 'SubnetStatus' => [ 'shape' => 'String', ], ], ], 'SubnetAlreadyInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetAlreadyInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetIdentifier', ], ], 'SubnetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subnet', 'locationName' => 'Subnet', ], ], 'SubscriptionAlreadyExistFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionAlreadyExist', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionCategoryNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionCategoryNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SupportedCharacterSetsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CharacterSet', 'locationName' => 'CharacterSet', ], ], 'SupportedTimezonesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Timezone', 'locationName' => 'Timezone', ], ], 'SwitchoverBlueGreenDeploymentRequest' => [ 'type' => 'structure', 'required' => [ 'BlueGreenDeploymentIdentifier', ], 'members' => [ 'BlueGreenDeploymentIdentifier' => [ 'shape' => 'BlueGreenDeploymentIdentifier', ], 'SwitchoverTimeout' => [ 'shape' => 'SwitchoverTimeout', ], ], ], 'SwitchoverBlueGreenDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'BlueGreenDeployment' => [ 'shape' => 'BlueGreenDeployment', ], ], ], 'SwitchoverDetail' => [ 'type' => 'structure', 'members' => [ 'SourceMember' => [ 'shape' => 'DatabaseArn', ], 'TargetMember' => [ 'shape' => 'DatabaseArn', ], 'Status' => [ 'shape' => 'SwitchoverDetailStatus', ], ], ], 'SwitchoverDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SwitchoverDetail', ], ], 'SwitchoverDetailStatus' => [ 'type' => 'string', ], 'SwitchoverGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', 'TargetDbClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'TargetDbClusterIdentifier' => [ 'shape' => 'DBClusterIdentifier', ], ], ], 'SwitchoverGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'SwitchoverReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'SwitchoverReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'SwitchoverTimeout' => [ 'type' => 'integer', 'min' => 30, ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'TagListMessage' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TargetDBClusterParameterGroupName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]', ], 'TargetDBInstanceClass' => [ 'type' => 'string', 'max' => 20, 'min' => 5, 'pattern' => 'db\\.[0-9a-z]{2,6}\\.[0-9a-z]{4,9}', ], 'TargetDBParameterGroupName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]', ], 'TargetEngineVersion' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[0-9A-Za-z-_.]+', ], 'TargetGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBProxyTargetGroup', ], ], 'TargetHealth' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'TargetState', ], 'Reason' => [ 'shape' => 'TargetHealthReason', ], 'Description' => [ 'shape' => 'String', ], ], ], 'TargetHealthReason' => [ 'type' => 'string', 'enum' => [ 'UNREACHABLE', 'CONNECTION_FAILED', 'AUTH_FAILURE', 'PENDING_PROXY_CAPACITY', 'INVALID_REPLICATION_STATE', ], ], 'TargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBProxyTarget', ], ], 'TargetRole' => [ 'type' => 'string', 'enum' => [ 'READ_WRITE', 'READ_ONLY', 'UNKNOWN', ], ], 'TargetState' => [ 'type' => 'string', 'enum' => [ 'REGISTERING', 'AVAILABLE', 'UNAVAILABLE', ], ], 'TargetType' => [ 'type' => 'string', 'enum' => [ 'RDS_INSTANCE', 'RDS_SERVERLESS_ENDPOINT', 'TRACKED_CLUSTER', ], ], 'TenantDatabase' => [ 'type' => 'structure', 'members' => [ 'TenantDatabaseCreateTime' => [ 'shape' => 'TStamp', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'TenantDBName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'TenantDatabaseResourceId' => [ 'shape' => 'String', ], 'TenantDatabaseARN' => [ 'shape' => 'String', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'NcharCharacterSetName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'PendingModifiedValues' => [ 'shape' => 'TenantDatabasePendingModifiedValues', ], 'TagList' => [ 'shape' => 'TagList', ], ], 'wrapper' => true, ], 'TenantDatabaseAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TenantDatabaseAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'TenantDatabaseNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TenantDatabaseNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'TenantDatabasePendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'MasterUserPassword' => [ 'shape' => 'SensitiveString', ], 'TenantDBName' => [ 'shape' => 'String', ], ], ], 'TenantDatabaseQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TenantDatabaseQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'TenantDatabasesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TenantDatabase', 'locationName' => 'TenantDatabase', ], ], 'TenantDatabasesMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'TenantDatabases' => [ 'shape' => 'TenantDatabasesList', ], ], ], 'Timezone' => [ 'type' => 'structure', 'members' => [ 'TimezoneName' => [ 'shape' => 'String', ], ], ], 'UnsupportedDBEngineVersionFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UnsupportedDBEngineVersion', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'UpgradeTarget' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'AutoUpgrade' => [ 'shape' => 'Boolean', ], 'IsMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], 'SupportsParallelQuery' => [ 'shape' => 'BooleanOptional', ], 'SupportsGlobalDatabases' => [ 'shape' => 'BooleanOptional', ], 'SupportsBabelfish' => [ 'shape' => 'BooleanOptional', ], 'SupportsLimitlessDatabase' => [ 'shape' => 'BooleanOptional', ], 'SupportsLocalWriteForwarding' => [ 'shape' => 'BooleanOptional', ], 'SupportsIntegrations' => [ 'shape' => 'BooleanOptional', ], ], ], 'UserAuthConfig' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'String', ], 'UserName' => [ 'shape' => 'String', ], 'AuthScheme' => [ 'shape' => 'AuthScheme', ], 'SecretArn' => [ 'shape' => 'String', ], 'IAMAuth' => [ 'shape' => 'IAMAuthMode', ], 'ClientPasswordAuthType' => [ 'shape' => 'ClientPasswordAuthType', ], ], ], 'UserAuthConfigInfo' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'String', ], 'UserName' => [ 'shape' => 'String', ], 'AuthScheme' => [ 'shape' => 'AuthScheme', ], 'SecretArn' => [ 'shape' => 'String', ], 'IAMAuth' => [ 'shape' => 'IAMAuthMode', ], 'ClientPasswordAuthType' => [ 'shape' => 'ClientPasswordAuthType', ], ], ], 'UserAuthConfigInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserAuthConfigInfo', ], ], 'UserAuthConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserAuthConfig', ], ], 'ValidDBInstanceModificationsMessage' => [ 'type' => 'structure', 'members' => [ 'Storage' => [ 'shape' => 'ValidStorageOptionsList', ], 'ValidProcessorFeatures' => [ 'shape' => 'AvailableProcessorFeatureList', ], 'SupportsDedicatedLogVolume' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'ValidStorageOptions' => [ 'type' => 'structure', 'members' => [ 'StorageType' => [ 'shape' => 'String', ], 'StorageSize' => [ 'shape' => 'RangeList', ], 'ProvisionedIops' => [ 'shape' => 'RangeList', ], 'IopsToStorageRatio' => [ 'shape' => 'DoubleRangeList', ], 'SupportsStorageAutoscaling' => [ 'shape' => 'Boolean', ], 'ProvisionedStorageThroughput' => [ 'shape' => 'RangeList', ], 'StorageThroughputToIopsRatio' => [ 'shape' => 'DoubleRangeList', ], ], ], 'ValidStorageOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidStorageOptions', 'locationName' => 'ValidStorageOptions', ], ], 'ValidUpgradeTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeTarget', 'locationName' => 'UpgradeTarget', ], ], 'VpcSecurityGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'VpcSecurityGroupId', ], ], 'VpcSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'VpcSecurityGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'VpcSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcSecurityGroupMembership', 'locationName' => 'VpcSecurityGroupMembership', ], ], 'WriteForwardingStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', 'enabling', 'disabling', 'unknown', ], ], ],]; diff --git a/src/data/rds/2014-10-31/docs-2.json b/src/data/rds/2014-10-31/docs-2.json index e982f29362..269758b840 100644 --- a/src/data/rds/2014-10-31/docs-2.json +++ b/src/data/rds/2014-10-31/docs-2.json @@ -337,7 +337,7 @@ "AvailabilityZones": { "base": null, "refs": { - "CreateDBClusterMessage$AvailabilityZones": "A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
", + "CreateDBClusterMessage$AvailabilityZones": "A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.
For information on AZs, see Availability Zones in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Constraints:
Can't specify more than three AZs.
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
", "DBClusterAutomatedBackup$AvailabilityZones": "The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
", "DBClusterSnapshot$AvailabilityZones": "The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
", @@ -547,7 +547,7 @@ "SourceRegion$SupportsDBInstanceAutomatedBackupsReplication": "Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
", "StartActivityStreamResponse$ApplyImmediately": "Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
", "TenantDatabase$DeletionProtection": "Specifies whether deletion protection is enabled for the DB instance.
", - "UpgradeTarget$AutoUpgrade": "Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
This parameter is dynamic, and is set by RDS.
", "UpgradeTarget$IsMajorVersionUpgrade": "Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
", "ValidDBInstanceModificationsMessage$SupportsDedicatedLogVolume": "Indicates whether a DB instance supports using a dedicated log volume (DLV).
", "ValidStorageOptions$SupportsStorageAutoscaling": "Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
" @@ -4682,7 +4682,7 @@ "CreateDBClusterMessage$DBClusterIdentifier": "The identifier for this DB cluster. This parameter is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the name of an existing DB subnet group.
Must not be default.
Example: mydbsubnetgroup
The database engine to use for this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres
The database engine to use for this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
aurora-mysql
aurora-postgresql
mysql
postgres
neptune - For information about using Amazon Neptune, see the Amazon Neptune User Guide .
The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"
For information about a specific engine, see the following topics:
Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide.
RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "CreateDBClusterMessage$MasterUsername": "The name of the master user for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
The password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Can't be specified if ManageMasterUserPassword is turned on.
Reserved for future use.
", "CreateDBClusterMessage$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "CreateDBClusterMessage$CACertificateIdentifier": "The CA certificate identifier to use for the DB cluster's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
", + "CreateDBClusterMessage$EngineLifecycleSupport": "The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB cluster parameter group.
Constraints:
Must not match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora-mysql5.7, aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql14
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres13
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mysql
postgres
The description for the DB cluster parameter group.
", @@ -4744,6 +4745,7 @@ "CreateDBInstanceMessage$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", "CreateDBInstanceMessage$CACertificateIdentifier": "The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
", "CreateDBInstanceMessage$DBSystemId": "The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term \"Oracle database instance\" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
", "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance.
Can't be specified if the SourceDBClusterIdentifier parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits the value from the source DB instance.
", @@ -4780,11 +4782,12 @@ "CreateDBSubnetGroupMessage$DBSubnetGroupDescription": "The description for the DB subnet group.
", "CreateEventSubscriptionMessage$SubscriptionName": "The name of the subscription.
Constraints: The name must be less than 255 characters.
", "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.
RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
", "CreateGlobalClusterMessage$SourceDBClusterIdentifier": "The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:
DatabaseName
Engine
EngineVersion
StorageEncrypted
The database engine to use for this global database cluster.
Valid Values: aurora-mysql | aurora-postgresql
Constraints:
Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.
The engine version to use for this global database cluster.
Constraints:
Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.
The life cycle type for this global database cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.
This setting only applies to Aurora PostgreSQL-based global databases.
You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name for your database of up to 64 alphanumeric characters. If you don't specify a name, Amazon Aurora doesn't create a database in the global database cluster.
Constraints:
Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.
", "CreateOptionGroupMessage$OptionGroupName": "Specifies the name of the option group to be created.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: myoptiongroup
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
Reserved for future use.
", "DBCluster$AwsBackupRecoveryPointArn": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
", + "DBCluster$EngineLifecycleSupport": "The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
", "DBClusterAutomatedBackup$Engine": "The name of the database engine for this automated backup.
", "DBClusterAutomatedBackup$VpcId": "The VPC ID associated with the DB cluster.
", "DBClusterAutomatedBackup$DBClusterAutomatedBackupsArn": "The Amazon Resource Name (ARN) for the automated backups.
", @@ -4944,6 +4948,7 @@ "DBInstance$DBSystemId": "The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
", "DBInstance$ReadReplicaSourceDBClusterIdentifier": "The identifier of the source DB cluster if this DB instance is a read replica.
", "DBInstance$PercentProgress": "The progress of the storage optimization operation as a percentage.
", + "DBInstance$EngineLifecycleSupport": "The life cycle type for the DB instance.
For more information, see CreateDBInstance.
", "DBInstanceAutomatedBackup$DBInstanceArn": "The Amazon Resource Name (ARN) for the automated backups.
", "DBInstanceAutomatedBackup$DbiResourceId": "The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
", "DBInstanceAutomatedBackup$Region": "The Amazon Web Services Region associated with the automated backup.
", @@ -5286,6 +5291,7 @@ "GlobalCluster$Status": "Specifies the current state of this global database cluster.
", "GlobalCluster$Engine": "The Aurora database engine used by the global database cluster.
", "GlobalCluster$EngineVersion": "Indicates the database engine version.
", + "GlobalCluster$EngineLifecycleSupport": "The life cycle type for the global cluster.
For more information, see CreateGlobalCluster.
", "GlobalCluster$DatabaseName": "The default database name within the new global database cluster.
", "GlobalClusterMember$DBClusterArn": "The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
", "GlobalClustersMessage$Marker": "An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The description for the DB subnet group.
", "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription.
", "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", - "ModifyEventSubscriptionMessage$SourceType": "The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster.
The new cluster identifier for the global database cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
The version number of the database engine to which you want to upgrade.
To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
Specifies the valid data type for the parameter.
", "Parameter$AllowedValues": "Specifies the valid range of values for the parameter.
", "Parameter$MinimumEngineVersion": "The earliest engine version to which the parameter can apply.
", - "PendingMaintenanceAction$Action": "The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.
The type of pending maintenance action that is available for the resource.
For more information about maintenance actions, see Maintaining a DB instance.
Valid Values: system-update | db-upgrade | hardware-maintenance | ca-certificate-rotation
Indicates the type of opt-in request that has been received for the resource.
", "PendingMaintenanceAction$Description": "A description providing more detail about the maintenance action.
", "PendingMaintenanceActionsMessage$Marker": "An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
", "RestoreDBClusterFromS3Message$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", "RestoreDBClusterFromS3Message$StorageType": "Specifies the storage type to be associated with the DB cluster.
Valid Values: aurora, aurora-iopt1
Default: aurora
Valid for: Aurora DB clusters only
", + "RestoreDBClusterFromS3Message$EngineLifecycleSupport": "The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier": "The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterFromSnapshotMessage$Engine": "The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", @@ -5552,6 +5559,7 @@ "RestoreDBClusterFromSnapshotMessage$DBClusterInstanceClass": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
", "RestoreDBClusterFromSnapshotMessage$StorageType": "Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterFromSnapshotMessage$NetworkType": "The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", + "RestoreDBClusterFromSnapshotMessage$EngineLifecycleSupport": "The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterToPointInTimeMessage$RestoreType": "The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier": "The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", @@ -5566,6 +5574,7 @@ "RestoreDBClusterToPointInTimeMessage$StorageType": "Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterToPointInTimeMessage$NetworkType": "The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", "RestoreDBClusterToPointInTimeMessage$SourceDbClusterResourceId": "The resource ID of the source DB cluster from which to restore.
", + "RestoreDBClusterToPointInTimeMessage$EngineLifecycleSupport": "The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DB snapshot.
Can't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
", @@ -5589,6 +5598,7 @@ "RestoreDBInstanceFromDBSnapshotMessage$NetworkType": "The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", "RestoreDBInstanceFromDBSnapshotMessage$DBClusterSnapshotIdentifier": "The identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
", + "RestoreDBInstanceFromDBSnapshotMessage$EngineLifecycleSupport": "The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
", @@ -5615,6 +5625,7 @@ "RestoreDBInstanceFromS3Message$NetworkType": "The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", "RestoreDBInstanceFromS3Message$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", "RestoreDBInstanceFromS3Message$CACertificateIdentifier": "The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
", + "RestoreDBInstanceFromS3Message$EngineLifecycleSupport": "The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
The name of the new DB instance to create.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DB instance class as the original DB instance.
", @@ -5639,6 +5650,7 @@ "RestoreDBInstanceToPointInTimeMessage$BackupTarget": "The location for storing automated backups and manual snapshots for the restored DB instance.
Valid Values:
outposts (Amazon Web Services Outposts)
region (Amazon Web Services Region)
Default: region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
", "RestoreDBInstanceToPointInTimeMessage$NetworkType": "The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values:
IPV4
DUAL
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
", + "RestoreDBInstanceToPointInTimeMessage$EngineLifecycleSupport": "The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB security group to revoke ingress from.
", "RevokeDBSecurityGroupIngressMessage$CIDRIP": "The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.
The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance\'s compute resources and storage capacity to meet your application\'s demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
Associates an Identity and Access Management (IAM) role with a DB cluster.
', 'AddRoleToDBInstance' => 'Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be available.
This command doesn\'t apply to RDS Custom.
', 'AddSourceIdentifierToSubscription' => 'Adds a source identifier to an existing RDS event notification subscription.
', 'AddTagsToResource' => 'Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
', 'ApplyPendingMaintenanceAction' => 'Applies a pending maintenance action to a resource (for example, to a DB instance).
', 'AuthorizeDBSecurityGroupIngress' => 'Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can\'t authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can\'t authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Backtracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
This action applies only to Aurora MySQL DB clusters.
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn\'t removed.
', 'CopyDBClusterParameterGroup' => 'Copies the specified DB cluster parameter group.
You can\'t copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:
KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'CopyDBParameterGroup' => 'Copies the specified DB parameter group.
You can\'t copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.
Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.
This command doesn\'t apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
', 'CopyOptionGroup' => 'Copies the specified option group.
', 'CreateBlueGreenDeployment' => 'Creates a blue/green deployment.
A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.
You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'CreateCustomDBEngineVersion' => 'Creates a custom DB engine version (CEV).
', 'CreateDBCluster' => 'Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action applies only to Aurora DB clusters.
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you\'ve created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'CreateDBClusterSnapshot' => 'Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'CreateDBInstance' => 'Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
', 'CreateDBInstanceReadReplica' => 'Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn\'t support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance operation.
All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you\'ve created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
This command doesn\'t apply to RDS Custom.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Creates a new DB proxy.
', 'CreateDBProxyEndpoint' => 'Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy\'s default VPC.
Creates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
', 'CreateDBSnapshot' => 'Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
', 'CreateEventSubscription' => 'Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don\'t specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.
For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.
For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.
', 'CreateGlobalCluster' => 'Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This operation applies only to Aurora DB clusters.
Creates a zero-ETL integration with Amazon Redshift.
', 'CreateOptionGroup' => 'Creates a new option group. You can create up to 20 option groups.
This command doesn\'t apply to RDS Custom.
', 'CreateTenantDatabase' => 'Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.
', 'DeleteBlueGreenDeployment' => 'Deletes a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'DeleteCustomDBEngineVersion' => 'Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
The MediaImport service that imports files from Amazon S3 to create CEVs isn\'t integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren\'t logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event.
For more information, see Deleting a CEV in the Amazon RDS User Guide.
', 'DeleteDBCluster' => 'The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can\'t be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
If you\'re deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DeleteDBClusterAutomatedBackup' => 'Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can\'t be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DeleteDBClusterSnapshot' => 'Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DeleteDBInstance' => 'Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can\'t be recovered. However, manual DB snapshots of the DB instance aren\'t deleted.
If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. This operation can\'t be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can\'t delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it\'s no longer a read replica. After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don\'t terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
Deletes a specified DB parameter group. The DB parameter group to be deleted can\'t be associated with any DB instances.
', 'DeleteDBProxy' => 'Deletes an existing DB proxy.
', 'DeleteDBProxyEndpoint' => 'Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy\'s default VPC.
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Deletes an Aurora Limitless Database DB shard group.
', 'DeleteDBSnapshot' => 'Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the available state to be deleted.
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
Deletes an RDS event notification subscription.
', 'DeleteGlobalCluster' => 'Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
Deletes a zero-ETL integration with Amazon Redshift.
', 'DeleteOptionGroup' => 'Deletes an existing option group.
', 'DeleteTenantDatabase' => 'Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.
You can\'t delete a tenant database when it is the only tenant in the DB instance.
', 'DeregisterDBProxyTargets' => 'Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota\'s maximum value.
This command doesn\'t take any parameters.
', 'DescribeBlueGreenDeployments' => 'Describes one or more blue/green deployments.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'DescribeCertificates' => 'Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'DescribeDBClusterAutomatedBackups' => 'Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.
All parameters are optional.
', 'DescribeDBClusterBacktracks' => 'Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DescribeDBClusterParameters' => 'Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DescribeDBClusterSnapshotAttributes' => 'Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DescribeDBClusters' => 'Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
', 'DescribeDBEngineVersions' => 'Describes the properties of specific versions of DB engines.
', 'DescribeDBInstanceAutomatedBackups' => 'Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.
All parameters are optional.
', 'DescribeDBInstances' => 'Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Returns a list of DB log files for the DB instance.
This command doesn\'t apply to RDS Custom.
', 'DescribeDBParameterGroups' => 'Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Returns the detailed parameter list for a particular DB parameter group.
', 'DescribeDBProxies' => 'Returns information about DB proxies.
', 'DescribeDBProxyEndpoints' => 'Returns information about DB proxy endpoints.
', 'DescribeDBProxyTargetGroups' => 'Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
Returns information about DBProxyTarget objects. This API supports pagination.
Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
', 'DescribeDBSecurityGroups' => 'Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Describes existing Aurora Limitless Database DB shard groups.
', 'DescribeDBSnapshotAttributes' => 'Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.
You can use this command to inspect the tenant databases within a snapshot before restoring it. You can\'t directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.
', 'DescribeDBSnapshots' => 'Returns information about DB snapshots. This API action supports pagination.
', 'DescribeDBSubnetGroups' => 'Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
', 'DescribeEngineDefaultClusterParameters' => 'Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
', 'DescribeEngineDefaultParameters' => 'Returns the default engine and system parameter information for the specified database engine.
', 'DescribeEventCategories' => 'Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
', 'DescribeEventSubscriptions' => 'Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.
By default, RDS returns events that were generated in the past hour.
Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
', 'DescribeGlobalClusters' => 'Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Describe one or more zero-ETL integrations with Amazon Redshift.
', 'DescribeOptionGroupOptions' => 'Describes all available options for the specified engine.
', 'DescribeOptionGroups' => 'Describes the available option groups.
', 'DescribeOrderableDBInstanceOptions' => 'Describes the orderable DB instance options for a specified DB engine.
', 'DescribePendingMaintenanceActions' => 'Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
', 'DescribeReservedDBInstances' => 'Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
', 'DescribeReservedDBInstancesOfferings' => 'Lists available reserved DB instance offerings.
', 'DescribeSourceRegions' => 'Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference.
Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.
', 'DescribeValidDBInstanceModifications' => 'You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
This command doesn\'t apply to RDS Custom.
', 'DisableHttpEndpoint' => 'Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn\'t apply to RDS Custom.
', 'EnableHttpEndpoint' => 'Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn\'t enabled.
When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.
Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'FailoverGlobalCluster' => 'Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."
Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.
How you use this operation depends on whether you are failing over or switching over your global database cluster:
Failing over - Specify the AllowDataLoss parameter and don\'t specify the Switchover parameter.
Switching over - Specify the Switchover parameter or omit it, but don\'t specify the AllowDataLoss parameter.
About failing over and switching over
While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:
Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn\'t replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.
Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.
For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'ModifyActivityStream' => 'Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn\'t required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
', 'ModifyCertificates' => 'Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
', 'ModifyCurrentDBClusterCapacity' => 'Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This operation only applies to Aurora Serverless v1 DB clusters.
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn\'t integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren\'t logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
', 'ModifyDBCluster' => 'Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'ModifyDBClusterEndpoint' => 'Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This operation only applies to Aurora DB clusters.
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create operation before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'ModifyDBClusterSnapshotAttribute' => 'Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.
Don\'t add the all value for any manual DB cluster snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify operation before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Changes the settings for an existing DB proxy.
', 'ModifyDBProxyEndpoint' => 'Changes the settings for an existing DB proxy endpoint.
', 'ModifyDBProxyTargetGroup' => 'Modifies the properties of a DBProxyTargetGroup.
Updates the recommendation status and recommended action status for the specified recommendation.
', 'ModifyDBShardGroup' => 'Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
', 'ModifyDBSnapshot' => 'Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn\'t apply to RDS Custom or RDS for Db2.
', 'ModifyDBSnapshotAttribute' => 'Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.
Don\'t add the all value for any manual DB snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
', 'ModifyEventSubscription' => 'Modifies an existing RDS event notification subscription. You can\'t modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora global database clusters.
Modifies a zero-ETL integration with Amazon Redshift.
Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don\'t support modifying the integration.
Modifies an existing option group.
', 'ModifyTenantDatabase' => 'Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.
', 'PromoteReadReplica' => 'Promotes a read replica DB instance to a standalone DB instance.
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.
This command doesn\'t apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
Promotes a read replica DB cluster to a standalone DB cluster.
', 'PurchaseReservedDBInstancesOffering' => 'Purchases a reserved DB instance offering.
', 'RebootDBCluster' => 'You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'RebootDBInstance' => 'You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn\'t apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect.
This operation applies only to Aurora Limitless Database DBb shard groups.
', 'RegisterDBProxyTargets' => 'Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
This operation only applies to Aurora DB clusters.
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'RemoveRoleFromDBInstance' => 'Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
', 'RemoveSourceIdentifierFromSubscription' => 'Removes a source identifier from an existing RDS event notification subscription.
', 'RemoveTagsFromResource' => 'Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'ResetDBClusterParameterGroup' => 'Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'ResetDBParameterGroup' => 'Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 operation has completed and the DB cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don\'t specify a security group, the new DB cluster is associated with the default security group.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'RestoreDBClusterToPointInTime' => 'Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime operation has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromDBSnapshot' => 'Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source\'s original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn\'t allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This operation doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTime' => 'Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
This operation doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
', 'StartDBCluster' => 'Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
This command doesn\'t apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn\'t apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
', 'StartExportTask' => 'Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.
You can\'t export snapshot data from Db2 or RDS Custom DB instances.
You can\'t export cluster data from Multi-AZ DB clusters.
For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
', 'StopActivityStream' => 'Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation.
For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
', 'StopDBCluster' => 'Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster\'s metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance\'s metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn\'t apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
Stops automated backup replication for a DB instance.
This command doesn\'t apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
', 'SwitchoverBlueGreenDeployment' => 'Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'SwitchoverGlobalCluster' => 'Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."
Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.
This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.
Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.
', ], 'shapes' => [ 'AccountAttributesMessage' => [ 'base' => 'Data returned by the DescribeAccountAttributes action.
', 'refs' => [], ], 'AccountQuota' => [ 'base' => 'Describes a quota for an Amazon Web Services account.
The following are account quotas:
AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.
AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.
CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.
DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.
DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.
DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.
DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.
DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account.
Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.
DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.
DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.
DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.
EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.
ManualClusterSnapshots - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account.
ManualSnapshots - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account.
OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.
ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.
ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.
SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.
', 'refs' => [ 'AccountQuotaList$member' => NULL, ], ], 'AccountQuotaList' => [ 'base' => NULL, 'refs' => [ 'AccountAttributesMessage$AccountQuotas' => 'A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
', 'DBInstance$ActivityStreamMode' => 'The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
', 'ModifyActivityStreamResponse$Mode' => 'The mode of the database activity stream.
', 'StartActivityStreamRequest$Mode' => 'Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
', 'StartActivityStreamResponse$Mode' => 'The mode of the database activity stream.
', ], ], 'ActivityStreamModeList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$SupportedActivityStreamModes' => 'The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn\'t supported, the return value is an empty list.
The status of the policy state of the activity stream.
', 'ModifyActivityStreamResponse$PolicyStatus' => 'The status of the modification to the policy state of the database activity stream.
', ], ], 'ActivityStreamStatus' => [ 'base' => NULL, 'refs' => [ 'DBCluster$ActivityStreamStatus' => 'The status of the database activity stream.
', 'DBInstance$ActivityStreamStatus' => 'The status of the database activity stream.
', 'ModifyActivityStreamResponse$Status' => 'The status of the modification to the database activity stream.
', 'StartActivityStreamResponse$Status' => 'The status of the database activity stream.
', 'StopActivityStreamResponse$Status' => 'The status of the database activity stream.
', ], ], 'AddRoleToDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'AddRoleToDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'AddSourceIdentifierToSubscriptionMessage' => [ 'base' => '', 'refs' => [], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsToResourceMessage' => [ 'base' => '', 'refs' => [], ], 'ApplyMethod' => [ 'base' => NULL, 'refs' => [ 'Parameter$ApplyMethod' => 'Indicates when to apply parameter updates.
', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'base' => '', 'refs' => [], ], 'ApplyPendingMaintenanceActionResult' => [ 'base' => NULL, 'refs' => [], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$TargetArn' => 'The ARN of the Redshift data warehouse to use as the target for replication.
', 'Integration$TargetArn' => 'The ARN of the Redshift data warehouse used as the target for replication.
', ], ], 'AttributeValueList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttribute$AttributeValues' => 'The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
The value or values for the manual DB snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
A list of DB snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.
The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
', ], ], 'AuthScheme' => [ 'base' => NULL, 'refs' => [ 'UserAuthConfig$AuthScheme' => 'The type of authentication that the proxy uses for connections from the proxy to the underlying database.
', 'UserAuthConfigInfo$AuthScheme' => 'The type of authentication that the proxy uses for connections from the proxy to the underlying database.
', ], ], 'AuthorizationAlreadyExistsFault' => [ 'base' => 'The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.
', 'refs' => [], ], 'AuthorizationNotFoundFault' => [ 'base' => 'The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
', 'refs' => [], ], 'AuthorizationQuotaExceededFault' => [ 'base' => 'The DB security group authorization quota has been reached.
', 'refs' => [], ], 'AuthorizeDBSecurityGroupIngressMessage' => [ 'base' => '', 'refs' => [], ], 'AuthorizeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'AutomationMode' => [ 'base' => NULL, 'refs' => [ 'DBInstance$AutomationMode' => 'The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
The automation mode of the RDS Custom DB instance. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes.
The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
A list of Availability Zones for a DB instance.
', ], ], 'AvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$AvailabilityZones' => 'A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'DBCluster$AvailabilityZones' => 'The list of Availability Zones (AZs) where instances in the DB cluster can be created.
', 'DBClusterAutomatedBackup$AvailabilityZones' => 'The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
', 'DBClusterSnapshot$AvailabilityZones' => 'The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
', 'RestoreDBClusterFromS3Message$AvailabilityZones' => 'A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
', 'RestoreDBClusterFromSnapshotMessage$AvailabilityZones' => 'Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
', ], ], 'AvailableProcessorFeature' => [ 'base' => 'Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
', 'refs' => [ 'AvailableProcessorFeatureList$member' => NULL, ], ], 'AvailableProcessorFeatureList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$AvailableProcessorFeatures' => 'A list of the available processor features for the DB instance class of a DB instance.
', 'ValidDBInstanceModificationsMessage$ValidProcessorFeatures' => 'Valid processor features for your DB instance.
', ], ], 'AwsBackupRecoveryPointArn' => [ 'base' => NULL, 'refs' => [ 'ModifyDBClusterMessage$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'ModifyDBInstanceMessage$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn\'t apply to RDS Custom DB instances.
', ], ], 'BacktrackDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'BackupPolicyNotFoundFault' => [ 'base' => NULL, 'refs' => [], ], 'BlueGreenDeployment' => [ 'base' => 'Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'refs' => [ 'BlueGreenDeploymentList$member' => NULL, 'CreateBlueGreenDeploymentResponse$BlueGreenDeployment' => NULL, 'DeleteBlueGreenDeploymentResponse$BlueGreenDeployment' => NULL, 'SwitchoverBlueGreenDeploymentResponse$BlueGreenDeployment' => NULL, ], ], 'BlueGreenDeploymentAlreadyExistsFault' => [ 'base' => 'A blue/green deployment with the specified name already exists.
', 'refs' => [], ], 'BlueGreenDeploymentIdentifier' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$BlueGreenDeploymentIdentifier' => 'The unique identifier of the blue/green deployment.
', 'DeleteBlueGreenDeploymentRequest$BlueGreenDeploymentIdentifier' => 'The unique identifier of the blue/green deployment to delete. This parameter isn\'t case-sensitive.
Constraints:
Must match an existing blue/green deployment identifier.
The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn\'t case-sensitive.
Constraints:
Must match an existing blue/green deployment identifier.
The unique identifier of the blue/green deployment.
Constraints:
Must match an existing blue/green deployment identifier.
A list of blue/green deployments in the current account and Amazon Web Services Region.
', ], ], 'BlueGreenDeploymentName' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$BlueGreenDeploymentName' => 'The user-supplied name of the blue/green deployment.
', 'CreateBlueGreenDeploymentRequest$BlueGreenDeploymentName' => 'The name of the blue/green deployment.
Constraints:
Can\'t be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
BlueGreenDeploymentIdentifier doesn\'t refer to an existing blue/green deployment.
The status of the blue/green deployment.
Valid Values:
PROVISIONING - Resources are being created in the green environment.
AVAILABLE - Resources are available in the green environment.
SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.
SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.
INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn\'t possible.
SWITCHOVER_FAILED - Switchover was attempted but failed.
DELETING - The blue/green deployment is being deleted.
Additional information about the status of the blue/green deployment.
', ], ], 'BlueGreenDeploymentTask' => [ 'base' => 'Details about a task for a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'refs' => [ 'BlueGreenDeploymentTaskList$member' => NULL, ], ], 'BlueGreenDeploymentTaskList' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$Tasks' => 'Either tasks to be performed or tasks that have been completed on the target database before switchover.
', ], ], 'BlueGreenDeploymentTaskName' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeploymentTask$Name' => 'The name of the blue/green deployment task.
', ], ], 'BlueGreenDeploymentTaskStatus' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeploymentTask$Status' => 'The status of the blue/green deployment task.
Valid Values:
PENDING - The resource is being prepared for deployment.
IN_PROGRESS - The resource is being deployed.
COMPLETED - The resource has been deployed.
FAILED - Deployment of the resource failed.
Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
', 'CreateDBProxyRequest$DebugLogging' => 'Specifies whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
', 'DBCluster$StorageEncrypted' => 'Indicates whether the DB cluster is encrypted.
', 'DBCluster$AutoMinorVersionUpgrade' => 'Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterAutomatedBackup$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'DBClusterAutomatedBackup$StorageEncrypted' => 'Indicates whether the source DB cluster is encrypted.
', 'DBClusterMember$IsClusterWriter' => 'Indicates whether the cluster member is the primary DB instance for the DB cluster.
', 'DBClusterSnapshot$StorageEncrypted' => 'Indicates whether the DB cluster snapshot is encrypted.
', 'DBClusterSnapshot$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'DBClusterStatusInfo$Normal' => 'Reserved for future use.
', 'DBEngineVersion$SupportsLogExportsToCloudwatchLogs' => 'Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
', 'DBEngineVersion$SupportsReadReplica' => 'Indicates whether the database engine version supports read replicas.
', 'DBEngineVersion$SupportsParallelQuery' => 'Indicates whether you can use Aurora parallel query with a specific DB engine version.
', 'DBEngineVersion$SupportsGlobalDatabases' => 'Indicates whether you can use Aurora global databases with a specific DB engine version.
', 'DBEngineVersion$SupportsBabelfish' => 'Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
', 'DBEngineVersion$SupportsLimitlessDatabase' => 'Indicates whether the DB engine version supports Aurora Limitless Database.
', 'DBEngineVersion$SupportsIntegrations' => 'Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
', 'DBInstance$MultiAZ' => 'Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn\'t apply to RDS Custom DB instances.
', 'DBInstance$AutoMinorVersionUpgrade' => 'Indicates whether minor version patches are applied automatically.
', 'DBInstance$PubliclyAccessible' => 'Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'DBInstance$StorageEncrypted' => 'Indicates whether the DB instance is encrypted.
', 'DBInstance$CopyTagsToSnapshot' => 'Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn\'t apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
', 'DBInstance$DeletionProtection' => 'Indicates whether the DB instance has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
', 'DBInstance$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'DBInstanceAutomatedBackup$Encrypted' => 'Indicates whether the automated backup is encrypted.
', 'DBInstanceAutomatedBackup$IAMDatabaseAuthenticationEnabled' => 'True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
', 'DBInstanceStatusInfo$Normal' => 'Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).
', 'DBProxy$RequireTLS' => 'Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
', 'DBProxy$DebugLogging' => 'Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
', 'DBProxyEndpoint$IsDefault' => 'Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
', 'DBProxyTargetGroup$IsDefault' => 'Indicates whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.
Indicates whether the DB snapshot is encrypted.
', 'DBSnapshot$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'DBSnapshot$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'DeleteDBClusterMessage$SkipFinalSnapshot' => 'Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn\'t specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn\'t specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
Specifies whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn\'t create a DB snapshot. If you don\'t enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn\'t enabled, and the DB snapshot is created.
If you don\'t enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
', 'DeleteTenantDatabaseMessage$SkipFinalSnapshot' => 'Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB instance. If you enable this parameter, RDS doesn\'t create a DB snapshot. If you don\'t enable this parameter, RDS creates a DB snapshot before it deletes the tenant database. By default, RDS doesn\'t skip the final snapshot. If you don\'t enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
', 'DescribeDBClustersMessage$IncludeShared' => 'Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
', 'DescribeDBEngineVersionsMessage$DefaultOnly' => 'Specifies whether to return only the default version of the specified engine or the engine and major version combination.
', 'DescribeDBSnapshotsMessage$IncludeShared' => 'Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn\'t apply to RDS Custom.
', 'DescribeDBSnapshotsMessage$IncludePublic' => 'Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn\'t apply to RDS Custom.
', 'DisableHttpEndpointResponse$HttpEndpointEnabled' => 'Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.
', 'DownloadDBLogFilePortionDetails$AdditionalDataPending' => 'A Boolean value that, if true, indicates there is more data to be downloaded.
', 'EnableHttpEndpointResponse$HttpEndpointEnabled' => 'Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.
', 'EventSubscription$Enabled' => 'Specifies whether the subscription is enabled. True indicates the subscription is enabled.
', 'FailoverState$IsDataLossAllowed' => 'Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it\'s a switchover.
', 'GlobalClusterMember$IsWriter' => 'Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.
', 'ModifyDBClusterMessage$ApplyImmediately' => 'Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$AllowMajorVersionUpgrade' => 'Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster\'s current version.
Specifies whether engine mode changes from serverless to provisioned are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster\'s current engine mode.
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
Specifies whether major version upgrades are allowed. Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that\'s a different major version than the DB instance\'s current version.
Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
', 'Option$Persistent' => 'Indicates whether this option is persistent.
', 'Option$Permanent' => 'Indicates whether this option is permanent.
', 'OptionGroup$AllowsVpcAndNonVpcInstanceMemberships' => 'Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
Indicates whether the option requires a port.
', 'OptionGroupOption$Persistent' => 'Persistent options can\'t be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
', 'OptionGroupOption$Permanent' => 'Permanent options can never be removed from an option group. An option group containing a permanent option can\'t be removed from a DB instance.
', 'OptionGroupOption$RequiresAutoMinorEngineVersionUpgrade' => 'If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
', 'OptionGroupOption$VpcOnly' => 'If true, you can only use this option with a DB instance that is in a VPC.
', 'OptionGroupOptionSetting$IsModifiable' => 'Indicates whether this option group option can be changed from the default value.
', 'OptionGroupOptionSetting$IsRequired' => 'Indicates whether a value must be specified for this option setting of the option group option.
', 'OptionSetting$IsModifiable' => 'Indicates whether the option setting can be modified from the default.
', 'OptionSetting$IsCollection' => 'Indicates whether the option setting is part of a collection.
', 'OptionVersion$IsDefault' => 'Indicates whether the version is the default version of the option.
', 'OrderableDBInstanceOption$MultiAZCapable' => 'Indicates whether a DB instance is Multi-AZ capable.
', 'OrderableDBInstanceOption$ReadReplicaCapable' => 'Indicates whether a DB instance can have a read replica.
', 'OrderableDBInstanceOption$Vpc' => 'Indicates whether a DB instance is in a VPC.
', 'OrderableDBInstanceOption$SupportsStorageEncryption' => 'Indicates whether a DB instance supports encrypted storage.
', 'OrderableDBInstanceOption$SupportsIops' => 'Indicates whether a DB instance supports provisioned IOPS.
', 'OrderableDBInstanceOption$SupportsEnhancedMonitoring' => 'Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
', 'OrderableDBInstanceOption$SupportsIAMDatabaseAuthentication' => 'Indicates whether a DB instance supports IAM database authentication.
', 'OrderableDBInstanceOption$SupportsPerformanceInsights' => 'Indicates whether a DB instance supports Performance Insights.
', 'OrderableDBInstanceOption$OutpostCapable' => 'Indicates whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'OrderableDBInstanceOption$SupportsGlobalDatabases' => 'Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
', 'OrderableDBInstanceOption$SupportsClusters' => 'Indicates whether DB instances can be configured as a Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
', 'OrderableDBInstanceOption$SupportsStorageThroughput' => 'Indicates whether a DB instance supports storage throughput.
', 'OrderableDBInstanceOption$SupportsDedicatedLogVolume' => 'Indicates whether a DB instance supports using a dedicated log volume (DLV).
', 'Parameter$IsModifiable' => 'Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
Indicates whether the reservation applies to Multi-AZ deployments.
', 'ReservedDBInstancesOffering$MultiAZ' => 'Indicates whether the offering applies to Multi-AZ deployments.
', 'ResetDBClusterParameterGroupMessage$ResetAllParameters' => 'Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can\'t use this parameter if there is a list of parameter names specified for the Parameters parameter.
Specifies whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
', 'RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime' => 'Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn\'t restored to the latest restorable backup time.
Constraints: Can\'t be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBInstanceToPointInTimeMessage$UseLatestRestorableTime' => 'Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn\'t restored from the latest backup time.
Constraints:
Can\'t be specified if the RestoreTime parameter is provided.
Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
', 'StartActivityStreamResponse$ApplyImmediately' => 'Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
', 'TenantDatabase$DeletionProtection' => 'Specifies whether deletion protection is enabled for the DB instance.
', 'UpgradeTarget$AutoUpgrade' => 'Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
', 'ValidDBInstanceModificationsMessage$SupportsDedicatedLogVolume' => 'Indicates whether a DB instance supports using a dedicated log volume (DLV).
', 'ValidStorageOptions$SupportsStorageAutoscaling' => 'Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'BacktrackDBClusterMessage$Force' => 'Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
', 'BacktrackDBClusterMessage$UseEarliestTimeOnPointInTimeUnavailable' => 'Specifies whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
', 'Certificate$CustomerOverride' => 'Indicates whether there is an override for the default certificate identifier.
', 'ClusterPendingModifiedValues$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'CopyDBClusterSnapshotMessage$CopyTags' => 'Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
', 'CopyDBSnapshotMessage$CopyTags' => 'Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren\'t copied.
', 'CopyDBSnapshotMessage$CopyOptionGroup' => 'Specifies whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.
', 'CreateBlueGreenDeploymentRequest$UpgradeTargetStorageConfig' => 'Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see Upgrading the storage file system for a DB instance.
', 'CreateCustomDBEngineVersionMessage$UseAwsProvidedLatestImage' => 'Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can\'t also specify ImageId.
Specifies whether the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$DeletionProtection' => 'Specifies whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$EnableHttpEndpoint' => 'Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn\'t enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
RDS Data API is supported with the following DB clusters:
Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$EnableGlobalWriteForwarding' => 'Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$PubliclyAccessible' => 'Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$EnablePerformanceInsights' => 'Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$EnableLimitlessDatabase' => 'Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
', 'CreateDBClusterMessage$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren\'t allowed on reader DB instances.
Valid for: Aurora DB clusters only
', 'CreateDBInstanceMessage$MultiAZ' => 'Specifies whether the DB instance is a Multi-AZ deployment. You can\'t set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
RDS Custom
Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
Specifes whether the DB instance is encrypted. By default, it isn\'t encrypted.
For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.
This setting doesn\'t apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.
', 'CreateDBInstanceMessage$CopyTagsToSnapshot' => 'Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn\'t apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
', 'CreateDBInstanceMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)
RDS Custom
Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$DeletionProtection' => 'Specifies whether the DB instance has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
This setting doesn\'t apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'CreateDBInstanceMessage$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'CreateDBInstanceMessage$MultiTenant' => 'Specifies whether to use the multi-tenant configuration or the single-tenant configuration (default). This parameter only applies to RDS for Oracle container database (CDB) engines.
Note the following restrictions:
The DB engine that you specify in the request must support the multi-tenant configuration. If you attempt to enable the multi-tenant configuration on a DB engine that doesn\'t support it, the request fails.
If you specify the multi-tenant configuration when you create your DB instance, you can\'t later modify this DB instance to use the single-tenant configuration.
Specifies whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade' => 'Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.
This setting doesn\'t apply to RDS Custom DB instances.
Default: Inherits the value from the source DB instance.
', 'CreateDBInstanceReadReplicaMessage$PubliclyAccessible' => 'Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren\'t copied.
', 'CreateDBInstanceReadReplicaMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights' => 'Specifies whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB instance. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
', 'CreateDBInstanceReadReplicaMessage$EnableCustomerOwnedIp' => 'Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'CreateDBInstanceReadReplicaMessage$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'CreateDBInstanceReadReplicaMessage$UpgradeStorageConfig' => 'Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.
', 'CreateDBShardGroupMessage$PubliclyAccessible' => 'Specifies whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group\'s VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn\'t permit it.
When the DB shard group isn\'t publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
Specifies whether to activate the subscription. If the event notification subscription isn\'t activated, the subscription is created but not active.
', 'CreateGlobalClusterMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the new global database cluster. The global database can\'t be deleted when deletion protection is enabled.
', 'CreateGlobalClusterMessage$StorageEncrypted' => 'Specifies whether to enable storage encryption for the new global database cluster.
Constraints:
Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.
Indicates whether the DB cluster has instances in multiple Availability Zones.
', 'DBCluster$IAMDatabaseAuthenticationEnabled' => 'Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'DBCluster$DeletionProtection' => 'Indicates whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled.
', 'DBCluster$HttpEndpointEnabled' => 'Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
', 'DBCluster$CopyTagsToSnapshot' => 'Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
', 'DBCluster$CrossAccountClone' => 'Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
', 'DBCluster$GlobalWriteForwardingRequested' => 'Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$PerformanceInsightsEnabled' => 'Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBEngineVersion$SupportsCertificateRotationWithoutRestart' => 'Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
', 'DBEngineVersion$SupportsLocalWriteForwarding' => 'Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren\'t allowed on reader DB instances.
Valid for: Aurora DB clusters only
', 'DBInstance$PerformanceInsightsEnabled' => 'Indicates whether Performance Insights is enabled for the DB instance.
', 'DBInstance$CustomerOwnedIpEnabled' => 'Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'DBInstance$ActivityStreamEngineNativeAuditFieldsIncluded' => 'Indicates whether engine-native audit fields are included in the database activity stream.
', 'DBInstance$IsStorageConfigUpgradeAvailable' => 'Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
', 'DBInstance$MultiTenant' => 'Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
', 'DBInstanceAutomatedBackup$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'DBInstanceAutomatedBackup$MultiTenant' => 'Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
', 'DBShardGroup$PubliclyAccessible' => 'Indicates whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group\'s VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB shard group doesn\'t permit it.
When the DB shard group isn\'t publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
For more information, see CreateDBShardGroup.
This setting is only for Aurora Limitless Database.
', 'DBSnapshot$MultiTenant' => 'Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
', 'DeleteBlueGreenDeploymentRequest$DeleteTarget' => 'Specifies whether to delete the resources in the green environment. You can\'t specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.
Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn\'t case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.
', 'DeleteDBInstanceMessage$DeleteAutomatedBackups' => 'Specifies whether to remove automated backups immediately after the DB instance is deleted. This parameter isn\'t case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
', 'DescribeDBEngineVersionsMessage$ListSupportedCharacterSets' => 'Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
', 'DescribeDBEngineVersionsMessage$ListSupportedTimezones' => 'Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
', 'DescribeDBEngineVersionsMessage$IncludeAll' => 'Specifies whether to also list the engine versions that aren\'t available. The default is to list only available engine versions.
', 'DescribeOrderableDBInstanceOptionsMessage$Vpc' => 'Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
', 'DescribeReservedDBInstancesMessage$MultiAZ' => 'Specifies whether to show only those reservations that support Multi-AZ.
', 'DescribeReservedDBInstancesOfferingsMessage$MultiAZ' => 'Specifies whether to show only those reservations that support Multi-AZ.
', 'FailoverGlobalClusterMessage$AllowDataLoss' => 'Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.
If you don\'t specify AllowDataLoss, the global database cluster operation defaults to a switchover.
Constraints:
Can\'t be specified together with the Switchover parameter.
Specifies whether to switch over this global database cluster.
Constraints:
Can\'t be specified together with the AllowDataLoss parameter.
The storage encryption setting for the global database cluster.
', 'GlobalCluster$DeletionProtection' => 'The deletion protection setting for the new global database cluster.
', 'ModifyActivityStreamResponse$EngineNativeAuditFieldsIncluded' => 'Indicates whether engine-native audit fields are included in the database activity stream.
', 'ModifyCertificatesMessage$RemoveCustomerOverride' => 'Specifies whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
', 'ModifyDBClusterMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$DeletionProtection' => 'Specifies whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$EnableHttpEndpoint' => 'Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn\'t enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$EnableGlobalWriteForwarding' => 'Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$AutoMinorVersionUpgrade' => 'Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$EnablePerformanceInsights' => 'Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn\'t manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can\'t specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$RotateMasterUserPassword' => 'Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren\'t allowed on reader DB instances.
Valid for: Aurora DB clusters only
', 'ModifyDBClusterMessage$EnableLimitlessDatabase' => 'Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
', 'ModifyDBInstanceMessage$MultiAZ' => 'Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn\'t result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$AutoMinorVersionUpgrade' => 'Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn\'t met, Amazon RDS applies the change as soon as possible and doesn\'t cause an outage.
For an RDS Custom DB instance, don\'t enable this setting. Otherwise, the operation returns an error.
', 'ModifyDBInstanceMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren\'t copied.
This setting doesn\'t apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.
Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
Specifies whether to remove the DB instance from the Active Directory domain.
', 'ModifyDBInstanceMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
This setting doesn\'t apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$EnablePerformanceInsights' => 'Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$DeletionProtection' => 'Specifies whether the DB instance has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
This setting doesn\'t apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see ModifyDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$EnableCustomerOwnedIp' => 'Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'ModifyDBInstanceMessage$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB instance doesn\'t manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can\'t specify MasterUserPassword.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'ModifyDBInstanceMessage$MultiTenant' => 'Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user name, character set, and national character set metadata with this database. The tags associated with the instance also propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the CreateTenantDatabase operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can\'t later convert back to the single-tenant configuration. When you specify this parameter, you must also specify ApplyImmediately.
Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn\'t use TLS.
', 'ModifyDBProxyRequest$DebugLogging' => 'Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
', 'ModifyEventSubscriptionMessage$Enabled' => 'Specifies whether to activate the subscription.
', 'ModifyGlobalClusterMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the global database cluster. The global database cluster can\'t be deleted when deletion protection is enabled.
', 'ModifyGlobalClusterMessage$AllowMajorVersionUpgrade' => 'Specifies whether to allow major version upgrades.
Constraints: Must be enabled if you specify a value for the EngineVersion parameter that\'s a different major version than the global cluster\'s current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
', 'OptionGroupOption$SupportsOptionVersionDowngrade' => 'If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
', 'OptionGroupOption$CopyableCrossAccount' => 'Indicates whether the option can be copied across Amazon Web Services accounts.
', 'OrderableDBInstanceOption$SupportsStorageAutoscaling' => 'Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
', 'OrderableDBInstanceOption$SupportsKerberosAuthentication' => 'Indicates whether a DB instance supports Kerberos Authentication.
', 'PendingModifiedValues$MultiAZ' => 'Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
', 'PendingModifiedValues$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'PendingModifiedValues$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>
', 'PendingModifiedValues$MultiTenant' => 'Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
', 'RebootDBInstanceMessage$ForceFailover' => 'Specifies whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can\'t enable force failover if the instance isn\'t configured for Multi-AZ.
', 'RestoreDBClusterFromS3Message$StorageEncrypted' => 'Specifies whether the restored DB cluster is encrypted.
', 'RestoreDBClusterFromS3Message$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
', 'RestoreDBClusterFromS3Message$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB cluster. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
', 'RestoreDBClusterFromS3Message$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
', 'RestoreDBClusterFromS3Message$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB cluster. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$PubliclyAccessible' => 'Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB cluster. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$PubliclyAccessible' => 'Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
', 'RestoreDBInstanceFromDBSnapshotMessage$MultiAZ' => 'Specifies whether the DB instance is a Multi-AZ deployment.
This setting doesn\'t apply to RDS Custom.
Constraint: You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade' => 'Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
', 'RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren\'t copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromDBSnapshotMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB instance. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
', 'RestoreDBInstanceFromDBSnapshotMessage$EnableCustomerOwnedIp' => 'Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn\'t apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'RestoreDBInstanceFromDBSnapshotMessage$DedicatedLogVolume' => 'Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
', 'RestoreDBInstanceFromS3Message$MultiAZ' => 'Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can\'t set the AvailabilityZone parameter.
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
', 'RestoreDBInstanceFromS3Message$PubliclyAccessible' => 'Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'RestoreDBInstanceFromS3Message$StorageEncrypted' => 'Specifies whether the new DB instance is encrypted or not.
', 'RestoreDBInstanceFromS3Message$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
', 'RestoreDBInstanceFromS3Message$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$EnablePerformanceInsights' => 'Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
', 'RestoreDBInstanceFromS3Message$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB instance. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
', 'RestoreDBInstanceFromS3Message$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
', 'RestoreDBInstanceToPointInTimeMessage$MultiAZ' => 'Secifies whether the DB instance is a Multi-AZ deployment.
This setting doesn\'t apply to RDS Custom.
Constraints:
You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade' => 'Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
', 'RestoreDBInstanceToPointInTimeMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
This setting doesn\'t apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$DeletionProtection' => 'Specifies whether the DB instance has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
', 'RestoreDBInstanceToPointInTimeMessage$EnableCustomerOwnedIp' => 'Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn\'t apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$DedicatedLogVolume' => 'Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
', 'ScalingConfiguration$AutoPause' => 'Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it\'s idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
', 'StartActivityStreamRequest$ApplyImmediately' => 'Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
', 'StartActivityStreamRequest$EngineNativeAuditFieldsIncluded' => 'Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
', 'StartActivityStreamResponse$EngineNativeAuditFieldsIncluded' => 'Indicates whether engine-native audit fields are included in the database activity stream.
', 'StopActivityStreamRequest$ApplyImmediately' => 'Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
', 'UpgradeTarget$SupportsParallelQuery' => 'Indicates whether you can use Aurora parallel query with the target engine version.
', 'UpgradeTarget$SupportsGlobalDatabases' => 'Indicates whether you can use Aurora global databases with the target engine version.
', 'UpgradeTarget$SupportsBabelfish' => 'Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
', 'UpgradeTarget$SupportsLimitlessDatabase' => 'Indicates whether the DB engine version supports Aurora Limitless Database.
', 'UpgradeTarget$SupportsLocalWriteForwarding' => 'Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren\'t allowed on reader DB instances.
Valid for: Aurora DB clusters only
', 'UpgradeTarget$SupportsIntegrations' => 'Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'CreateCustomDBEngineVersionMessage$DatabaseInstallationFilesS3BucketName' => 'The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', ], ], 'CancelExportTaskMessage' => [ 'base' => NULL, 'refs' => [], ], 'Certificate' => [ 'base' => 'A CA certificate for an Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'refs' => [ 'CertificateList$member' => NULL, 'ModifyCertificatesResult$Certificate' => NULL, ], ], 'CertificateDetails' => [ 'base' => 'Returns the details of the DB instance’s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'refs' => [ 'ClusterPendingModifiedValues$CertificateDetails' => NULL, 'DBCluster$CertificateDetails' => NULL, 'DBInstance$CertificateDetails' => 'The details of the DB instance\'s server certificate.
', ], ], 'CertificateList' => [ 'base' => NULL, 'refs' => [ 'CertificateMessage$Certificates' => 'The list of Certificate objects for the Amazon Web Services account.
Data returned by the DescribeCertificates action.
', 'refs' => [], ], 'CertificateNotFoundFault' => [ 'base' => ' CertificateIdentifier doesn\'t refer to an existing certificate.
This data type is used as a response element in the action DescribeDBEngineVersions.
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn\'t specified.
The type of authentication the proxy uses for connections from clients.
', 'UserAuthConfigInfo$ClientPasswordAuthType' => 'The type of authentication the proxy uses for connections from clients.
', ], ], 'CloudwatchLogsExportConfiguration' => [ 'base' => 'The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
', 'refs' => [ 'ModifyDBClusterMessage$CloudwatchLogsExportConfiguration' => 'The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
', 'ModifyDBInstanceMessage$CloudwatchLogsExportConfiguration' => 'The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn\'t apply to RDS Custom DB instances.
', ], ], 'ClusterPendingModifiedValues' => [ 'base' => 'This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
', ], ], 'ConnectionPoolConfiguration' => [ 'base' => 'Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.
The settings that determine the size and behavior of the connection pool for the target group.
', ], ], 'ConnectionPoolConfigurationInfo' => [ 'base' => 'Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.
The settings that determine the size and behavior of the connection pool for the target group.
', ], ], 'ContextAttribute' => [ 'base' => 'The additional attributes of RecommendedAction data type.
The supporting attributes to explain the recommended action.
', ], ], 'CopyDBClusterParameterGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'CopyDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CopyDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'CopyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyOptionGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CopyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateBlueGreenDeploymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBlueGreenDeploymentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCustomDBEngineVersionFault' => [ 'base' => 'An error occurred while trying to create the CEV.
', 'refs' => [], ], 'CreateCustomDBEngineVersionMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBClusterParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBInstanceReadReplicaMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSecurityGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBSecurityGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBShardGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSubnetGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSubscriptionMessage' => [ 'base' => '', 'refs' => [], ], 'CreateEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateIntegrationMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateOptionGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateTenantDatabaseMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateTenantDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'CustomAvailabilityZoneNotFoundFault' => [ 'base' => ' CustomAvailabilityZoneId doesn\'t refer to an existing custom Availability Zone identifier.
A value that indicates the AMI information.
', 'refs' => [ 'DBEngineVersion$Image' => 'The EC2 image
', ], ], 'CustomDBEngineVersionAlreadyExistsFault' => [ 'base' => 'A CEV with the specified name already exists.
', 'refs' => [], ], 'CustomDBEngineVersionManifest' => [ 'base' => NULL, 'refs' => [ 'CreateCustomDBEngineVersionMessage$Manifest' => 'The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
Version of the CEV manifest. The date is in the format YYYY-MM-DD.
Ordered list of installation files for the CEV.
Ordered list of OPatch installers used for the Oracle DB engine.
The PSU and RU patches for this CEV.
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see Creating the CEV manifest in the Amazon RDS User Guide.
', 'DBEngineVersion$CustomDBEngineVersionManifest' => 'JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they\'re listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
', ], ], 'CustomDBEngineVersionNotFoundFault' => [ 'base' => 'The specified CEV was not found.
', 'refs' => [], ], 'CustomDBEngineVersionQuotaExceededFault' => [ 'base' => 'You have exceeded your CEV quota.
', 'refs' => [], ], 'CustomEngineName' => [ 'base' => NULL, 'refs' => [ 'CreateCustomDBEngineVersionMessage$Engine' => 'The database engine. RDS Custom for Oracle supports the following values:
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
The database engine. RDS Custom for Oracle supports the following values:
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
The database engine. RDS Custom for Oracle supports the following values:
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
The availability status to be assigned to the CEV. Valid values are as follows:
You can use this CEV to create a new RDS Custom DB instance.
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can\'t patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
', 'refs' => [ 'CreateDBClusterResult$DBCluster' => NULL, 'DBClusterList$member' => NULL, 'DeleteDBClusterResult$DBCluster' => NULL, 'FailoverDBClusterResult$DBCluster' => NULL, 'ModifyDBClusterResult$DBCluster' => NULL, 'PromoteReadReplicaDBClusterResult$DBCluster' => NULL, 'RebootDBClusterResult$DBCluster' => NULL, 'RestoreDBClusterFromS3Result$DBCluster' => NULL, 'RestoreDBClusterFromSnapshotResult$DBCluster' => NULL, 'RestoreDBClusterToPointInTimeResult$DBCluster' => NULL, 'StartDBClusterResult$DBCluster' => NULL, 'StopDBClusterResult$DBCluster' => NULL, ], ], 'DBClusterAlreadyExistsFault' => [ 'base' => 'The user already has a DB cluster with the given identifier.
', 'refs' => [], ], 'DBClusterAutomatedBackup' => [ 'base' => 'An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
', 'refs' => [ 'DBClusterAutomatedBackupList$member' => NULL, 'DeleteDBClusterAutomatedBackupResult$DBClusterAutomatedBackup' => NULL, ], ], 'DBClusterAutomatedBackupList' => [ 'base' => NULL, 'refs' => [ 'DBClusterAutomatedBackupMessage$DBClusterAutomatedBackups' => 'A list of DBClusterAutomatedBackup backups.
No automated backup for this DB cluster was found.
', 'refs' => [], ], 'DBClusterAutomatedBackupQuotaExceededFault' => [ 'base' => 'The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.
', 'refs' => [], ], 'DBClusterBacktrack' => [ 'base' => 'This data type is used as a response element in the DescribeDBClusterBacktracks action.
Contains a list of backtracks for the user.
', ], ], 'DBClusterBacktrackMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.
BacktrackIdentifier doesn\'t refer to an existing backtrack.
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.
The specified custom endpoint can\'t be created because it already exists.
', 'refs' => [], ], 'DBClusterEndpointList' => [ 'base' => NULL, 'refs' => [ 'DBClusterEndpointMessage$DBClusterEndpoints' => 'Contains the details of the endpoints associated with the cluster and matching any filter conditions.
', ], ], 'DBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'DBClusterEndpointNotFoundFault' => [ 'base' => 'The specified custom endpoint doesn\'t exist.
', 'refs' => [], ], 'DBClusterEndpointQuotaExceededFault' => [ 'base' => 'The cluster already has the maximum number of custom endpoints.
', 'refs' => [], ], 'DBClusterIdentifier' => [ 'base' => NULL, 'refs' => [ 'FailoverGlobalClusterMessage$TargetDbClusterIdentifier' => 'The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
', 'SwitchoverGlobalClusterMessage$TargetDbClusterIdentifier' => 'The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
', ], ], 'DBClusterList' => [ 'base' => NULL, 'refs' => [ 'DBClusterMessage$DBClusters' => 'Contains a list of DB clusters for the user.
', ], ], 'DBClusterMember' => [ 'base' => 'Contains information about an instance that is part of a DB cluster.
', 'refs' => [ 'DBClusterMemberList$member' => NULL, ], ], 'DBClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DBClusterMembers' => 'The list of DB instances that make up the DB cluster.
', ], ], 'DBClusterMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBClusters action.
DBClusterIdentifier doesn\'t refer to an existing DB cluster.
The list of option group memberships for this DB cluster.
', ], ], 'DBClusterOptionGroupStatus' => [ 'base' => 'Contains status information for a DB cluster option group.
', 'refs' => [ 'DBClusterOptionGroupMemberships$member' => NULL, ], ], 'DBClusterParameterGroup' => [ 'base' => 'Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups action.
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
', 'refs' => [], ], 'DBClusterParameterGroupList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupsMessage$DBClusterParameterGroups' => 'A list of DB cluster parameter groups.
', ], ], 'DBClusterParameterGroupNameMessage' => [ 'base' => '', 'refs' => [], ], 'DBClusterParameterGroupNotFoundFault' => [ 'base' => ' DBClusterParameterGroupName doesn\'t refer to an existing DB cluster parameter group.
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
', 'refs' => [], ], 'DBClusterRole' => [ 'base' => 'Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
', 'refs' => [ 'DBClusterRoles$member' => NULL, ], ], 'DBClusterRoleAlreadyExistsFault' => [ 'base' => 'The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
', 'refs' => [], ], 'DBClusterRoleNotFoundFault' => [ 'base' => 'The specified IAM role Amazon Resource Name (ARN) isn\'t associated with the specified DB cluster.
', 'refs' => [], ], 'DBClusterRoleQuotaExceededFault' => [ 'base' => 'You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
', 'refs' => [], ], 'DBClusterRoles' => [ 'base' => NULL, 'refs' => [ 'DBCluster$AssociatedRoles' => 'A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
', ], ], 'DBClusterSnapshot' => [ 'base' => 'Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
The user already has a DB cluster snapshot with the given identifier.
', 'refs' => [], ], 'DBClusterSnapshotAttribute' => [ 'base' => 'Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The list of attributes and values for the manual DB cluster snapshot.
', ], ], 'DBClusterSnapshotAttributesResult' => [ 'base' => 'Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
Provides a list of DB cluster snapshots for the user.
', ], ], 'DBClusterSnapshotMessage' => [ 'base' => 'Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
DBClusterSnapshotIdentifier doesn\'t refer to an existing DB cluster snapshot.
Reserved for future use.
', 'refs' => [ 'DBClusterStatusInfoList$member' => NULL, ], ], 'DBClusterStatusInfoList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$StatusInfos' => 'Reserved for future use.
', ], ], 'DBEngineVersion' => [ 'base' => 'This data type is used as a response element in the action DescribeDBEngineVersions.
A list of DBEngineVersion elements.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
The user already has a DB instance with the given identifier.
', 'refs' => [], ], 'DBInstanceAutomatedBackup' => [ 'base' => 'An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
', 'refs' => [ 'DBInstanceAutomatedBackupList$member' => NULL, 'DeleteDBInstanceAutomatedBackupResult$DBInstanceAutomatedBackup' => NULL, 'StartDBInstanceAutomatedBackupsReplicationResult$DBInstanceAutomatedBackup' => NULL, 'StopDBInstanceAutomatedBackupsReplicationResult$DBInstanceAutomatedBackup' => NULL, ], ], 'DBInstanceAutomatedBackupList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceAutomatedBackupMessage$DBInstanceAutomatedBackups' => 'A list of DBInstanceAutomatedBackup instances.
Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.
No automated backup for this DB instance was found.
', 'refs' => [], ], 'DBInstanceAutomatedBackupQuotaExceededFault' => [ 'base' => 'The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
', 'refs' => [], ], 'DBInstanceAutomatedBackupsReplication' => [ 'base' => 'Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
', 'refs' => [ 'DBInstanceAutomatedBackupsReplicationList$member' => NULL, ], ], 'DBInstanceAutomatedBackupsReplicationList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$DBInstanceAutomatedBackupsReplications' => 'The list of replicated automated backups associated with the DB instance.
', 'DBInstanceAutomatedBackup$DBInstanceAutomatedBackupsReplications' => 'The list of replications to different Amazon Web Services Regions associated with the automated backup.
', ], ], 'DBInstanceList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceMessage$DBInstances' => 'A list of DBInstance instances.
Contains the result of a successful invocation of the DescribeDBInstances action.
DBInstanceIdentifier doesn\'t refer to an existing DB instance.
Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
', 'refs' => [ 'DBInstanceRoles$member' => NULL, ], ], 'DBInstanceRoleAlreadyExistsFault' => [ 'base' => 'The specified RoleArn or FeatureName value is already associated with the DB instance.
The specified RoleArn value doesn\'t match the specified feature for the DB instance.
You can\'t associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
', 'refs' => [], ], 'DBInstanceRoles' => [ 'base' => NULL, 'refs' => [ 'DBInstance$AssociatedRoles' => 'The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
', ], ], 'DBInstanceStatusInfo' => [ 'base' => 'Provides a list of status information for a DB instance.
', 'refs' => [ 'DBInstanceStatusInfoList$member' => NULL, ], ], 'DBInstanceStatusInfoList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$StatusInfos' => 'The status of a read replica. If the DB instance isn\'t a read replica, the value is blank.
', ], ], 'DBLogFileNotFoundFault' => [ 'base' => ' LogFileName doesn\'t refer to an existing DB log file.
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups action.
A DB parameter group with the same name exists.
', 'refs' => [], ], 'DBParameterGroupDetails' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBParameters action.
A list of DBParameterGroup instances.
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup operation.
DBParameterGroupName doesn\'t refer to an existing DB parameter group.
The request would result in the user exceeding the allowed number of DB parameter groups.
', 'refs' => [], ], 'DBParameterGroupStatus' => [ 'base' => 'The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
The list of DB parameter groups applied to this DB instance.
', ], ], 'DBParameterGroupsMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBParameterGroups action.
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies action.
The DBProxy structure corresponding to the new proxy.
The data structure representing the details of the DB proxy that you delete.
', 'ModifyDBProxyResponse$DBProxy' => 'The DBProxy object representing the new settings for the proxy.
The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyEndpoint' => [ 'base' => 'The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
This data type is used as a response element in the DescribeDBProxyEndpoints operation.
The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy\'s default VPC.
The data structure representing the details of the DB proxy endpoint that you delete.
', 'ModifyDBProxyEndpointResponse$DBProxyEndpoint' => 'The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyEndpointList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBProxyEndpointsResponse$DBProxyEndpoints' => 'The list of ProxyEndpoint objects returned by the API operation.
The name of the DB proxy endpoint to create.
', 'DeleteDBProxyEndpointRequest$DBProxyEndpointName' => 'The name of the DB proxy endpoint to delete.
', 'DescribeDBProxyEndpointsRequest$DBProxyEndpointName' => 'The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.
', 'ModifyDBProxyEndpointRequest$DBProxyEndpointName' => 'The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
', 'ModifyDBProxyEndpointRequest$NewDBProxyEndpointName' => 'The new identifier for the DBProxyEndpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
The DB proxy endpoint doesn\'t exist.
', 'refs' => [], ], 'DBProxyEndpointQuotaExceededFault' => [ 'base' => 'The DB proxy already has the maximum number of endpoints.
', 'refs' => [], ], 'DBProxyEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'DBProxyEndpoint$Status' => 'The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
', ], ], 'DBProxyList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBProxiesResponse$DBProxies' => 'A return value representing an arbitrary number of DBProxy data structures.
The name of the DB proxy associated with the DB proxy endpoint that you create.
', 'DescribeDBProxyEndpointsRequest$DBProxyName' => 'The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.
', ], ], 'DBProxyNotFoundFault' => [ 'base' => 'The specified proxy name doesn\'t correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyQuotaExceededFault' => [ 'base' => 'Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyStatus' => [ 'base' => NULL, 'refs' => [ 'DBProxy$Status' => 'The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
', 'refs' => [], ], 'DBProxyTargetGroup' => [ 'base' => 'Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.
This data type is used as a response element in the DescribeDBProxyTargetGroups action.
The settings of the modified DBProxyTarget.
The specified target group isn\'t available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyTargetNotFoundFault' => [ 'base' => 'The specified RDS DB instance or Aurora DB cluster isn\'t available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBRecommendation' => [ 'base' => 'The recommendation for your DB instances, DB clusters, and DB parameter groups.
', 'refs' => [ 'DBRecommendationList$member' => NULL, 'DBRecommendationMessage$DBRecommendation' => NULL, ], ], 'DBRecommendationList' => [ 'base' => NULL, 'refs' => [ 'DBRecommendationsMessage$DBRecommendations' => 'A list of recommendations which is returned from DescribeDBRecommendations API request.
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the DescribeDBSecurityGroups action.
A DB security group with the name specified in DBSecurityGroupName already exists.
This data type is used as a response element in the following actions:
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
If the option requires access to a port, then this DB security group allows access to the port.
', ], ], 'DBSecurityGroupMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
A list of DB security groups to authorize on this DB instance. Changing this setting doesn\'t result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB security groups.
A list of DBSecurityGroupMembership name strings used for this option.
', 'RestoreDBInstanceFromS3Message$DBSecurityGroups' => 'A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
', ], ], 'DBSecurityGroupNotFoundFault' => [ 'base' => ' DBSecurityGroupName doesn\'t refer to an existing DB security group.
A DB security group isn\'t allowed for this action.
', 'refs' => [], ], 'DBSecurityGroupQuotaExceededFault' => [ 'base' => 'The request would result in the user exceeding the allowed number of DB security groups.
', 'refs' => [], ], 'DBSecurityGroups' => [ 'base' => NULL, 'refs' => [ 'DBSecurityGroupMessage$DBSecurityGroups' => 'A list of DBSecurityGroup instances.
The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBShardGroupIdentifier' => [ 'base' => NULL, 'refs' => [ 'DBShardGroup$DBShardGroupIdentifier' => 'The name of the DB shard group.
', 'DeleteDBShardGroupMessage$DBShardGroupIdentifier' => 'Teh name of the DB shard group to delete.
', 'DescribeDBShardGroupsMessage$DBShardGroupIdentifier' => 'The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match an existing DB shard group identifier.
The name of the DB shard group to modify.
', 'RebootDBShardGroupMessage$DBShardGroupIdentifier' => 'The name of the DB shard group to reboot.
', ], ], 'DBShardGroupNotFoundFault' => [ 'base' => 'The specified DB shard group name wasn\'t found.
', 'refs' => [], ], 'DBShardGroupsList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBShardGroupsResponse$DBShardGroups' => 'Contains a list of DB shard groups for the user.
', ], ], 'DBSnapshot' => [ 'base' => 'Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier is already used by an existing snapshot.
Contains the name and values of a manual DB snapshot attribute
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.
The list of attributes and values for the manual DB snapshot.
', ], ], 'DBSnapshotAttributesResult' => [ 'base' => 'Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
A list of DBSnapshot instances.
Contains the result of a successful invocation of the DescribeDBSnapshots action.
DBSnapshotIdentifier doesn\'t refer to an existing DB snapshot.
Contains the details of a tenant database in a snapshot of a DB instance.
', 'refs' => [ 'DBSnapshotTenantDatabasesList$member' => NULL, ], ], 'DBSnapshotTenantDatabaseNotFoundFault' => [ 'base' => 'The specified snapshot tenant database wasn\'t found.
', 'refs' => [], ], 'DBSnapshotTenantDatabasesList' => [ 'base' => NULL, 'refs' => [ 'DBSnapshotTenantDatabasesMessage$DBSnapshotTenantDatabases' => 'A list of DB snapshot tenant databases.
', ], ], 'DBSnapshotTenantDatabasesMessage' => [ 'base' => NULL, 'refs' => [], ], 'DBSubnetGroup' => [ 'base' => 'Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
', 'DBSubnetGroups$member' => NULL, 'ModifyDBSubnetGroupResult$DBSubnetGroup' => NULL, ], ], 'DBSubnetGroupAlreadyExistsFault' => [ 'base' => ' DBSubnetGroupName is already used by an existing DB subnet group.
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
', 'refs' => [], ], 'DBSubnetGroupMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
The DBSubnetGroup shouldn\'t be specified while creating read replicas that lie in the same region as the source instance.
', 'refs' => [], ], 'DBSubnetGroupNotFoundFault' => [ 'base' => ' DBSubnetGroupName doesn\'t refer to an existing DB subnet group.
The request would result in the user exceeding the allowed number of DB subnet groups.
', 'refs' => [], ], 'DBSubnetGroups' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroupMessage$DBSubnetGroups' => 'A list of DBSubnetGroup instances.
The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
', 'refs' => [], ], 'DBUpgradeDependencyFailureFault' => [ 'base' => 'The DB upgrade failed because a resource the DB depends on can\'t be modified.
', 'refs' => [], ], 'DataFilter' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$DataFilter' => 'Data filtering options for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift.
Valid for: Integrations with Aurora MySQL source DB clusters only
', 'Integration$DataFilter' => 'Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
', 'ModifyIntegrationMessage$DataFilter' => 'A new data filter for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift.
', ], ], 'DatabaseArn' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$Source' => 'The source database for the blue/green deployment.
Before switchover, the source database is the production database in the blue environment.
', 'BlueGreenDeployment$Target' => 'The target database for the blue/green deployment.
Before switchover, the target database is the clone database in the green environment.
', 'CreateBlueGreenDeploymentRequest$Source' => 'The Amazon Resource Name (ARN) of the source production database.
Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.
', 'SwitchoverDetail$SourceMember' => 'The Amazon Resource Name (ARN) of a resource in the blue environment.
', 'SwitchoverDetail$TargetMember' => 'The Amazon Resource Name (ARN) of a resource in the green environment.
', ], ], 'DeleteBlueGreenDeploymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBlueGreenDeploymentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomDBEngineVersionMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterAutomatedBackupMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterAutomatedBackupResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'DeleteDBClusterParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'DeleteDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'DeleteDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBInstanceAutomatedBackupMessage' => [ 'base' => 'Parameter input for the DeleteDBInstanceAutomatedBackup operation.
Parameter input for DescribeDBInstanceAutomatedBackups.
', 'refs' => [], ], 'DescribeDBInstancesMessage' => [ 'base' => '', 'refs' => [], ], 'DescribeDBLogFilesDetails' => [ 'base' => 'This data type is used as a response element to DescribeDBLogFiles.
The DB log files returned.
', ], ], 'DescribeDBLogFilesMessage' => [ 'base' => '', 'refs' => [], ], 'DescribeDBLogFilesResponse' => [ 'base' => 'The response from a call to DescribeDBLogFiles.
An optional description of your CEV.
', 'ModifyCustomDBEngineVersionMessage$Description' => 'An optional description of your CEV.
', ], ], 'DisableHttpEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisableHttpEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DocLink' => [ 'base' => 'A link to documentation that provides additional information for a recommendation.
', 'refs' => [ 'DocLinkList$member' => NULL, ], ], 'DocLinkList' => [ 'base' => NULL, 'refs' => [ 'DBRecommendation$Links' => 'A link to documentation that provides additional information about the recommendation.
', ], ], 'DomainMembership' => [ 'base' => 'An Active Directory Domain membership record associated with the DB instance or cluster.
', 'refs' => [ 'DomainMembershipList$member' => NULL, ], ], 'DomainMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DomainMemberships' => 'The Active Directory Domain membership records associated with the DB cluster.
', 'DBInstance$DomainMemberships' => 'The Active Directory Domain membership records associated with the DB instance.
', ], ], 'DomainNotFoundFault' => [ 'base' => ' Domain doesn\'t refer to an existing Active Directory domain.
The minimum value in the range.
', 'DoubleRange$To' => 'The maximum value in the range.
', 'RecurringCharge$RecurringChargeAmount' => 'The amount of the recurring charge.
', 'ReservedDBInstance$FixedPrice' => 'The fixed price charged for this reserved DB instance.
', 'ReservedDBInstance$UsagePrice' => 'The hourly price charged for this reserved DB instance.
', 'ReservedDBInstancesOffering$FixedPrice' => 'The fixed price charged for this offering.
', 'ReservedDBInstancesOffering$UsagePrice' => 'The hourly price charged for this offering.
', 'ScalarReferenceDetails$Value' => 'The value of a scalar reference.
', ], ], 'DoubleOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBShardGroupMessage$MaxACU' => 'The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
', 'DBShardGroup$MaxACU' => 'The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
', 'LimitlessDatabase$MinRequiredACU' => 'The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).
', 'ModifyDBShardGroupMessage$MaxACU' => 'The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
', 'OrderableDBInstanceOption$MinIopsPerGib' => 'Minimum provisioned IOPS per GiB for a DB instance.
', 'OrderableDBInstanceOption$MaxIopsPerGib' => 'Maximum provisioned IOPS per GiB for a DB instance.
', 'OrderableDBInstanceOption$MinStorageThroughputPerIops' => 'Minimum storage throughput to provisioned IOPS ratio for a DB instance.
', 'OrderableDBInstanceOption$MaxStorageThroughputPerIops' => 'Maximum storage throughput to provisioned IOPS ratio for a DB instance.
', 'ServerlessV2ScalingConfiguration$MinCapacity' => 'The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
', 'ServerlessV2ScalingConfiguration$MaxCapacity' => 'The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
', 'ServerlessV2ScalingConfigurationInfo$MinCapacity' => 'The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
', 'ServerlessV2ScalingConfigurationInfo$MaxCapacity' => 'The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
', ], ], 'DoubleRange' => [ 'base' => 'A range of double values.
', 'refs' => [ 'DoubleRangeList$member' => NULL, ], ], 'DoubleRangeList' => [ 'base' => NULL, 'refs' => [ 'ValidStorageOptions$IopsToStorageRatio' => 'The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
', 'ValidStorageOptions$StorageThroughputToIopsRatio' => 'The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.
', ], ], 'DownloadDBLogFilePortionDetails' => [ 'base' => 'This data type is used as a response element to DownloadDBLogFilePortion.
This data type is used as a response element in the following actions:
AuthorizeDBSecurityGroupIngress
DescribeDBSecurityGroups
RevokeDBSecurityGroupIngress
Contains a list of EC2SecurityGroup elements.
The AMI configuration prerequisite has not been met.
', 'refs' => [], ], 'EnableHttpEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'EnableHttpEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'EncryptionContextMap' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$AdditionalEncryptionContext' => 'An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
You can only include this parameter if you specify the KMSKeyId parameter.
The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
', ], ], 'Endpoint' => [ 'base' => 'This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
CreateDBInstance
DescribeDBInstances
DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
The listener connection endpoint for SQL Server Always On.
', ], ], 'EngineDefaults' => [ 'base' => 'Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.
A list of the supported DB engine modes.
', 'OrderableDBInstanceOption$SupportedEngineModes' => 'A list of the supported DB engine modes.
', 'Parameter$SupportedEngineModes' => 'The valid DB engine modes.
', 'UpgradeTarget$SupportedEngineModes' => 'A list of the supported DB engine modes for the target engine version.
', ], ], 'Event' => [ 'base' => 'This data type is used as a response element in the DescribeEvents action.
', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventCategoriesList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$EventCategories' => 'A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.
A list of event categories that trigger notifications for a event notification subscription.
', 'Event$EventCategories' => 'Specifies the category for the event.
', 'EventCategoriesMap$EventCategories' => 'The event categories for the specified source type
', 'EventSubscription$EventCategoriesList' => 'A list of event categories for the RDS event notification subscription.
', 'ModifyEventSubscriptionMessage$EventCategories' => 'A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
Contains the results of a successful invocation of the DescribeEventCategories operation.
', 'refs' => [ 'EventCategoriesMapList$member' => NULL, ], ], 'EventCategoriesMapList' => [ 'base' => NULL, 'refs' => [ 'EventCategoriesMessage$EventCategoriesMapList' => 'A list of EventCategoriesMap data types.
Data returned from the DescribeEventCategories operation.
A list of Event instances.
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
You have reached the maximum number of event subscriptions.
', 'refs' => [], ], 'EventSubscriptionsList' => [ 'base' => NULL, 'refs' => [ 'EventSubscriptionsMessage$EventSubscriptionsList' => 'A list of EventSubscriptions data types.
', ], ], 'EventSubscriptionsMessage' => [ 'base' => 'Data returned by the DescribeEventSubscriptions action.
', 'refs' => [], ], 'EventsMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeEvents action.
The type of source for the export.
', 'ExportTask$SourceType' => 'The type of source for the export.
', ], ], 'ExportTask' => [ 'base' => 'Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks operation.
You can\'t start an export task that\'s already running.
', 'refs' => [], ], 'ExportTaskNotFoundFault' => [ 'base' => 'The export task doesn\'t exist.
', 'refs' => [], ], 'ExportTasksList' => [ 'base' => NULL, 'refs' => [ 'ExportTasksMessage$ExportTasks' => 'Information about an export of a snapshot or cluster to Amazon S3.
', ], ], 'ExportTasksMessage' => [ 'base' => NULL, 'refs' => [], ], 'FailoverDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'FailoverDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'FailoverGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'FailoverGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'FailoverState' => [ 'base' => 'Contains the state of scheduled or in-process operations on a global cluster (Aurora global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Aurora global database.
', 'refs' => [ 'GlobalCluster$FailoverState' => 'A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster\'s primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribeDBShardGroups
DescribePendingMaintenanceActions
A filter that specifies one or more blue/green deployments to describe.
Valid Values:
blue-green-deployment-identifier - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.
blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.
source - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.
target - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.
This parameter isn\'t currently supported.
', 'DescribeDBClusterAutomatedBackupsMessage$Filters' => 'A filter that specifies which resources to return based on status.
Supported filters are the following:
status
retained - Automated backups for deleted clusters and after backup replication is stopped.
db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs.
db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
', 'DescribeDBClusterBacktracksMessage$Filters' => 'A filter that specifies one or more DB clusters to describe. Supported filters include the following:
db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.
db-cluster-backtrack-status - Accepts any of the following backtrack status values:
applying
completed
failed
pending
The results list includes information about only the backtracks identified by these values.
A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.
This parameter isn\'t currently supported.
', 'DescribeDBClusterParametersMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeDBClusterSnapshotsMessage$Filters' => 'A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
snapshot-type - Accepts types of DB cluster snapshots.
engine - Accepts names of database engines.
A filter that specifies one or more DB clusters to describe.
Supported Filters:
clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
available
deprecated
A filter that specifies which resources to return based on status.
Supported filters are the following:
status
active - Automated backups for current instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
retained - Automated backups for deleted instances and after backup replication is stopped.
db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.
dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
', 'DescribeDBInstancesMessage$Filters' => 'A filter that specifies one or more DB instances to describe.
Supported Filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.
dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
This parameter isn\'t currently supported.
', 'DescribeDBParameterGroupsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeDBParametersMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeDBProxiesRequest$Filters' => 'This parameter is not currently supported.
', 'DescribeDBProxyEndpointsRequest$Filters' => 'This parameter is not currently supported.
', 'DescribeDBProxyTargetGroupsRequest$Filters' => 'This parameter is not currently supported.
', 'DescribeDBProxyTargetsRequest$Filters' => 'This parameter is not currently supported.
', 'DescribeDBRecommendationsMessage$Filters' => 'A filter that specifies one or more recommendations to describe.
Supported Filters:
recommendation-id - Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values.
status - Accepts a list of recommendation statuses.
Valid values:
active - The recommendations which are ready for you to apply.
pending - The applied or scheduled recommendations which are in progress.
resolved - The recommendations which are completed.
dismissed - The recommendations that you dismissed.
The results list only includes the recommendations whose status is one of the specified filter values.
severity - Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.
Valid values:
high
medium
low
informational
type-id - Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values.
dbi-resource-id - Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases.
cluster-resource-id - Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters.
pg-arn - Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups.
cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
This parameter isn\'t currently supported.
', 'DescribeDBShardGroupsMessage$Filters' => 'A filter that specifies one or more DB shard groups to describe.
', 'DescribeDBSnapshotTenantDatabasesMessage$Filters' => 'A filter that specifies one or more tenant databases to describe.
Supported filters:
tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.
dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
snapshot-type - Accepts types of DB snapshots.
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
dbi-resource-id - Accepts identifiers of source DB instances.
snapshot-type - Accepts types of DB snapshots.
engine - Accepts names of database engines.
This parameter isn\'t currently supported.
', 'DescribeEngineDefaultClusterParametersMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeEngineDefaultParametersMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeEventCategoriesMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeEventSubscriptionsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeEventsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeExportTasksMessage$Filters' => 'Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.
Supported filters include the following:
export-task-identifier - An identifier for the snapshot or cluster export task.
s3-bucket - The Amazon S3 bucket the data is exported to.
source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
status - The status of the export task. Must be lowercase. Valid statuses are the following:
canceled
canceling
complete
failed
in_progress
starting
A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.
Currently, the only supported filter is region.
If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.
', 'DescribeIntegrationsMessage$Filters' => 'A filter that specifies one or more resources to return.
', 'DescribeOptionGroupOptionsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeOptionGroupsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeOrderableDBInstanceOptionsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribePendingMaintenanceActionsMessage$Filters' => 'A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.
This parameter isn\'t currently supported.
', 'DescribeReservedDBInstancesOfferingsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeSourceRegionsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeTenantDatabasesMessage$Filters' => 'A filter that specifies one or more database tenants to describe.
Supported filters:
tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
tenant-database-resource-id - Tenant database resource identifiers.
dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.
This parameter isn\'t currently supported.
', ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => 'One or more filter values. Filter values are case-sensitive.
', ], ], 'GlobalCluster' => [ 'base' => 'A data type representing an Aurora global database.
', 'refs' => [ 'CreateGlobalClusterResult$GlobalCluster' => NULL, 'DeleteGlobalClusterResult$GlobalCluster' => NULL, 'FailoverGlobalClusterResult$GlobalCluster' => NULL, 'GlobalClusterList$member' => NULL, 'ModifyGlobalClusterResult$GlobalCluster' => NULL, 'RemoveFromGlobalClusterResult$GlobalCluster' => NULL, 'SwitchoverGlobalClusterResult$GlobalCluster' => NULL, ], ], 'GlobalClusterAlreadyExistsFault' => [ 'base' => 'The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.
The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it\'s the name of the Aurora global database.
Constraints:
Must match the identifier of an existing global database cluster.
The identifier of the global database cluster to switch over. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster (Aurora global database).
The list of global clusters returned by this request.
', ], ], 'GlobalClusterMember' => [ 'base' => 'A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database).
', 'refs' => [ 'GlobalClusterMemberList$member' => NULL, ], ], 'GlobalClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'GlobalCluster$GlobalClusterMembers' => 'The list of primary and secondary clusters within the global database cluster.
', ], ], 'GlobalClusterMemberSynchronizationStatus' => [ 'base' => NULL, 'refs' => [ 'GlobalClusterMember$SynchronizationStatus' => 'The status of synchronization of each Aurora DB cluster in the global cluster.
', ], ], 'GlobalClusterNotFoundFault' => [ 'base' => 'The GlobalClusterIdentifier doesn\'t refer to an existing global database cluster.
The number of global database clusters for this account is already at the maximum allowed.
', 'refs' => [], ], 'GlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'IAMAuthMode' => [ 'base' => NULL, 'refs' => [ 'UserAuthConfig$IAMAuth' => 'A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
This data type is used as a response element in the DescribeDBSecurityGroups action.
Contains a list of IPRange elements.
The IAM role requires additional permissions to export to an Amazon S3 bucket.
', 'refs' => [], ], 'IamRoleNotFoundFault' => [ 'base' => 'The IAM role is missing for exporting to an Amazon S3 bucket.
', 'refs' => [], ], 'InstanceQuotaExceededFault' => [ 'base' => 'The request would result in the user exceeding the allowed number of DB instances.
', 'refs' => [], ], 'InsufficientAvailableIPsInSubnetFault' => [ 'base' => 'The requested operation can\'t be performed because there aren\'t enough available IP addresses in the proxy\'s subnets. Add more CIDR blocks to the VPC or remove IP address that aren\'t required from the subnets.
', 'refs' => [], ], 'InsufficientDBClusterCapacityFault' => [ 'base' => 'The DB cluster doesn\'t have enough capacity for the current operation.
', 'refs' => [], ], 'InsufficientDBInstanceCapacityFault' => [ 'base' => 'The specified DB instance class isn\'t available in the specified Availability Zone.
', 'refs' => [], ], 'InsufficientStorageClusterCapacityFault' => [ 'base' => 'There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ConnectionPoolConfigurationInfo$MaxConnectionsPercent' => 'The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
', 'DBClusterAutomatedBackup$AllocatedStorage' => 'For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn\'t fixed, but instead automatically adjusts as needed.
The port number that the automated backup used for connections.
Default: Inherits from the source DB cluster
Valid Values: 1150-65535
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
', 'DBClusterSnapshot$Port' => 'The port that the DB cluster was listening on at the time of the snapshot.
', 'DBClusterSnapshot$PercentProgress' => 'The percentage of the estimated data that has been transferred.
', 'DBInstance$AllocatedStorage' => 'The amount of storage in gibibytes (GiB) allocated for the DB instance.
', 'DBInstance$BackupRetentionPeriod' => 'The number of days for which automatic DB snapshots are retained.
', 'DBInstance$DbInstancePort' => 'The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
', 'DBInstanceAutomatedBackup$AllocatedStorage' => 'The allocated storage size for the the automated backup in gibibytes (GiB).
', 'DBInstanceAutomatedBackup$Port' => 'The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
', 'DBProxyTarget$Port' => 'The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
', 'DBSnapshot$AllocatedStorage' => 'Specifies the allocated storage size in gibibytes (GiB).
', 'DBSnapshot$Port' => 'Specifies the port that the database engine was listening on at the time of the snapshot.
', 'DBSnapshot$PercentProgress' => 'The percentage of the estimated data that has been transferred.
', 'DownloadDBLogFilePortionMessage$NumberOfLines' => 'The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
If NumberOfLines is specified and Marker isn\'t specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
Specifies the port that the database engine is listening on.
', 'ExportTask$PercentProgress' => 'The progress of the snapshot or cluster export task as a percentage.
', 'ExportTask$TotalExtractedDataInGB' => 'The total amount of data exported, in gigabytes.
', 'PerformanceInsightsMetricDimensionGroup$Limit' => 'The maximum number of items to fetch for this dimension group.
', 'Range$From' => 'The minimum value in the range.
', 'Range$To' => 'The maximum value in the range.
', 'ReservedDBInstance$Duration' => 'The duration of the reservation in seconds.
', 'ReservedDBInstance$DBInstanceCount' => 'The number of reserved DB instances.
', 'ReservedDBInstancesOffering$Duration' => 'The duration of the offering in seconds.
', ], ], 'IntegerOptional' => [ 'base' => NULL, 'refs' => [ 'ClusterPendingModifiedValues$BackupRetentionPeriod' => 'The number of days for which automatic DB snapshots are retained.
', 'ClusterPendingModifiedValues$AllocatedStorage' => 'The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn\'t fixed, but instead automatically adjusts as needed.
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
', 'ConnectionPoolConfiguration$MaxConnectionsPercent' => 'The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints:
Must be between 1 and 100.
A value that controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn\'t specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.
Constraints:
Must be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions. For an unlimited wait time, specify 0.
Default: 120
Constraints:
Must be between 0 and 3600.
The number of days for which automated backups are retained.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
The port number on which the instances in the DB cluster accept connections.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: 1150-65535
Default:
RDS for MySQL and Aurora MySQL - 3306
RDS for PostgreSQL and Aurora PostgreSQL - 5432
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
This setting is required to create a Multi-AZ DB cluster.
', 'CreateDBClusterMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS issues an error.
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
This setting doesn\'t apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Provisioned IOPS storage (io1, io2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3):
Enterprise and Standard editions: Must be an integer from 20 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1, io2):
Enterprise and Standard editions: Must be an integer from 100 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 20 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
This setting doesn\'t apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can\'t be set to 0 if the DB instance is a source to read replicas.
Can\'t be set to 0 for an RDS Custom for Oracle DB instance.
The port number on which the database accepts connections.
This setting doesn\'t apply to Aurora DB instances. The port number is managed by the cluster.
Valid Values: 1150-65535
Default:
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can\'t be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.
This setting doesn\'t apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Constraints:
For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
The number of days to retain Performance Insights data.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS returns an error.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (Storage is managed by the DB cluster.)
RDS Custom
The storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$Port' => 'The port number that the DB instance uses for connections.
Valid Values: 1150-65535
Default: Inherits the value from the source DB instance.
', 'CreateDBInstanceReadReplicaMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
', 'CreateDBInstanceReadReplicaMessage$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
The number of days to retain Performance Insights data.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS returns an error.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
', 'CreateDBInstanceReadReplicaMessage$StorageThroughput' => 'Specifies the storage throughput value for the read replica.
This setting doesn\'t apply to RDS Custom or Amazon Aurora DB instances.
', 'CreateDBInstanceReadReplicaMessage$AllocatedStorage' => 'The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
', 'CreateDBShardGroupMessage$ComputeRedundancy' => 'Specifies whether to create standby instances for the DB shard group. Valid values are the following:
0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.
1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.
2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn\'t fixed, but instead automatically adjusts as needed.
The number of days for which automatic DB snapshots are retained.
', 'DBCluster$Port' => 'The port that the database engine is listening on.
', 'DBCluster$Capacity' => 'The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
', 'DBCluster$Iops' => 'The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$PerformanceInsightsRetentionPeriod' => 'The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterAutomatedBackup$BackupRetentionPeriod' => 'The retention period for the automated backups.
', 'DBClusterAutomatedBackup$Iops' => 'The IOPS (I/O operations per second) value for the automated backup.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterAutomatedBackup$StorageThroughput' => 'The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterCapacityInfo$PendingCapacity' => 'A value that specifies the capacity that the DB cluster scales to next.
', 'DBClusterCapacityInfo$CurrentCapacity' => 'The current capacity of the DB cluster.
', 'DBClusterCapacityInfo$SecondsBeforeTimeout' => 'The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
', 'DBClusterSnapshot$StorageThroughput' => 'The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBInstance$Iops' => 'The Provisioned IOPS (I/O operations per second) value for the DB instance.
', 'DBInstance$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
', 'DBInstance$PromotionTier' => 'The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
', 'DBInstance$PerformanceInsightsRetentionPeriod' => 'The number of days to retain Performance Insights data.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
', 'DBInstance$StorageThroughput' => 'The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
The IOPS (I/O operations per second) value for the automated backup.
', 'DBInstanceAutomatedBackup$BackupRetentionPeriod' => 'The retention period for the automated backups.
', 'DBInstanceAutomatedBackup$StorageThroughput' => 'The storage throughput for the automated backup.
', 'DBShardGroup$ComputeRedundancy' => 'Specifies whether to create standby instances for the DB shard group. Valid values are the following:
0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.
1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.
2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
', 'DBSnapshot$StorageThroughput' => 'Specifies the storage throughput for the DB snapshot.
', 'DescribeCertificatesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterAutomatedBackupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterEndpointsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterParameterGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterSnapshotsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClustersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100
', 'DescribeDBEngineVersionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBInstanceAutomatedBackupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBLogFilesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
', 'DescribeDBParameterGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBRecommendationsMessage$MaxRecords' => 'The maximum number of recommendations to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBSnapshotTenantDatabasesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBSubnetGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeEngineDefaultClusterParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeEngineDefaultParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeEventSubscriptionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeEventsMessage$Duration' => 'The number of minutes to retrieve events for.
Default: 60
', 'DescribeEventsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeGlobalClustersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeIntegrationsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeOptionGroupOptionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeOptionGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeOrderableDBInstanceOptionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 1000.
', 'DescribePendingMaintenanceActionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeReservedDBInstancesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeReservedDBInstancesOfferingsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeSourceRegionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeTenantDatabasesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
', 'ModifyDBClusterMessage$BackupRetentionPeriod' => 'The number of days for which automated backups are retained. Specify a minimum value of 1.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
', 'ModifyDBClusterMessage$AllocatedStorage' => 'The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS issues an error.
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see CreateDBInstance.
Constraints:
When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3, io1, or io2 storage type), you must also specify the Iops parameter. You can use the current value for Iops.
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
This setting doesn\'t apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35.
Can\'t be set to 0 if the DB instance is a source to read replicas.
Can\'t be set to 0 for an RDS Custom for Oracle DB instance.
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn\'t result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints:
For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
When you increase the Provisioned IOPS, you must also specify the AllocatedStorage parameter. You can use the current value for AllocatedStorage.
Default: Uses existing setting
', 'ModifyDBInstanceMessage$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can\'t be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
The number of days to retain Performance Insights data.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS returns an error.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$ResumeFullAutomationModeMinutes' => 'The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 1,440.
The storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'ModifyDBProxyRequest$IdleClientTimeout' => 'The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
', 'Option$Port' => 'If required, the port configured for this option to use.
', 'OptionConfiguration$Port' => 'The optional port for the option.
', 'OptionGroupOption$DefaultPort' => 'If the option requires a port, specifies the default port for the option.
', 'OrderableDBInstanceOption$MinStorageSize' => 'Minimum storage size for a DB instance.
', 'OrderableDBInstanceOption$MaxStorageSize' => 'Maximum storage size for a DB instance.
', 'OrderableDBInstanceOption$MinIopsPerDbInstance' => 'Minimum total provisioned IOPS for a DB instance.
', 'OrderableDBInstanceOption$MaxIopsPerDbInstance' => 'Maximum total provisioned IOPS for a DB instance.
', 'OrderableDBInstanceOption$MinStorageThroughputPerDbInstance' => 'Minimum storage throughput for a DB instance.
', 'OrderableDBInstanceOption$MaxStorageThroughputPerDbInstance' => 'Maximum storage throughput for a DB instance.
', 'PendingModifiedValues$AllocatedStorage' => 'The allocated storage size for the DB instance specified in gibibytes (GiB).
', 'PendingModifiedValues$Port' => 'The port for the DB instance.
', 'PendingModifiedValues$BackupRetentionPeriod' => 'The number of days for which automated backups are retained.
', 'PendingModifiedValues$Iops' => 'The Provisioned IOPS value for the DB instance.
', 'PendingModifiedValues$StorageThroughput' => 'The storage throughput of the DB instance.
', 'PromoteReadReplicaMessage$BackupRetentionPeriod' => 'The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can\'t be set to 0 if the DB instance is a source to read replicas.
The number of instances to reserve.
Default: 1
The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn\'t a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
', 'RestoreDBClusterFromS3Message$BackupRetentionPeriod' => 'The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$Port' => 'The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535.
Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
', 'RestoreDBInstanceFromDBSnapshotMessage$Port' => 'The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn\'t specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
', 'RestoreDBInstanceFromDBSnapshotMessage$StorageThroughput' => 'Specifies the storage throughput value for the DB instance.
This setting doesn\'t apply to RDS Custom or Amazon Aurora.
', 'RestoreDBInstanceFromDBSnapshotMessage$AllocatedStorage' => 'The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn\'t a valid value, RDS issues an error.
', 'RestoreDBInstanceFromS3Message$MaxAllocatedStorage' => 'The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$StorageThroughput' => 'Specifies the storage throughput value for the DB instance.
This setting doesn\'t apply to RDS Custom or Amazon Aurora.
', 'RestoreDBInstanceToPointInTimeMessage$Port' => 'The port number on which the database accepts connections.
Default: The same port as the original DB instance.
Constraints:
The value must be 1150-65535.
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
This setting doesn\'t apply to SQL Server.
Constraints:
Must be an integer greater than 1000.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$StorageThroughput' => 'The storage throughput value for the DB instance.
This setting doesn\'t apply to RDS Custom or Amazon Aurora.
', 'RestoreDBInstanceToPointInTimeMessage$AllocatedStorage' => 'The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
', 'ScalingConfiguration$MaxCapacity' => 'The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
', 'ScalingConfiguration$SecondsUntilAutoPause' => 'The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
', 'ScalingConfiguration$SecondsBeforeTimeout' => 'The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
', 'ScalingConfigurationInfo$MinCapacity' => 'The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it\'s idle (it has no connections).
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
The retention period for the replicated automated backups.
', ], ], 'Integration' => [ 'base' => 'A zero-ETL integration with Amazon Redshift.
', 'refs' => [ 'IntegrationList$member' => NULL, ], ], 'IntegrationAlreadyExistsFault' => [ 'base' => 'The integration you are trying to create already exists.
', 'refs' => [], ], 'IntegrationArn' => [ 'base' => NULL, 'refs' => [ 'Integration$IntegrationArn' => 'The ARN of the integration.
', ], ], 'IntegrationConflictOperationFault' => [ 'base' => 'A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
', 'refs' => [], ], 'IntegrationDescription' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$Description' => 'A description of the integration.
', 'Integration$Description' => 'A description of the integration.
', 'ModifyIntegrationMessage$Description' => 'A new description for the integration.
', ], ], 'IntegrationError' => [ 'base' => 'An error associated with a zero-ETL integration with Amazon Redshift.
', 'refs' => [ 'IntegrationErrorList$member' => NULL, ], ], 'IntegrationErrorList' => [ 'base' => NULL, 'refs' => [ 'Integration$Errors' => 'Any errors associated with the integration.
', ], ], 'IntegrationIdentifier' => [ 'base' => NULL, 'refs' => [ 'DeleteIntegrationMessage$IntegrationIdentifier' => 'The unique identifier of the integration.
', 'DescribeIntegrationsMessage$IntegrationIdentifier' => 'The unique identifier of the integration.
', 'ModifyIntegrationMessage$IntegrationIdentifier' => 'The unique identifier of the integration to modify.
', ], ], 'IntegrationList' => [ 'base' => NULL, 'refs' => [ 'DescribeIntegrationsResponse$Integrations' => 'A list of integrations.
', ], ], 'IntegrationName' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$IntegrationName' => 'The name of the integration.
', 'Integration$IntegrationName' => 'The name of the integration.
', 'ModifyIntegrationMessage$IntegrationName' => 'A new name for the integration.
', ], ], 'IntegrationNotFoundFault' => [ 'base' => 'The specified integration could not be found.
', 'refs' => [], ], 'IntegrationQuotaExceededFault' => [ 'base' => 'You can\'t crate any more zero-ETL integrations because the quota has been reached.
', 'refs' => [], ], 'IntegrationStatus' => [ 'base' => NULL, 'refs' => [ 'Integration$Status' => 'The current status of the integration.
', ], ], 'InvalidBlueGreenDeploymentStateFault' => [ 'base' => 'The blue/green deployment can\'t be switched over or deleted because there is an invalid configuration in the green environment.
', 'refs' => [], ], 'InvalidCustomDBEngineVersionStateFault' => [ 'base' => 'You can\'t delete the CEV.
', 'refs' => [], ], 'InvalidDBClusterAutomatedBackupStateFault' => [ 'base' => 'The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.
', 'refs' => [], ], 'InvalidDBClusterCapacityFault' => [ 'base' => ' Capacity isn\'t a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.
The requested operation can\'t be performed on the endpoint while the endpoint is in this state.
', 'refs' => [], ], 'InvalidDBClusterSnapshotStateFault' => [ 'base' => 'The supplied value isn\'t a valid DB cluster snapshot state.
', 'refs' => [], ], 'InvalidDBClusterStateFault' => [ 'base' => 'The requested operation can\'t be performed while the cluster is in this state.
', 'refs' => [], ], 'InvalidDBInstanceAutomatedBackupStateFault' => [ 'base' => 'The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.
', 'refs' => [], ], 'InvalidDBInstanceStateFault' => [ 'base' => 'The DB instance isn\'t in a valid state.
', 'refs' => [], ], 'InvalidDBParameterGroupStateFault' => [ 'base' => 'The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can\'t delete it when the parameter group is in this state.
', 'refs' => [], ], 'InvalidDBProxyEndpointStateFault' => [ 'base' => 'You can\'t perform this operation while the DB proxy endpoint is in a particular state.
', 'refs' => [], ], 'InvalidDBProxyStateFault' => [ 'base' => 'The requested operation can\'t be performed while the proxy is in this state.
', 'refs' => [], ], 'InvalidDBSecurityGroupStateFault' => [ 'base' => 'The state of the DB security group doesn\'t allow deletion.
', 'refs' => [], ], 'InvalidDBShardGroupStateFault' => [ 'base' => 'The DB shard group must be in the available state.
', 'refs' => [], ], 'InvalidDBSnapshotStateFault' => [ 'base' => 'The state of the DB snapshot doesn\'t allow deletion.
', 'refs' => [], ], 'InvalidDBSubnetGroupFault' => [ 'base' => 'The DBSubnetGroup doesn\'t belong to the same VPC as that of an existing cross-region read replica of the same source instance.
', 'refs' => [], ], 'InvalidDBSubnetGroupStateFault' => [ 'base' => 'The DB subnet group cannot be deleted because it\'s in use.
', 'refs' => [], ], 'InvalidDBSubnetStateFault' => [ 'base' => 'The DB subnet isn\'t in the available state.
', 'refs' => [], ], 'InvalidEventSubscriptionStateFault' => [ 'base' => 'This error can occur if someone else is modifying a subscription. You should retry the action.
', 'refs' => [], ], 'InvalidExportOnlyFault' => [ 'base' => 'The export is invalid for exporting to an Amazon S3 bucket.
', 'refs' => [], ], 'InvalidExportSourceStateFault' => [ 'base' => 'The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
', 'refs' => [], ], 'InvalidExportTaskStateFault' => [ 'base' => 'You can\'t cancel an export task that has completed.
', 'refs' => [], ], 'InvalidGlobalClusterStateFault' => [ 'base' => 'The global cluster is in an invalid state and can\'t perform the requested operation.
', 'refs' => [], ], 'InvalidIntegrationStateFault' => [ 'base' => 'The integration is in an invalid state and can\'t perform the requested operation.
', 'refs' => [], ], 'InvalidMaxAcuFault' => [ 'base' => 'The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).
', 'refs' => [], ], 'InvalidOptionGroupStateFault' => [ 'base' => 'The option group isn\'t in the available state.
', 'refs' => [], ], 'InvalidResourceStateFault' => [ 'base' => 'The operation can\'t be performed because another operation is in progress.
', 'refs' => [], ], 'InvalidRestoreFault' => [ 'base' => 'Cannot restore from VPC backup to non-VPC DB instance.
', 'refs' => [], ], 'InvalidS3BucketFault' => [ 'base' => 'The specified Amazon S3 bucket name can\'t be found or Amazon RDS isn\'t authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
', 'refs' => [], ], 'InvalidSubnet' => [ 'base' => 'The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
', 'refs' => [], ], 'InvalidVPCNetworkStateFault' => [ 'base' => 'The DB subnet group doesn\'t cover all Availability Zones after it\'s created because of users\' change.
', 'refs' => [], ], 'IssueDetails' => [ 'base' => 'The details of an issue with your DB instances, DB clusters, and DB parameter groups.
', 'refs' => [ 'DBRecommendation$IssueDetails' => 'Details of the issue that caused the recommendation.
', 'RecommendedAction$IssueDetails' => 'The details of the issue.
', ], ], 'KMSKeyNotAccessibleFault' => [ 'base' => 'An error occurred accessing an Amazon Web Services KMS key.
', 'refs' => [], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'RemoveTagsFromResourceMessage$TagKeys' => 'The tag key (name) of the tag to be removed.
', ], ], 'KmsKeyIdOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateCustomDBEngineVersionMessage$KMSKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don\'t already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
', ], ], 'LimitlessDatabase' => [ 'base' => 'Contains details for Aurora Limitless Database.
', 'refs' => [ 'DBCluster$LimitlessDatabase' => 'The details for Aurora Limitless Database.
', ], ], 'LimitlessDatabaseStatus' => [ 'base' => NULL, 'refs' => [ 'LimitlessDatabase$Status' => 'The status of Aurora Limitless Database.
', ], ], 'ListTagsForResourceMessage' => [ 'base' => '', 'refs' => [], ], 'LocalWriteForwardingStatus' => [ 'base' => NULL, 'refs' => [ 'DBCluster$LocalWriteForwardingStatus' => 'Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
', ], ], 'LogTypeList' => [ 'base' => NULL, 'refs' => [ 'CloudwatchLogsExportConfiguration$EnableLogTypes' => 'The list of log types to enable.
', 'CloudwatchLogsExportConfiguration$DisableLogTypes' => 'The list of log types to disable.
', 'CreateDBClusterMessage$EnableCloudwatchLogsExports' => 'The list of log types that need to be enabled for exporting to CloudWatch Logs.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
', 'CreateDBInstanceMessage$EnableCloudwatchLogsExports' => 'The list of log types to enable for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
RDS Custom
The following values are valid for each DB engine:
RDS for Db2 - diag.log | notify.log
RDS for MariaDB - audit | error | general | slowquery
RDS for Microsoft SQL Server - agent | error
RDS for MySQL - audit | error | general | slowquery
RDS for Oracle - alert | audit | listener | trace | oemagent
RDS for PostgreSQL - postgresql | upgrade
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'DBCluster$EnabledCloudwatchLogsExports' => 'A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
', 'DBEngineVersion$ExportableLogTypes' => 'The types of logs that the database engine has available for export to CloudWatch Logs.
', 'DBInstance$EnabledCloudwatchLogsExports' => 'A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
', 'PendingCloudwatchLogsExports$LogTypesToEnable' => 'Log types that are in the process of being deactivated. After they are deactivated, these log types aren\'t exported to CloudWatch Logs.
', 'PendingCloudwatchLogsExports$LogTypesToDisable' => 'Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
', 'RestoreDBClusterFromS3Message$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
', 'RestoreDBClusterFromSnapshotMessage$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBInstanceFromDBSnapshotMessage$EnableCloudwatchLogsExports' => 'The list of logs for the restored DB instance to export to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromS3Message$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AccountQuota$Used' => 'The amount currently used toward the quota maximum.
', 'AccountQuota$Max' => 'The maximum allowed value for the quota.
', 'DescribeDBLogFilesDetails$LastWritten' => 'A POSIX timestamp when the last log entry was written.
', 'DescribeDBLogFilesDetails$Size' => 'The size, in bytes, of the log file for the specified DB instance.
', 'DescribeDBLogFilesMessage$FileLastWritten' => 'Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
', 'DescribeDBLogFilesMessage$FileSize' => 'Filters the available log files for files larger than the specified size.
', ], ], 'LongOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$BacktrackWindow' => 'The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
The number of change records stored for Backtrack.
', 'ModifyDBClusterMessage$BacktrackWindow' => 'The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$BacktrackWindow' => 'The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
', ], ], 'Marker' => [ 'base' => NULL, 'refs' => [ 'DescribeIntegrationsMessage$Marker' => 'An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A pagination token that can be used in a later DescribeIntegrations request.
Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
', 'refs' => [ 'DBCluster$MasterUserSecret' => 'The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
', 'DBInstance$MasterUserSecret' => 'The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
', ], ], 'MaxDBShardGroupLimitReached' => [ 'base' => 'The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.
', 'refs' => [], ], 'MaxRecords' => [ 'base' => NULL, 'refs' => [ 'DescribeBlueGreenDeploymentsRequest$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints:
Must be a minimum of 20.
Can\'t exceed 100.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBProxyEndpointsRequest$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBProxyTargetGroupsRequest$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBProxyTargetsRequest$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBShardGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100
', 'DescribeExportTasksMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', ], ], 'Metric' => [ 'base' => 'The representation of a metric.
', 'refs' => [ 'MetricList$member' => NULL, ], ], 'MetricList' => [ 'base' => NULL, 'refs' => [ 'PerformanceIssueDetails$Metrics' => 'The metrics that are relevant to the performance issue.
', ], ], 'MetricQuery' => [ 'base' => 'The query to retrieve metric data points.
', 'refs' => [ 'Metric$MetricQuery' => 'The query to retrieve metric data points.
', ], ], 'MetricReference' => [ 'base' => 'The reference (threshold) for a metric.
', 'refs' => [ 'MetricReferenceList$member' => NULL, ], ], 'MetricReferenceList' => [ 'base' => NULL, 'refs' => [ 'Metric$References' => 'A list of metric references (thresholds).
', ], ], 'MinimumEngineVersionPerAllowedValue' => [ 'base' => 'The minimum DB engine version required for each corresponding allowed value for an option setting.
', 'refs' => [ 'MinimumEngineVersionPerAllowedValueList$member' => NULL, ], ], 'MinimumEngineVersionPerAllowedValueList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOptionSetting$MinimumEngineVersionPerAllowedValue' => 'The minimum DB engine version required for the corresponding allowed value for this option setting.
', ], ], 'ModifyActivityStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyActivityStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCertificatesMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCertificatesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCurrentDBClusterCapacityMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCustomDBEngineVersionMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBClusterParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBInstanceMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBProxyEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyTargetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyTargetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBRecommendationMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBShardGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotAttributeMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSubnetGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyEventSubscriptionMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyIntegrationMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyOptionGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyTenantDatabaseMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyTenantDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'NetworkTypeNotSupported' => [ 'base' => 'The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.
The details of an option.
', 'refs' => [ 'OptionsList$member' => NULL, ], ], 'OptionConfiguration' => [ 'base' => 'A list of all available options
', 'refs' => [ 'OptionConfigurationList$member' => NULL, ], ], 'OptionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ModifyOptionGroupMessage$OptionsToInclude' => 'Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
', ], ], 'OptionGroup' => [ 'base' => '', 'refs' => [ 'CopyOptionGroupResult$OptionGroup' => NULL, 'CreateOptionGroupResult$OptionGroup' => NULL, 'ModifyOptionGroupResult$OptionGroup' => NULL, 'OptionGroupsList$member' => NULL, ], ], 'OptionGroupAlreadyExistsFault' => [ 'base' => 'The option group you are trying to create already exists.
', 'refs' => [], ], 'OptionGroupMembership' => [ 'base' => 'Provides information on the option groups the DB instance is a member of.
', 'refs' => [ 'OptionGroupMembershipList$member' => NULL, ], ], 'OptionGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$OptionGroupMemberships' => 'The list of option group memberships for this DB instance.
', ], ], 'OptionGroupNotFoundFault' => [ 'base' => 'The specified option group could not be found.
', 'refs' => [], ], 'OptionGroupOption' => [ 'base' => 'Available option.
', 'refs' => [ 'OptionGroupOptionsList$member' => NULL, ], ], 'OptionGroupOptionSetting' => [ 'base' => 'Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
', 'refs' => [ 'OptionGroupOptionSettingsList$member' => NULL, ], ], 'OptionGroupOptionSettingsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionGroupOptionSettings' => 'The option settings that are available (and the default value) for each option in an option group.
', ], ], 'OptionGroupOptionVersionsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionGroupOptionVersions' => 'The versions that are available for the option.
', ], ], 'OptionGroupOptionsList' => [ 'base' => 'List of available option group options.
', 'refs' => [ 'OptionGroupOptionsMessage$OptionGroupOptions' => NULL, ], ], 'OptionGroupOptionsMessage' => [ 'base' => '', 'refs' => [], ], 'OptionGroupQuotaExceededFault' => [ 'base' => 'The quota of 20 option groups was exceeded for this Amazon Web Services account.
', 'refs' => [], ], 'OptionGroups' => [ 'base' => 'List of option groups.
', 'refs' => [], ], 'OptionGroupsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroups$OptionGroupsList' => 'List of option groups.
', ], ], 'OptionNamesList' => [ 'base' => NULL, 'refs' => [ 'ModifyOptionGroupMessage$OptionsToRemove' => 'Options in this list are removed from the option group.
', ], ], 'OptionSetting' => [ 'base' => 'Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
', 'refs' => [ 'OptionSettingConfigurationList$member' => NULL, 'OptionSettingsList$member' => NULL, ], ], 'OptionSettingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'Option$OptionSettings' => 'The option settings for this option.
', ], ], 'OptionSettingsList' => [ 'base' => NULL, 'refs' => [ 'OptionConfiguration$OptionSettings' => 'The option settings to include in an option group.
', ], ], 'OptionVersion' => [ 'base' => 'The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.
The options that conflict with this option.
', ], ], 'OptionsDependedOn' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionsDependedOn' => 'The options that are prerequisites for this option.
', ], ], 'OptionsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroup$Options' => 'Indicates what options are available in the option group.
', ], ], 'OrderableDBInstanceOption' => [ 'base' => 'Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
A data type that represents an Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'refs' => [ 'Subnet$SubnetOutpost' => 'If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', ], ], 'Parameter' => [ 'base' => 'This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
Provides a list of parameters for the DB cluster parameter group.
', 'DBParameterGroupDetails$Parameters' => 'A list of Parameter values.
Contains a list of engine default parameters.
', 'ModifyDBClusterParameterGroupMessage$Parameters' => 'A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.
When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.
You can\'t use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.
For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
', 'ResetDBClusterParameterGroupMessage$Parameters' => 'A list of parameter names in the DB cluster parameter group to reset to the default values. You can\'t use this parameter if the ResetAllParameters parameter is enabled.
To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
MariaDB
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
', 'refs' => [ 'ClusterPendingModifiedValues$PendingCloudwatchLogsExports' => NULL, 'PendingModifiedValues$PendingCloudwatchLogsExports' => NULL, ], ], 'PendingMaintenanceAction' => [ 'base' => 'Provides information about a pending maintenance action for a resource.
', 'refs' => [ 'PendingMaintenanceActionDetails$member' => NULL, ], ], 'PendingMaintenanceActionDetails' => [ 'base' => NULL, 'refs' => [ 'ResourcePendingMaintenanceActions$PendingMaintenanceActionDetails' => 'A list that provides details about the pending maintenance actions for the resource.
', ], ], 'PendingMaintenanceActions' => [ 'base' => NULL, 'refs' => [ 'PendingMaintenanceActionsMessage$PendingMaintenanceActions' => 'A list of the pending maintenance actions for the resource.
', ], ], 'PendingMaintenanceActionsMessage' => [ 'base' => 'Data returned from the DescribePendingMaintenanceActions action.
', 'refs' => [], ], 'PendingModifiedValues' => [ 'base' => 'This data type is used as a response element in the ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
', ], ], 'PerformanceInsightsMetricDimensionGroup' => [ 'base' => 'A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions:
db.sql.id - The hash of a running SQL statement, generated by Performance Insights.
db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.
db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.
db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
', ], ], 'PerformanceInsightsMetricQuery' => [ 'base' => 'A single Performance Insights metric query to process. You must provide the metric to the query. If other parameters aren\'t specified, Performance Insights returns all data points for the specified metric. Optionally, you can request the data points to be aggregated by dimension group (GroupBy) and return only those data points that match your criteria (Filter).
Constraints:
Must be a valid Performance Insights query.
The Performance Insights query that you can use to retrieve Performance Insights metric data points.
', ], ], 'PerformanceIssueDetails' => [ 'base' => 'Details of the performance issue.
', 'refs' => [ 'IssueDetails$PerformanceIssueDetails' => 'A detailed description of the issue when the recommendation category is performance.
SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
', 'refs' => [ 'ProcessorFeatureList$member' => NULL, ], ], 'ProcessorFeatureList' => [ 'base' => NULL, 'refs' => [ 'CreateDBInstanceMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to RDS Custom DB instances.
', 'DBInstance$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
', 'DBSnapshot$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
', 'ModifyDBInstanceMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to RDS Custom DB instances.
', 'PendingModifiedValues$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
', 'RestoreDBInstanceFromDBSnapshotMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromS3Message$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
', 'RestoreDBInstanceToPointInTimeMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to RDS Custom.
', ], ], 'PromoteReadReplicaDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'PromoteReadReplicaDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'PromoteReadReplicaMessage' => [ 'base' => '', 'refs' => [], ], 'PromoteReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'ProvisionedIopsNotAvailableInAZFault' => [ 'base' => 'Provisioned IOPS not available in the specified Availability Zone.
', 'refs' => [], ], 'PurchaseReservedDBInstancesOfferingMessage' => [ 'base' => '', 'refs' => [], ], 'PurchaseReservedDBInstancesOfferingResult' => [ 'base' => NULL, 'refs' => [], ], 'Range' => [ 'base' => 'A range of integer values.
', 'refs' => [ 'RangeList$member' => NULL, ], ], 'RangeList' => [ 'base' => NULL, 'refs' => [ 'ValidStorageOptions$StorageSize' => 'The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.
', 'ValidStorageOptions$ProvisionedIops' => 'The valid range of provisioned IOPS. For example, 1000-256,000.
', 'ValidStorageOptions$ProvisionedStorageThroughput' => 'The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).
', ], ], 'RdsCustomClusterConfiguration' => [ 'base' => 'Reserved for future use.
', 'refs' => [ 'ClusterPendingModifiedValues$RdsCustomClusterConfiguration' => 'Reserved for future use.
', 'CreateDBClusterMessage$RdsCustomClusterConfiguration' => 'Reserved for future use.
', 'DBCluster$RdsCustomClusterConfiguration' => 'Reserved for future use.
', 'RestoreDBClusterFromSnapshotMessage$RdsCustomClusterConfiguration' => 'Reserved for future use.
', 'RestoreDBClusterToPointInTimeMessage$RdsCustomClusterConfiguration' => 'Reserved for future use.
', ], ], 'ReadReplicaDBClusterIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$ReadReplicaDBClusterIdentifiers' => 'The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn\'t contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
The identifiers of the read replicas associated with this DB instance.
', ], ], 'ReadReplicaIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$ReadReplicaIdentifiers' => 'Contains one or more identifiers of the read replicas associated with this DB cluster.
', ], ], 'ReadersArnList' => [ 'base' => NULL, 'refs' => [ 'GlobalClusterMember$Readers' => 'The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.
', ], ], 'RebootDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RebootDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'RebootDBInstanceMessage' => [ 'base' => '', 'refs' => [], ], 'RebootDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'RebootDBShardGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'RecommendedAction' => [ 'base' => 'The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.
', 'refs' => [ 'RecommendedActionList$member' => NULL, ], ], 'RecommendedActionList' => [ 'base' => NULL, 'refs' => [ 'DBRecommendation$RecommendedActions' => 'A list of recommended actions.
', ], ], 'RecommendedActionParameter' => [ 'base' => 'A single parameter to use with the RecommendedAction API operation to apply the action.
The parameters for the API operation.
', ], ], 'RecommendedActionUpdate' => [ 'base' => 'The recommended status to update for the specified recommendation action ID.
', 'refs' => [ 'RecommendedActionUpdateList$member' => NULL, ], ], 'RecommendedActionUpdateList' => [ 'base' => NULL, 'refs' => [ 'ModifyDBRecommendationMessage$RecommendedActionUpdates' => 'The list of recommended action status to update. You can update multiple recommended actions at one time.
', ], ], 'RecurringCharge' => [ 'base' => 'This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
The recurring price charged to run this reserved DB instance.
', 'ReservedDBInstancesOffering$RecurringCharges' => 'The recurring price charged to run this reserved DB instance.
', ], ], 'ReferenceDetails' => [ 'base' => 'The reference details of a metric.
', 'refs' => [ 'MetricReference$ReferenceDetails' => 'The details of a performance issue.
', ], ], 'RegisterDBProxyTargetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterDBProxyTargetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'RemoveFromGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveFromGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRoleFromDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRoleFromDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'base' => '', 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveTagsFromResourceMessage' => [ 'base' => '', 'refs' => [], ], 'ReplicaMode' => [ 'base' => NULL, 'refs' => [ 'CreateDBInstanceReadReplicaMessage$ReplicaMode' => 'The open mode of the replica database: mounted or read-only.
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn\'t use Active Data Guard to transmit information to the mounted replica. Because it doesn\'t accept user connections, a mounted replica can\'t serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
For RDS Custom, you must specify this parameter and set it to mounted. The value won\'t be set by default. After replica creation, you can manage the open mode manually.
The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn\'t use Active Data Guard to transmit information to the mounted replica. Because it doesn\'t accept user connections, a mounted replica can\'t serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'RdsCustomClusterConfiguration$ReplicaMode' => 'Reserved for future use.
', ], ], 'ReservedDBInstance' => [ 'base' => 'This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
User already has a reservation with the given identifier.
', 'refs' => [], ], 'ReservedDBInstanceList' => [ 'base' => NULL, 'refs' => [ 'ReservedDBInstanceMessage$ReservedDBInstances' => 'A list of reserved DB instances.
', ], ], 'ReservedDBInstanceMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeReservedDBInstances action.
The specified reserved DB Instance not found.
', 'refs' => [], ], 'ReservedDBInstanceQuotaExceededFault' => [ 'base' => 'Request would exceed the user\'s DB Instance quota.
', 'refs' => [], ], 'ReservedDBInstancesOffering' => [ 'base' => 'This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
A list of reserved DB instance offerings.
', ], ], 'ReservedDBInstancesOfferingMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
Specified offering does not exist.
', 'refs' => [], ], 'ResetDBClusterParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ResetDBParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ResourceNotFoundFault' => [ 'base' => 'The specified resource ID was not found.
', 'refs' => [], ], 'ResourcePendingMaintenanceActions' => [ 'base' => 'Describes the pending maintenance actions for a resource.
', 'refs' => [ 'ApplyPendingMaintenanceActionResult$ResourcePendingMaintenanceActions' => NULL, 'PendingMaintenanceActions$member' => NULL, ], ], 'RestoreDBClusterFromS3Message' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterFromS3Result' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'RestoreDBClusterFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'base' => '', 'refs' => [], ], 'RestoreDBClusterToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Message' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Result' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceToPointInTimeMessage' => [ 'base' => '', 'refs' => [], ], 'RestoreDBInstanceToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreWindow' => [ 'base' => 'Earliest and latest time an instance can be restored to:
', 'refs' => [ 'DBClusterAutomatedBackup$RestoreWindow' => NULL, 'DBInstanceAutomatedBackup$RestoreWindow' => 'The earliest and latest time a DB instance can be restored to.
', ], ], 'RevokeDBSecurityGroupIngressMessage' => [ 'base' => '', 'refs' => [], ], 'RevokeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'SNSInvalidTopicFault' => [ 'base' => 'SNS has responded that there is a problem with the SNS topic specified.
', 'refs' => [], ], 'SNSNoAuthorizationFault' => [ 'base' => 'You do not have permission to publish to the SNS topic ARN.
', 'refs' => [], ], 'SNSTopicArnNotFoundFault' => [ 'base' => 'The SNS topic ARN does not exist.
', 'refs' => [], ], 'ScalarReferenceDetails' => [ 'base' => 'The metric reference details when the reference is a scalar.
', 'refs' => [ 'ReferenceDetails$ScalarReferenceDetails' => 'The metric reference details when the reference is a scalar.
', ], ], 'ScalingConfiguration' => [ 'base' => 'Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
', 'refs' => [ 'CreateDBClusterMessage$ScalingConfiguration' => 'For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$ScalingConfiguration' => 'The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$ScalingConfiguration' => 'For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$ScalingConfiguration' => 'For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
', ], ], 'ScalingConfigurationInfo' => [ 'base' => 'The scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
', 'refs' => [ 'DBCluster$ScalingConfigurationInfo' => NULL, ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'CreateTenantDatabaseMessage$MasterUserPassword' => 'The password for the master user in your tenant database.
Constraints:
Must be 8 to 30 characters.
Can include any printable ASCII character except forward slash (/), double quote ("), at symbol (@), ampersand (&), or single quote (\').
The new password for the master user of the specified tenant database in your DB instance.
Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
Constraints:
Can include any printable ASCII character except /, " (double quote), @, & (ampersand), and \' (single quote).
Length constraints:
Must contain between 8 and 30 characters.
The master password for the tenant database.
', ], ], 'ServerlessV2ScalingConfiguration' => [ 'base' => 'Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
', 'refs' => [ 'CreateDBClusterMessage$ServerlessV2ScalingConfiguration' => NULL, 'ModifyDBClusterMessage$ServerlessV2ScalingConfiguration' => NULL, 'RestoreDBClusterFromS3Message$ServerlessV2ScalingConfiguration' => NULL, 'RestoreDBClusterFromSnapshotMessage$ServerlessV2ScalingConfiguration' => NULL, 'RestoreDBClusterToPointInTimeMessage$ServerlessV2ScalingConfiguration' => NULL, ], ], 'ServerlessV2ScalingConfigurationInfo' => [ 'base' => 'The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
', 'refs' => [ 'DBCluster$ServerlessV2ScalingConfiguration' => NULL, ], ], 'SharedSnapshotQuotaExceededFault' => [ 'base' => 'You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
', 'refs' => [], ], 'SnapshotQuotaExceededFault' => [ 'base' => 'The request would result in the user exceeding the allowed number of DB snapshots.
', 'refs' => [], ], 'SourceArn' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$SourceArn' => 'The Amazon Resource Name (ARN) of the database to use as the source for replication.
', 'Integration$SourceArn' => 'The Amazon Resource Name (ARN) of the database used as the source for replication.
', ], ], 'SourceClusterNotSupportedFault' => [ 'base' => 'The source DB cluster isn\'t supported for a blue/green deployment.
', 'refs' => [], ], 'SourceDatabaseNotSupportedFault' => [ 'base' => 'The source DB instance isn\'t supported for a blue/green deployment.
', 'refs' => [], ], 'SourceIdsList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$SourceIds' => 'The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can\'t end with a hyphen or contain two consecutive hyphens.
Constraints:
If SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
A list of source IDs for the RDS event notification subscription.
', ], ], 'SourceNotFoundFault' => [ 'base' => 'The requested source could not be found.
', 'refs' => [], ], 'SourceRegion' => [ 'base' => 'Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.
A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.
Contains the result of a successful invocation of the DescribeSourceRegions action.
The event source to retrieve events for. If no value is specified, all events are returned.
', 'Event$SourceType' => 'Specifies the source type for this event.
', ], ], 'StartActivityStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartActivityStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceAutomatedBackupsReplicationMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceAutomatedBackupsReplicationResult' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StartExportTaskMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopActivityStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopActivityStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceAutomatedBackupsReplicationMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceAutomatedBackupsReplicationResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StorageQuotaExceededFault' => [ 'base' => 'The request would result in the user exceeding the allowed amount of storage available across all DB instances.
', 'refs' => [], ], 'StorageTypeNotAvailableFault' => [ 'base' => 'The aurora-iopt1 storage type isn\'t available, because you modified the DB cluster to use this storage type less than one month ago.
The specified StorageType can\'t be associated with the DB instance.
The name of the Amazon RDS quota for this Amazon Web Services account.
', 'ActivityStreamModeList$member' => NULL, 'AddRoleToDBClusterMessage$DBClusterIdentifier' => 'The name of the DB cluster to associate the IAM role with.
', 'AddRoleToDBClusterMessage$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
', 'AddRoleToDBInstanceMessage$DBInstanceIdentifier' => 'The name of the DB instance to associate the IAM role with.
', 'AddRoleToDBInstanceMessage$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
', 'AddSourceIdentifierToSubscriptionMessage$SubscriptionName' => 'The name of the RDS event notification subscription you want to add a source identifier to.
', 'AddSourceIdentifierToSubscriptionMessage$SourceIdentifier' => 'The identifier of the event source to be added.
Constraints:
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', 'ApplyPendingMaintenanceActionMessage$ResourceIdentifier' => 'The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', 'ApplyPendingMaintenanceActionMessage$ApplyAction' => 'The pending maintenance action to apply to this resource.
Valid Values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can\'t be undone.
Valid Values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
The name of the DB security group to add authorization to.
', 'AuthorizeDBSecurityGroupIngressMessage$CIDRIP' => 'The IP range to authorize.
', 'AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName' => 'Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn\'t an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The name of the Availability Zone.
', 'AvailabilityZones$member' => NULL, 'AvailableProcessorFeature$Name' => 'The name of the processor feature. Valid names are coreCount and threadsPerCore.
The default value for the processor feature of the DB instance class.
', 'AvailableProcessorFeature$AllowedValues' => 'The allowed values for the processor feature of the DB instance class.
', 'BacktrackDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The identifier of the snapshot or cluster export task to cancel.
', 'Certificate$CertificateIdentifier' => 'The unique key that identifies a certificate.
', 'Certificate$CertificateType' => 'The type of the certificate.
', 'Certificate$Thumbprint' => 'The thumbprint of the certificate.
', 'Certificate$CertificateArn' => 'The Amazon Resource Name (ARN) for the certificate.
', 'CertificateDetails$CAIdentifier' => 'The CA identifier of the CA certificate used for the DB instance\'s server certificate.
', 'CertificateMessage$DefaultCertificateForNewLaunches' => 'The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the ModifyCertificates operation.
An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The name of the character set.
', 'CharacterSet$CharacterSetDescription' => 'The description of the character set.
', 'ClusterPendingModifiedValues$DBClusterIdentifier' => 'The DBClusterIdentifier value for the DB cluster.
', 'ClusterPendingModifiedValues$MasterUserPassword' => 'The master credentials for the DB cluster.
', 'ClusterPendingModifiedValues$EngineVersion' => 'The database engine version.
', 'ClusterPendingModifiedValues$StorageType' => 'The storage type for the DB cluster.
', 'ConnectionPoolConfiguration$InitQuery' => 'One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
Default: no initialization query
', 'ConnectionPoolConfigurationInfo$InitQuery' => 'One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
The key of ContextAttribute.
The value of ContextAttribute.
The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.
Constraints:
Must specify a valid DB cluster parameter group.
The identifier for the copied DB cluster parameter group.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-cluster-param-group1
A description for the copied DB cluster parameter group.
', 'CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier' => 'The identifier of the DB cluster snapshot to copy. This parameter isn\'t case-sensitive.
You can\'t copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
Constraints:
Must specify a valid system snapshot in the "available" state.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
Example: my-cluster-snapshot1
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn\'t case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you don\'t specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don\'t specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It\'s ignored in other Amazon Web Services Regions.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Constraints:
Must specify a valid DB parameter group.
The identifier for the copied DB parameter group.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-db-parameter-group
A description for the copied DB parameter group.
', 'CopyDBSnapshotMessage$SourceDBSnapshotIdentifier' => 'The identifier for the source DB snapshot.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
Constraints:
Must specify a valid system snapshot in the "available" state.
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
The identifier for the copy of the snapshot.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-db-snapshot
The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don\'t specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
', 'CopyDBSnapshotMessage$PreSignedUrl' => 'When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It\'s ignored in other Amazon Web Services Regions.
You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don\'t specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
The name of an option group to associate with the copy of the snapshot.
Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.
', 'CopyDBSnapshotMessage$TargetCustomAvailabilityZone' => 'The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example: rds-caz-aiqhTgQv.
The identifier for the source option group.
Constraints:
Must specify a valid option group.
The identifier for the copied option group.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-option-group
The description for the copied option group.
', 'CreateDBClusterEndpointMessage$DBClusterIdentifier' => 'The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
', 'CreateDBClusterEndpointMessage$DBClusterEndpointIdentifier' => 'The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
', 'CreateDBClusterEndpointMessage$EndpointType' => 'The type of the endpoint, one of: READER, WRITER, ANY.
The name of the character set (CharacterSet) to associate the DB cluster with.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$DatabaseName' => 'The name for your database of up to 64 alphanumeric characters. If you don\'t provide a name, Amazon RDS doesn\'t create a database in the DB cluster you are creating.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$DBClusterIdentifier' => 'The identifier for this DB cluster. This parameter is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with this DB cluster. If you don\'t specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the name of an existing DB subnet group.
Must not be default.
Example: mydbsubnetgroup
The database engine to use for this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres
The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
For information about a specific engine, see the following topics:
Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide.
RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$MasterUsername' => 'The name of the master user for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can\'t be specified if ManageMasterUserPassword is turned on.
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can\'t be modified.
', 'CreateDBClusterMessage$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn\'t specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn\'t specified, then Amazon RDS uses your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$PreSignedUrl' => 'When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.
The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$EngineMode' => 'The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.
For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$GlobalClusterIdentifier' => 'The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$Domain' => 'The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
For more information, see Kerberos authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$DBClusterInstanceClass' => 'The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$StorageType' => 'The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned in the response. The storage type isn\'t returned when you set it to aurora.
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don\'t specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$NetworkType' => 'The network type of the DB cluster.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
Reserved for future use.
', 'CreateDBClusterMessage$MasterUserSecretKmsKeyId' => 'The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB cluster\'s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
', 'CreateDBClusterParameterGroupMessage$DBClusterParameterGroupName' => 'The name of the DB cluster parameter group.
Constraints:
Must not match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora-mysql5.7, aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql14
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres13
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mysql
postgres
The description for the DB cluster parameter group.
', 'CreateDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => 'The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1-snapshot1
The identifier of the DB cluster to create a snapshot for. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
Example: my-cluster1
The meaning of this parameter differs according to the database engine you use.
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn\'t specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
Must contain 1 to 64 alphanumeric characters.
Can\'t be a word reserved by the database engine.
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn\'t specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.
Constraints:
It must contain 1 to 63 alphanumeric characters.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
Can\'t be a word reserved by the database engine.
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don\'t specify a value, the default value is ORCL for non-CDBs and RDSCDB for CDBs.
Default: ORCL
Constraints:
Must contain 1 to 8 alphanumeric characters.
Must contain a letter.
Can\'t be a word reserved by the database engine.
Not applicable. Must be null.
The name of the database to create when the DB instance is created. If this parameter isn\'t specified, no database is created in the DB instance. In some cases, we recommend that you don\'t add a database name. For more information, see Additional considerations in the Amazon RDS User Guide.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can\'t be a word reserved by the specified database engine.
The name of the database to create when the DB instance is created. If this parameter isn\'t specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can\'t be a word reserved by the specified database engine.
The name of the database to create when the DB instance is created. If this parameter isn\'t specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can\'t be a word reserved by the specified database engine.
The Oracle System ID (SID) of the created DB instance. If you don\'t specify a value, the default value is ORCL. You can\'t specify the string null, or any other reserved word, for DBName.
Default: ORCL
Constraints:
Can\'t be longer than 8 characters.
The name of the database to create when the DB instance is created. If this parameter isn\'t specified, a database named postgres is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can\'t be a word reserved by the specified database engine.
Not applicable. Must be null.
The identifier for this DB instance. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
The database engine to use for this DB instance.
Not every database engine is available in every Amazon Web Services Region.
Valid Values:
aurora-mysql (for Aurora MySQL DB instances)
aurora-postgresql (for Aurora PostgreSQL DB instances)
custom-oracle-ee (for RDS Custom for Oracle DB instances)
custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
custom-oracle-se2 (for RDS Custom for Oracle DB instances)
custom-oracle-se2-cdb (for RDS Custom for Oracle DB instances)
custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The name for the master user.
This setting doesn\'t apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.
This setting is required for RDS DB instances.
Constraints:
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The password for the master user.
This setting doesn\'t apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.
Constraints:
Can\'t be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can\'t include the "&" (ampersand) or the "\'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don\'t specify one.
Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.
Constraints:
The AvailabilityZone parameter can\'t be specified if the DB instance is a Multi-AZ deployment.
The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
Example: us-east-1d
A DB subnet group to associate with this DB instance.
Constraints:
Must match the name of an existing DB subnet group.
Must not be default.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The name of the DB parameter group to associate with this DB instance. If you don\'t specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
This setting doesn\'t apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The version number of the database engine to use.
This setting doesn\'t apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster.
For a list of valid engine versions, use the DescribeDBEngineVersions operation.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.
For information, see Db2 on Amazon RDS versions in the Amazon RDS User Guide.
For information, see MariaDB on Amazon RDS versions in the Amazon RDS User Guide.
For information, see Microsoft SQL Server versions on Amazon RDS in the Amazon RDS User Guide.
For information, see MySQL on Amazon RDS versions in the Amazon RDS User Guide.
For information, see Oracle Database Engine release notes in the Amazon RDS User Guide.
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
The license model information for this DB instance.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
The option group to associate the DB instance with.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group. Also, that option group can\'t be removed from a DB instance after it is associated with a DB instance.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'CreateDBInstanceMessage$CharacterSetName' => 'For supported engines, the character set (CharacterSet) to associate the DB instance with.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora - The character set is managed by the DB cluster. For more information, see CreateDBCluster.
RDS Custom - However, if you need to change the character set, you can change it on the database itself.
The name of the NCHAR character set for the Oracle DB instance.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$DBClusterIdentifier' => 'The identifier of the DB cluster that this DB instance will belong to.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$StorageType' => 'The storage type to associate with the DB instance.
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
This setting doesn\'t apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'CreateDBInstanceMessage$TdeCredentialPassword' => 'The password for the given ARN from the key store in order to access the device.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
This setting doesn\'t apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn\'t use the default key when this parameter is empty. You must explicitly specify a key.
The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (The domain is managed by the DB cluster.)
RDS Custom
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (The domain is managed by the DB cluster.)
RDS Custom
The time zone of the DB instance. The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server.
', 'CreateDBInstanceMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don\'t specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$CustomIamInstanceProfile' => 'The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
This setting is required for RDS Custom.
Constraints:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
', 'CreateDBInstanceMessage$BackupTarget' => 'The location for storing automated backups and manual snapshots.
Valid Values:
outposts (Amazon Web Services Outposts)
region (Amazon Web Services Region)
Default: region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'CreateDBInstanceMessage$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values: IPV4 | DUAL
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
', 'CreateDBInstanceMessage$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'CreateDBInstanceMessage$DBSystemId' => 'The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don\'t specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
', 'CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier' => 'The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance.
Can\'t be specified if the SourceDBClusterIdentifier parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn\'t apply to SQL Server or RDS Custom, which don\'t support cross-Region replicas.
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits the value from the source DB instance.
', 'CreateDBInstanceReadReplicaMessage$AvailabilityZone' => 'The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.
Example: us-east-1d
The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.
For SQL Server, you must use the option group associated with the source.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$DBParameterGroupName' => 'The name of the DB parameter group to associate with this DB instance.
If you don\'t specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of the source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas and for Oracle DB instances. It isn\'t supported for MySQL DB instances for same Region read replicas or for RDS Custom.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn\'t created in a VPC.
Constraints:
If supplied, must match the name of an existing DB subnet group.
The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:
Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
Not specify a DB subnet group. All these read replicas are created outside of any VPC.
Example: mydbsubnetgroup
The storage type to associate with the read replica.
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1 if the Iops parameter is specified. Otherwise, gp2.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don\'t specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can\'t create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.
This setting doesn\'t apply to RDS Custom, which uses the same KMS key as the primary replica.
', 'CreateDBInstanceReadReplicaMessage$PreSignedUrl' => 'When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It\'s ignored in other Amazon Web Services Regions.
This setting applies only when replicating from a source DB instance. Source DB clusters aren\'t supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don\'t specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
SourceRegion isn\'t supported for SQL Server, because Amazon RDS for SQL Server doesn\'t support cross-Region read replicas.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$Domain' => 'The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$DomainFqdn' => 'The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$NetworkType' => 'The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'CreateDBInstanceReadReplicaMessage$SourceDBClusterIdentifier' => 'The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
Must be the identifier of an existing Multi-AZ DB cluster.
Can\'t be specified if the SourceDBInstanceIdentifier parameter is also specified.
The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn\'t supported.
The CA certificate identifier to use for the read replica\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'CreateDBParameterGroupMessage$DBParameterGroupName' => 'The name of the DB parameter group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
db2-ae
db2-se
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The description for the DB parameter group.
', 'CreateDBProxyRequest$DBProxyName' => 'The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
', 'CreateDBProxyRequest$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
', 'CreateDBSecurityGroupMessage$DBSecurityGroupName' => 'The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Must not be "Default"
Example: mysecuritygroup
The description for the DB security group.
', 'CreateDBShardGroupMessage$DBShardGroupIdentifier' => 'The name of the DB shard group.
', 'CreateDBShardGroupMessage$DBClusterIdentifier' => 'The name of the primary DB cluster for the DB shard group.
', 'CreateDBSnapshotMessage$DBSnapshotIdentifier' => 'The identifier for the DB snapshot.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
Must match the identifier of an existing DBInstance.
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
Must not be default.
First character must be a letter.
Example: mydbsubnetgroup
The description for the DB subnet group.
', 'CreateEventSubscriptionMessage$SubscriptionName' => 'The name of the subscription.
Constraints: The name must be less than 255 characters.
', 'CreateEventSubscriptionMessage$SnsTopicArn' => 'The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.
RDS doesn\'t support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn\'t specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
', 'CreateGlobalClusterMessage$SourceDBClusterIdentifier' => 'The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
If you provide a value for this parameter, don\'t specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:
DatabaseName
Engine
EngineVersion
StorageEncrypted
The database engine to use for this global database cluster.
Valid Values: aurora-mysql | aurora-postgresql
Constraints:
Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.
The engine version to use for this global database cluster.
Constraints:
Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.
The name for your database of up to 64 alphanumeric characters. If you don\'t specify a name, Amazon Aurora doesn\'t create a database in the global database cluster.
Constraints:
Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don\'t specify an encryption key, RDS uses a default Amazon Web Services owned key.
', 'CreateOptionGroupMessage$OptionGroupName' => 'Specifies the name of the option group to be created.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: myoptiongroup
The name of the engine to associate this option group with.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Specifies the major version of the engine that this option group should be associated with.
', 'CreateOptionGroupMessage$OptionGroupDescription' => 'The description of the option group.
', 'CreateTenantDatabaseMessage$DBInstanceIdentifier' => 'The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn\'t case-sensitive.
', 'CreateTenantDatabaseMessage$TenantDBName' => 'The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as DBName in CreateDBInstance.
The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive.
Constraints:
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The character set for your tenant database. If you don\'t specify a value, the character set name defaults to AL32UTF8.
The NCHAR value for the tenant database.
A value that indicates the ID of the AMI.
', 'CustomDBEngineVersionAMI$Status' => 'A value that indicates the status of a custom engine version (CEV).
', 'DBCluster$CharacterSetName' => 'If present, specifies the name of the character set that this cluster is associated with.
', 'DBCluster$DatabaseName' => 'The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
', 'DBCluster$DBClusterIdentifier' => 'The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
', 'DBCluster$DBClusterParameterGroup' => 'The name of the DB cluster parameter group for the DB cluster.
', 'DBCluster$DBSubnetGroup' => 'Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
', 'DBCluster$Status' => 'The current state of this DB cluster.
', 'DBCluster$PercentProgress' => 'The progress of the operation as a percentage.
', 'DBCluster$Endpoint' => 'The connection endpoint for the primary instance of the DB cluster.
', 'DBCluster$ReaderEndpoint' => 'The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
', 'DBCluster$Engine' => 'The database engine used for this DB cluster.
', 'DBCluster$EngineVersion' => 'The version of the database engine.
', 'DBCluster$MasterUsername' => 'The master username for the DB cluster.
', 'DBCluster$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
', 'DBCluster$ReplicationSourceIdentifier' => 'The identifier of the source DB cluster if this DB cluster is a read replica.
', 'DBCluster$HostedZoneId' => 'The ID that Amazon Route 53 assigns when you create a hosted zone.
', 'DBCluster$KmsKeyId' => 'If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBCluster$DbClusterResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
', 'DBCluster$DBClusterArn' => 'The Amazon Resource Name (ARN) for the DB cluster.
', 'DBCluster$CloneGroupId' => 'The ID of the clone group with which the DB cluster is associated.
', 'DBCluster$EngineMode' => 'The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
', 'DBCluster$ActivityStreamKmsKeyId' => 'The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBCluster$ActivityStreamKinesisStreamName' => 'The name of the Amazon Kinesis data stream used for the database activity stream.
', 'DBCluster$DBClusterInstanceClass' => 'The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$StorageType' => 'The storage type associated with the DB cluster.
', 'DBCluster$MonitoringRoleArn' => 'The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
Reserved for future use.
', 'DBCluster$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'DBClusterAutomatedBackup$Engine' => 'The name of the database engine for this automated backup.
', 'DBClusterAutomatedBackup$VpcId' => 'The VPC ID associated with the DB cluster.
', 'DBClusterAutomatedBackup$DBClusterAutomatedBackupsArn' => 'The Amazon Resource Name (ARN) for the automated backups.
', 'DBClusterAutomatedBackup$DBClusterIdentifier' => 'The identifier for the source DB cluster, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBClusterAutomatedBackup$MasterUsername' => 'The master user name of the automated backup.
', 'DBClusterAutomatedBackup$DbClusterResourceId' => 'The resource ID for the source DB cluster, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBClusterAutomatedBackup$Region' => 'The Amazon Web Services Region associated with the automated backup.
', 'DBClusterAutomatedBackup$LicenseModel' => 'The license model information for this DB cluster automated backup.
', 'DBClusterAutomatedBackup$Status' => 'A list of status information for an automated backup:
retained - Automated backups for deleted clusters.
The version of the database engine for the automated backup.
', 'DBClusterAutomatedBackup$DBClusterArn' => 'The Amazon Resource Name (ARN) for the source DB cluster.
', 'DBClusterAutomatedBackup$EngineMode' => 'The engine mode of the database engine for the automated backup.
', 'DBClusterAutomatedBackup$KmsKeyId' => 'The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBClusterAutomatedBackup$StorageType' => 'The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterAutomatedBackup$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'DBClusterAutomatedBackupMessage$Marker' => 'The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
', 'DBClusterBacktrack$BacktrackIdentifier' => 'Contains the backtrack identifier.
', 'DBClusterBacktrack$Status' => 'The status of the backtrack. This property returns one of the following values:
applying - The backtrack is currently being applied to or rolled back from the DB cluster.
completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
pending - The backtrack is currently pending application to or rollback from the DB cluster.
A pagination token that can be used in a later DescribeDBClusterBacktracks request.
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
', 'DBClusterCapacityInfo$TimeoutAction' => 'The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
', 'DBClusterEndpoint$DBClusterIdentifier' => 'The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
', 'DBClusterEndpoint$DBClusterEndpointResourceIdentifier' => 'A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
', 'DBClusterEndpoint$Endpoint' => 'The DNS address of the endpoint.
', 'DBClusterEndpoint$Status' => 'The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can\'t be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
The type of the endpoint. One of: READER, WRITER, CUSTOM.
The type associated with a custom endpoint. One of: READER, WRITER, ANY.
The Amazon Resource Name (ARN) for the endpoint.
', 'DBClusterEndpointMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the instance identifier for this member of the DB cluster.
', 'DBClusterMember$DBClusterParameterGroupStatus' => 'Specifies the status of the DB cluster parameter group for this member of the DB cluster.
', 'DBClusterMessage$Marker' => 'A pagination token that can be used in a later DescribeDBClusters request.
Specifies the name of the DB cluster option group.
', 'DBClusterOptionGroupStatus$Status' => 'Specifies the status of the DB cluster option group.
', 'DBClusterParameterGroup$DBClusterParameterGroupName' => 'The name of the DB cluster parameter group.
', 'DBClusterParameterGroup$DBParameterGroupFamily' => 'The name of the DB parameter group family that this DB cluster parameter group is compatible with.
', 'DBClusterParameterGroup$Description' => 'Provides the customer-specified description for this DB cluster parameter group.
', 'DBClusterParameterGroup$DBClusterParameterGroupArn' => 'The Amazon Resource Name (ARN) for the DB cluster parameter group.
', 'DBClusterParameterGroupDetails$Marker' => 'An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
', 'DBClusterRole$Status' => 'Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
', 'DBClusterSnapshot$DBClusterSnapshotIdentifier' => 'The identifier for the DB cluster snapshot.
', 'DBClusterSnapshot$DBClusterIdentifier' => 'The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
', 'DBClusterSnapshot$Engine' => 'The name of the database engine for this DB cluster snapshot.
', 'DBClusterSnapshot$EngineMode' => 'The engine mode of the database engine for this DB cluster snapshot.
', 'DBClusterSnapshot$Status' => 'The status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
The VPC ID associated with the DB cluster snapshot.
', 'DBClusterSnapshot$MasterUsername' => 'The master username for this DB cluster snapshot.
', 'DBClusterSnapshot$EngineVersion' => 'The version of the database engine for this DB cluster snapshot.
', 'DBClusterSnapshot$LicenseModel' => 'The license model information for this DB cluster snapshot.
', 'DBClusterSnapshot$SnapshotType' => 'The type of the DB cluster snapshot.
', 'DBClusterSnapshot$KmsKeyId' => 'If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBClusterSnapshot$DBClusterSnapshotArn' => 'The Amazon Resource Name (ARN) for the DB cluster snapshot.
', 'DBClusterSnapshot$SourceDBClusterSnapshotArn' => 'If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
', 'DBClusterSnapshot$DBSystemId' => 'Reserved for future use.
', 'DBClusterSnapshot$StorageType' => 'The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
', 'DBClusterSnapshot$DbClusterResourceId' => 'The resource ID of the DB cluster that this DB cluster snapshot was created from.
', 'DBClusterSnapshotAttribute$AttributeName' => 'The name of the manual DB cluster snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The identifier of the manual DB cluster snapshot that the attributes apply to.
', 'DBClusterSnapshotMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Reserved for future use.
', 'DBClusterStatusInfo$Status' => 'Reserved for future use.
', 'DBClusterStatusInfo$Message' => 'Reserved for future use.
', 'DBEngineVersion$Engine' => 'The name of the database engine.
', 'DBEngineVersion$EngineVersion' => 'The version number of the database engine.
', 'DBEngineVersion$DBParameterGroupFamily' => 'The name of the DB parameter group family for the database engine.
', 'DBEngineVersion$DBEngineDescription' => 'The description of the database engine.
', 'DBEngineVersion$DBEngineVersionDescription' => 'The description of the database engine version.
', 'DBEngineVersion$DBEngineMediaType' => 'A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
', 'DBEngineVersion$Status' => 'The status of the DB engine version, either available or deprecated.
The major engine version of the CEV.
', 'DBEngineVersion$DatabaseInstallationFilesS3BucketName' => 'The name of the Amazon S3 bucket that contains your database installation files.
', 'DBEngineVersion$DatabaseInstallationFilesS3Prefix' => 'The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
', 'DBEngineVersion$DBEngineVersionArn' => 'The ARN of the custom engine version.
', 'DBEngineVersion$KMSKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
', 'DBEngineVersionMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
', 'DBInstance$DBInstanceClass' => 'The name of the compute and memory capacity class of the DB instance.
', 'DBInstance$Engine' => 'The database engine used for this DB instance.
', 'DBInstance$DBInstanceStatus' => 'The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
', 'DBInstance$MasterUsername' => 'The master username for the DB instance.
', 'DBInstance$DBName' => 'The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
', 'DBInstance$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
The name of the Availability Zone where the DB instance is located.
', 'DBInstance$PreferredMaintenanceWindow' => 'The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
', 'DBInstance$EngineVersion' => 'The version of the database engine.
', 'DBInstance$ReadReplicaSourceDBInstanceIdentifier' => 'The identifier of the source DB instance if this DB instance is a read replica.
', 'DBInstance$LicenseModel' => 'The license model information for this DB instance. This setting doesn\'t apply to RDS Custom DB instances.
', 'DBInstance$CharacterSetName' => 'If present, specifies the name of the character set that this instance is associated with.
', 'DBInstance$NcharCharacterSetName' => 'The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
', 'DBInstance$SecondaryAvailabilityZone' => 'If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
', 'DBInstance$StorageType' => 'The storage type associated with the DB instance.
', 'DBInstance$TdeCredentialArn' => 'The ARN from the key store with which the instance is associated for TDE encryption.
', 'DBInstance$DBClusterIdentifier' => 'If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
', 'DBInstance$KmsKeyId' => 'If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBInstance$DbiResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
', 'DBInstance$CACertificateIdentifier' => 'The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'DBInstance$EnhancedMonitoringResourceArn' => 'The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
', 'DBInstance$MonitoringRoleArn' => 'The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
', 'DBInstance$DBInstanceArn' => 'The Amazon Resource Name (ARN) for the DB instance.
', 'DBInstance$Timezone' => 'The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBInstance$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'DBInstance$ActivityStreamKmsKeyId' => 'The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBInstance$ActivityStreamKinesisStreamName' => 'The name of the Amazon Kinesis data stream used for the database activity stream.
', 'DBInstance$CustomIamInstanceProfile' => 'The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
', 'DBInstance$BackupTarget' => 'The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
', 'DBInstance$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values: IPV4 | DUAL
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
', 'DBInstance$ReadReplicaSourceDBClusterIdentifier' => 'The identifier of the source DB cluster if this DB instance is a read replica.
', 'DBInstance$PercentProgress' => 'The progress of the storage optimization operation as a percentage.
', 'DBInstanceAutomatedBackup$DBInstanceArn' => 'The Amazon Resource Name (ARN) for the automated backups.
', 'DBInstanceAutomatedBackup$DbiResourceId' => 'The resource ID for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBInstanceAutomatedBackup$Region' => 'The Amazon Web Services Region associated with the automated backup.
', 'DBInstanceAutomatedBackup$DBInstanceIdentifier' => 'The identifier for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBInstanceAutomatedBackup$Status' => 'A list of status information for an automated backup:
active - Automated backups for current instances.
retained - Automated backups for deleted instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
', 'DBInstanceAutomatedBackup$VpcId' => 'The VPC ID associated with the DB instance.
', 'DBInstanceAutomatedBackup$MasterUsername' => 'The master user name of an automated backup.
', 'DBInstanceAutomatedBackup$Engine' => 'The name of the database engine for this automated backup.
', 'DBInstanceAutomatedBackup$EngineVersion' => 'The version of the database engine for the automated backup.
', 'DBInstanceAutomatedBackup$LicenseModel' => 'The license model information for the automated backup.
', 'DBInstanceAutomatedBackup$OptionGroupName' => 'The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
', 'DBInstanceAutomatedBackup$TdeCredentialArn' => 'The ARN from the key store with which the automated backup is associated for TDE encryption.
', 'DBInstanceAutomatedBackup$StorageType' => 'The storage type associated with the automated backup.
', 'DBInstanceAutomatedBackup$KmsKeyId' => 'The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBInstanceAutomatedBackup$Timezone' => 'The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
The Amazon Resource Name (ARN) for the replicated automated backups.
', 'DBInstanceAutomatedBackup$BackupTarget' => 'The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
', 'DBInstanceAutomatedBackup$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'DBInstanceAutomatedBackupMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the replicated automated backups.
', 'DBInstanceMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
', 'DBInstanceRole$FeatureName' => 'The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
This value is currently "read replication."
', 'DBInstanceStatusInfo$Status' => 'The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
', 'DBInstanceStatusInfo$Message' => 'Details of the error if there is an error for the instance. If the instance isn\'t in an error state, this value is blank.
', 'DBParameterGroup$DBParameterGroupName' => 'The name of the DB parameter group.
', 'DBParameterGroup$DBParameterGroupFamily' => 'The name of the DB parameter group family that this DB parameter group is compatible with.
', 'DBParameterGroup$Description' => 'Provides the customer-specified description for this DB parameter group.
', 'DBParameterGroup$DBParameterGroupArn' => 'The Amazon Resource Name (ARN) for the DB parameter group.
', 'DBParameterGroupDetails$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group.
', 'DBParameterGroupStatus$DBParameterGroupName' => 'The name of the DB parameter group.
', 'DBParameterGroupStatus$ParameterApplyStatus' => 'The status of parameter updates.
', 'DBParameterGroupsMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'DBProxy$DBProxyArn' => 'The Amazon Resource Name (ARN) for the proxy.
', 'DBProxy$EngineFamily' => 'The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.
Provides the VPC ID of the DB proxy.
', 'DBProxy$RoleArn' => 'The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
', 'DBProxy$Endpoint' => 'The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
', 'DBProxyEndpoint$DBProxyEndpointName' => 'The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
', 'DBProxyEndpoint$DBProxyEndpointArn' => 'The Amazon Resource Name (ARN) for the DB proxy endpoint.
', 'DBProxyEndpoint$DBProxyName' => 'The identifier for the DB proxy that is associated with this DB proxy endpoint.
', 'DBProxyEndpoint$VpcId' => 'Provides the VPC ID of the DB proxy endpoint.
', 'DBProxyEndpoint$Endpoint' => 'The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
', 'DBProxyTarget$TargetArn' => 'The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
', 'DBProxyTarget$Endpoint' => 'The writer endpoint for the RDS DB instance or Aurora DB cluster.
', 'DBProxyTarget$TrackedClusterId' => 'The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
', 'DBProxyTarget$RdsResourceId' => 'The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
', 'DBProxyTargetGroup$DBProxyName' => 'The identifier for the RDS proxy associated with this target group.
', 'DBProxyTargetGroup$TargetGroupName' => 'The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'DBProxyTargetGroup$TargetGroupArn' => 'The Amazon Resource Name (ARN) representing the target group.
', 'DBProxyTargetGroup$Status' => 'The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.
The unique identifier of the recommendation.
', 'DBRecommendation$TypeId' => 'A value that indicates the type of recommendation. This value determines how the description is rendered.
', 'DBRecommendation$Severity' => 'The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation.
Valid values:
high
medium
low
informational
The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.
', 'DBRecommendation$Status' => 'The current status of the recommendation.
Valid values:
active - The recommendations which are ready for you to apply.
pending - The applied or scheduled recommendations which are in progress.
resolved - The recommendations which are completed.
dismissed - The recommendations that you dismissed.
A short description of the issue identified for this recommendation. The description might contain markdown.
', 'DBRecommendation$Recommendation' => 'A short description of the recommendation to resolve an issue. The description might contain markdown.
', 'DBRecommendation$Description' => 'A detailed description of the recommendation. The description might contain markdown.
', 'DBRecommendation$Reason' => 'The reason why this recommendation was created. The information might contain markdown.
', 'DBRecommendation$Category' => 'The category of the recommendation.
Valid values:
performance efficiency
security
reliability
cost optimization
operational excellence
sustainability
The Amazon Web Services service that generated the recommendations.
', 'DBRecommendation$TypeDetection' => 'A short description of the recommendation type. The description might contain markdown.
', 'DBRecommendation$TypeRecommendation' => 'A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.
', 'DBRecommendation$Impact' => 'A short description that explains the possible impact of an issue.
', 'DBRecommendation$AdditionalInfo' => 'Additional information about the recommendation. The information might contain markdown.
', 'DBRecommendationsMessage$Marker' => 'An optional pagination token provided by a previous DBRecommendationsMessage request. This token can be used later in a DescribeDBRecomendations request.
Provides the Amazon Web Services ID of the owner of a specific DB security group.
', 'DBSecurityGroup$DBSecurityGroupName' => 'Specifies the name of the DB security group.
', 'DBSecurityGroup$DBSecurityGroupDescription' => 'Provides the description of the DB security group.
', 'DBSecurityGroup$VpcId' => 'Provides the VpcId of the DB security group.
', 'DBSecurityGroup$DBSecurityGroupArn' => 'The Amazon Resource Name (ARN) for the DB security group.
', 'DBSecurityGroupMembership$DBSecurityGroupName' => 'The name of the DB security group.
', 'DBSecurityGroupMembership$Status' => 'The status of the DB security group.
', 'DBSecurityGroupMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
', 'DBShardGroup$DBClusterIdentifier' => 'The name of the primary DB cluster for the DB shard group.
', 'DBShardGroup$Status' => 'The status of the DB shard group.
', 'DBShardGroup$Endpoint' => 'The connection endpoint for the DB shard group.
', 'DBSnapshot$DBSnapshotIdentifier' => 'Specifies the identifier for the DB snapshot.
', 'DBSnapshot$DBInstanceIdentifier' => 'Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
', 'DBSnapshot$Engine' => 'Specifies the name of the database engine.
', 'DBSnapshot$Status' => 'Specifies the status of this DB snapshot.
', 'DBSnapshot$AvailabilityZone' => 'Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
', 'DBSnapshot$VpcId' => 'Provides the VPC ID associated with the DB snapshot.
', 'DBSnapshot$MasterUsername' => 'Provides the master username for the DB snapshot.
', 'DBSnapshot$EngineVersion' => 'Specifies the version of the database engine.
', 'DBSnapshot$LicenseModel' => 'License model information for the restored DB instance.
', 'DBSnapshot$SnapshotType' => 'Provides the type of the DB snapshot.
', 'DBSnapshot$OptionGroupName' => 'Provides the option group name for the DB snapshot.
', 'DBSnapshot$SourceRegion' => 'The Amazon Web Services Region that the DB snapshot was created in or copied from.
', 'DBSnapshot$SourceDBSnapshotIdentifier' => 'The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
', 'DBSnapshot$StorageType' => 'Specifies the storage type associated with DB snapshot.
', 'DBSnapshot$TdeCredentialArn' => 'The ARN from the key store with which to associate the instance for TDE encryption.
', 'DBSnapshot$KmsKeyId' => 'If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBSnapshot$DBSnapshotArn' => 'The Amazon Resource Name (ARN) for the DB snapshot.
', 'DBSnapshot$Timezone' => 'The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
The identifier for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBSnapshot$SnapshotTarget' => 'Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
', 'DBSnapshot$DBSystemId' => 'The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
', 'DBSnapshotAttribute$AttributeName' => 'The name of the manual DB snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
The identifier of the manual DB snapshot that the attributes apply to.
', 'DBSnapshotMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the snapshot of the DB instance.
', 'DBSnapshotTenantDatabase$DBInstanceIdentifier' => 'The ID for the DB instance that contains the tenant databases.
', 'DBSnapshotTenantDatabase$DbiResourceId' => 'The resource identifier of the source CDB instance. This identifier can\'t be changed and is unique to an Amazon Web Services Region.
', 'DBSnapshotTenantDatabase$EngineName' => 'The name of the database engine.
', 'DBSnapshotTenantDatabase$SnapshotType' => 'The type of DB snapshot.
', 'DBSnapshotTenantDatabase$TenantDBName' => 'The name of the tenant database.
', 'DBSnapshotTenantDatabase$MasterUsername' => 'The master username of the tenant database.
', 'DBSnapshotTenantDatabase$TenantDatabaseResourceId' => 'The resource ID of the tenant database.
', 'DBSnapshotTenantDatabase$CharacterSetName' => 'The name of the character set of a tenant database.
', 'DBSnapshotTenantDatabase$DBSnapshotTenantDatabaseARN' => 'The Amazon Resource Name (ARN) for the snapshot tenant database.
', 'DBSnapshotTenantDatabase$NcharCharacterSetName' => 'The NCHAR character set name of the tenant database.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB subnet group.
', 'DBSubnetGroup$DBSubnetGroupDescription' => 'Provides the description of the DB subnet group.
', 'DBSubnetGroup$VpcId' => 'Provides the VpcId of the DB subnet group.
', 'DBSubnetGroup$SubnetGroupStatus' => 'Provides the status of the DB subnet group.
', 'DBSubnetGroup$DBSubnetGroupArn' => 'The Amazon Resource Name (ARN) for the DB subnet group.
', 'DBSubnetGroupMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the source DB cluster, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DeleteDBClusterEndpointMessage$DBClusterEndpointIdentifier' => 'The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
', 'DeleteDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier for the DB cluster to be deleted. This parameter isn\'t case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.
Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You can\'t delete a default DB cluster parameter group.
Can\'t be associated with any DB clusters.
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
The identifier for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DeleteDBInstanceAutomatedBackupMessage$DBInstanceAutomatedBackupsArn' => 'The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn\'t apply to RDS Custom.
', 'DeleteDBInstanceMessage$DBInstanceIdentifier' => 'The DB instance identifier for the DB instance to be deleted. This parameter isn\'t case-sensitive.
Constraints:
Must match the name of an existing DB instance.
The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn\'t apply to RDS Custom.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Can\'t be specified when deleting a read replica.
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You can\'t delete a default DB parameter group
Can\'t be associated with any DB instances
The name of the DB proxy to delete.
', 'DeleteDBSecurityGroupMessage$DBSecurityGroupName' => 'The name of the DB security group to delete.
You can\'t delete the default DB security group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Must not be "Default"
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
The name of the database subnet group to delete.
You can\'t delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The name of the RDS event notification subscription you want to delete.
', 'DeleteGlobalClusterMessage$GlobalClusterIdentifier' => 'The cluster identifier of the global database cluster being deleted.
', 'DeleteOptionGroupMessage$OptionGroupName' => 'The name of the option group to be deleted.
You can\'t delete default option groups.
The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.
', 'DeleteTenantDatabaseMessage$TenantDBName' => 'The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive.
', 'DeleteTenantDatabaseMessage$FinalDBSnapshotIdentifier' => 'The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
The identifier of the DBProxyTargetGroup.
An optional pagination token provided by a previous DescribeBlueGreenDeployments request. If you specify this parameter, the response only includes records beyond the marker, up to the value specified by MaxRecords.
A pagination token that can be used in a later DescribeBlueGreenDeployments request.
The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn\'t case-sensitive.
Constraints:
Must match an existing CertificateIdentifier.
An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The resource ID of the DB cluster that is the source of the automated backup. This parameter isn\'t case-sensitive.
', 'DescribeDBClusterAutomatedBackupsMessage$DBClusterIdentifier' => '(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster\'s automated backup. This parameter isn\'t case-sensitive.
', 'DescribeDBClusterAutomatedBackupsMessage$Marker' => 'The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
If specified, this value is the backtrack identifier of the backtrack to be described.
Constraints:
Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see Universally unique identifier.
Example: 123e4567-e89b-12d3-a456-426655440000
An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
', 'DescribeDBClusterEndpointsMessage$DBClusterEndpointIdentifier' => 'The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
', 'DescribeDBClusterEndpointsMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A specific source to return parameters for.
Valid Values:
customer
engine
service
An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the DB cluster snapshot to describe the attributes for.
', 'DescribeDBClusterSnapshotsMessage$DBClusterIdentifier' => 'The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can\'t be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
A specific DB cluster snapshot identifier to describe. This parameter can\'t be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
public - Return all DB cluster snapshots that have been marked as public.
If you don\'t specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A specific DB cluster resource ID to describe.
', 'DescribeDBClustersMessage$DBClusterIdentifier' => 'The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match an existing DB cluster identifier.
An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The database engine to return version details for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
A specific database engine version to return details for.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DB parameter group family.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The resource ID of the DB instance that is the source of the automated backup. This parameter isn\'t case-sensitive.
', 'DescribeDBInstanceAutomatedBackupsMessage$DBInstanceIdentifier' => '(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance\'s automated backup. This parameter isn\'t case-sensitive.
', 'DescribeDBInstanceAutomatedBackupsMessage$Marker' => 'The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn\'t apply to RDS Custom.
', 'DescribeDBInstancesMessage$DBInstanceIdentifier' => 'The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DB instance.
An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the log file for the specified DB instance.
', 'DescribeDBLogFilesMessage$DBInstanceIdentifier' => 'The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Must match the identifier of an existing DBInstance.
Filters the available log files for log file names that contain the specified string.
', 'DescribeDBLogFilesMessage$Marker' => 'The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
', 'DescribeDBLogFilesResponse$Marker' => 'A pagination token that can be used in a later DescribeDBLogFiles request.
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
', 'DescribeDBProxiesRequest$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier of the DBProxy associated with the target group.
The identifier of the DBProxyTargetGroup to describe.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier of the DBProxyTarget to describe.
The identifier of the DBProxyTargetGroup to describe.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The language that you choose to return the list of recommendations.
Valid values:
en
en_UK
de
es
fr
id
it
ja
ko
pt_BR
zh_TW
zh_CN
An optional pagination token provided by a previous DescribeDBRecommendations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB security group to return details for.
', 'DescribeDBSecurityGroupsMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous DescribeDBShardGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A pagination token that can be used in a later DescribeDBClusters request.
The identifier for the DB snapshot to describe the attributes for.
', 'DescribeDBSnapshotTenantDatabasesMessage$DBInstanceIdentifier' => 'The ID of the DB instance used to create the DB snapshots. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.
Constraints:
If you specify this parameter, the value must match the ID of an existing DB snapshot.
If you specify an automatic snapshot, you must also specify SnapshotType.
The type of DB snapshots to be returned. You can specify one of the following values:
automated – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual – All DB snapshots that have been taken by my Amazon Web Services account.
shared – All manual DB snapshots that have been shared to my Amazon Web Services account.
public – All DB snapshots that have been marked as public.
awsbackup – All DB snapshots managed by the Amazon Web Services Backup service.
An optional pagination token provided by a previous DescribeDBSnapshotTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A specific DB resource identifier to describe.
', 'DescribeDBSnapshotsMessage$DBInstanceIdentifier' => 'The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The awsbackup type does not apply to Aurora.
If you don\'t specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.
An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A specific DB resource ID to describe.
', 'DescribeDBSubnetGroupsMessage$DBSubnetGroupName' => 'The name of the DB subnet group to return details for.
', 'DescribeDBSubnetGroupsMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB cluster parameter group family to return engine parameter information for.
', 'DescribeEngineDefaultClusterParametersMessage$Marker' => 'An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group family.
Valid Values:
aurora-mysql5.7
aurora-mysql8.0
aurora-postgresql10
aurora-postgresql11
aurora-postgresql12
aurora-postgresql13
aurora-postgresql14
custom-oracle-ee-19
custom-oracle-ee-cdb-19
db2-ae
db2-se
mariadb10.2
mariadb10.3
mariadb10.4
mariadb10.5
mariadb10.6
mysql5.7
mysql8.0
oracle-ee-19
oracle-ee-cdb-19
oracle-ee-cdb-21
oracle-se2-19
oracle-se2-cdb-19
oracle-se2-cdb-21
postgres10
postgres11
postgres12
postgres13
postgres14
sqlserver-ee-11.0
sqlserver-ee-12.0
sqlserver-ee-13.0
sqlserver-ee-14.0
sqlserver-ee-15.0
sqlserver-ex-11.0
sqlserver-ex-12.0
sqlserver-ex-13.0
sqlserver-ex-14.0
sqlserver-ex-15.0
sqlserver-se-11.0
sqlserver-se-12.0
sqlserver-se-13.0
sqlserver-se-14.0
sqlserver-se-15.0
sqlserver-web-11.0
sqlserver-web-12.0
sqlserver-web-13.0
sqlserver-web-14.0
sqlserver-web-15.0
An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The name of the RDS event notification subscription you want to describe.
', 'DescribeEventSubscriptionsMessage$Marker' => 'An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
Can\'t end with a hyphen or contain two consecutive hyphens.
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier of the snapshot or cluster export task to be described.
', 'DescribeExportTasksMessage$SourceArn' => 'The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
', 'DescribeExportTasksMessage$Marker' => 'An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match an existing DBClusterIdentifier.
An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the engine to describe options for.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
If specified, filters the results to include only options for the specified major engine version.
', 'DescribeOptionGroupOptionsMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option group to describe. Can\'t be supplied together with EngineName or MajorEngineVersion.
', 'DescribeOptionGroupsMessage$Marker' => 'An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A filter to only include option groups associated with this database engine.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
', 'DescribeOrderableDBInstanceOptionsMessage$Engine' => 'The name of the database engine to describe DB instance options for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
A filter to include only the available options for the specified engine version.
', 'DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass' => 'A filter to include only the available options for the specified DB instance class.
', 'DescribeOrderableDBInstanceOptionsMessage$LicenseModel' => 'A filter to include only the available options for the specified license model.
RDS Custom supports only the BYOL licensing model.
', 'DescribeOrderableDBInstanceOptionsMessage$AvailabilityZoneGroup' => 'The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.
Omit this parameter to show the available options in the specified Amazon Web Services Region.
This setting doesn\'t apply to RDS Custom DB instances.
', 'DescribeOrderableDBInstanceOptionsMessage$Marker' => 'An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The ARN of a resource to return pending maintenance actions for.
', 'DescribePendingMaintenanceActionsMessage$Marker' => 'An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
', 'DescribeReservedDBInstancesMessage$ReservedDBInstancesOfferingId' => 'The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
', 'DescribeReservedDBInstancesMessage$DBInstanceClass' => 'The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
', 'DescribeReservedDBInstancesMessage$Duration' => 'The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
', 'DescribeReservedDBInstancesMessage$OfferingType' => 'The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
', 'DescribeReservedDBInstancesOfferingsMessage$Duration' => 'Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
The results show offerings that partially match the filter value.
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The source Amazon Web Services Region name. For example, us-east-1.
Constraints:
Must specify a valid Amazon Web Services Region name.
An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn\'t case-sensitive.
', 'DescribeTenantDatabasesMessage$TenantDBName' => 'The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.
', 'DescribeTenantDatabasesMessage$Marker' => 'An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The customer identifier or the ARN of your DB instance.
', 'DisableHttpEndpointRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the DB cluster.
', 'DisableHttpEndpointResponse$ResourceArn' => 'The ARN of the DB cluster.
', 'DocLink$Text' => 'The text with the link to documentation for the recommendation.
', 'DocLink$Url' => 'The URL for the documentation for the recommendation.
', 'DomainMembership$Domain' => 'The identifier of the Active Directory Domain.
', 'DomainMembership$Status' => 'The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
The fully qualified domain name (FQDN) of the Active Directory Domain.
', 'DomainMembership$IAMRoleName' => 'The name of the IAM role used when making API calls to the Directory Service.
', 'DomainMembership$OU' => 'The Active Directory organizational unit for the DB instance or cluster.
', 'DomainMembership$AuthSecretArn' => 'The ARN for the Secrets Manager secret with the credentials for the user that\'s a member of the domain.
', 'DownloadDBLogFilePortionDetails$LogFileData' => 'Entries from the specified log file.
', 'DownloadDBLogFilePortionDetails$Marker' => 'A pagination token that can be used in a later DownloadDBLogFilePortion request.
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Must match the identifier of an existing DBInstance.
The name of the log file to be downloaded.
', 'DownloadDBLogFilePortionMessage$Marker' => 'The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
', 'EC2SecurityGroup$Status' => 'Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
', 'EC2SecurityGroup$EC2SecurityGroupName' => 'Specifies the name of the EC2 security group.
', 'EC2SecurityGroup$EC2SecurityGroupId' => 'Specifies the id of the EC2 security group.
', 'EC2SecurityGroup$EC2SecurityGroupOwnerId' => 'Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
The Amazon Resource Name (ARN) of the DB cluster.
', 'EnableHttpEndpointResponse$ResourceArn' => 'The ARN of the DB cluster.
', 'EncryptionContextMap$key' => NULL, 'EncryptionContextMap$value' => NULL, 'Endpoint$Address' => 'Specifies the DNS address of the DB instance.
', 'Endpoint$HostedZoneId' => 'Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
', 'EngineDefaults$DBParameterGroupFamily' => 'Specifies the name of the DB parameter group family that the engine default parameters apply to.
', 'EngineDefaults$Marker' => 'An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Provides the identifier for the source of the event.
', 'Event$Message' => 'Provides the text of this event.
', 'Event$SourceArn' => 'The Amazon Resource Name (ARN) for the event.
', 'EventCategoriesList$member' => NULL, 'EventCategoriesMap$SourceType' => 'The source type that the returned categories belong to
', 'EventSubscription$CustomerAwsId' => 'The Amazon Web Services customer account associated with the RDS event notification subscription.
', 'EventSubscription$CustSubscriptionId' => 'The RDS event notification subscription Id.
', 'EventSubscription$SnsTopicArn' => 'The topic ARN of the RDS event notification subscription.
', 'EventSubscription$Status' => 'The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
', 'EventSubscription$SubscriptionCreationTime' => 'The time the RDS event notification subscription was created.
', 'EventSubscription$SourceType' => 'The source type for the RDS event notification subscription.
', 'EventSubscription$EventSubscriptionArn' => 'The Amazon Resource Name (ARN) for the event subscription.
', 'EventSubscriptionsMessage$Marker' => 'An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A unique identifier for the snapshot or cluster export task. This ID isn\'t an identifier for the Amazon S3 bucket where the data is exported.
', 'ExportTask$SourceArn' => 'The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
', 'ExportTask$S3Bucket' => 'The Amazon S3 bucket where the snapshot or cluster is exported to.
', 'ExportTask$S3Prefix' => 'The Amazon S3 bucket prefix that is the file name and path of the exported data.
', 'ExportTask$IamRoleArn' => 'The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
', 'ExportTask$KmsKeyId' => 'The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it\'s exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
', 'ExportTask$Status' => 'The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
The reason the export failed, if it failed.
', 'ExportTask$WarningMessage' => 'A warning about the snapshot or cluster export task.
', 'ExportTasksMessage$Marker' => 'A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.
The identifier of the DB cluster to force a failover for. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.
This setting isn\'t supported for RDS for MySQL Multi-AZ DB clusters.
', 'FailoverState$FromDbClusterArn' => 'The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
', 'FailoverState$ToDbClusterArn' => 'The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
', 'FeatureNameList$member' => NULL, 'Filter$Name' => 'The name of the filter. Filter names are case-sensitive.
', 'FilterValueList$member' => NULL, 'GlobalCluster$GlobalClusterIdentifier' => 'Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
', 'GlobalCluster$GlobalClusterResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
', 'GlobalCluster$GlobalClusterArn' => 'The Amazon Resource Name (ARN) for the global database cluster.
', 'GlobalCluster$Status' => 'Specifies the current state of this global database cluster.
', 'GlobalCluster$Engine' => 'The Aurora database engine used by the global database cluster.
', 'GlobalCluster$EngineVersion' => 'Indicates the database engine version.
', 'GlobalCluster$DatabaseName' => 'The default database name within the new global database cluster.
', 'GlobalClusterMember$DBClusterArn' => 'The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
', 'GlobalClustersMessage$Marker' => 'An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
', 'IPRange$CIDRIP' => 'The IP range.
', 'Integration$KMSKeyId' => 'The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
', 'IntegrationError$ErrorCode' => 'The error code associated with the integration.
', 'IntegrationError$ErrorMessage' => 'A message explaining the error.
', 'KeyList$member' => NULL, 'ListTagsForResourceMessage$ResourceName' => 'The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
', 'LogTypeList$member' => NULL, 'MasterUserSecret$SecretArn' => 'The Amazon Resource Name (ARN) of the secret.
', 'MasterUserSecret$SecretStatus' => 'The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can\'t be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.
When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
', 'Metric$Name' => 'The name of a metric.
', 'Metric$StatisticsDetails' => 'The details of different statistics for a metric. The description might contain markdown.
', 'MetricReference$Name' => 'The name of the metric reference.
', 'MinimumEngineVersionPerAllowedValue$AllowedValue' => 'The allowed value for an option setting.
', 'MinimumEngineVersionPerAllowedValue$MinimumEngineVersion' => 'The minimum DB engine version required for the allowed value.
', 'ModifyActivityStreamRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example, arn:aws:rds:us-east-1:12345667890:db:my-orcl-db.
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
', 'ModifyActivityStreamResponse$KinesisStreamName' => 'The name of the Amazon Kinesis data stream to be used for the database activity stream.
', 'ModifyCertificatesMessage$CertificateIdentifier' => 'The new default certificate identifier to override the current one with.
To determine the valid values, use the describe-certificates CLI command or the DescribeCertificates API operation.
The DB cluster identifier for the cluster being modified. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn\'t found in the timeout period.
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
', 'ModifyDBClusterEndpointMessage$EndpointType' => 'The type of the endpoint. One of: READER, WRITER, ANY.
The DB cluster identifier for the cluster being modified. This parameter isn\'t case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$MasterUserPassword' => 'The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can\'t be specified if ManageMasterUserPassword is turned on.
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can\'t be modified.
', 'ModifyDBClusterMessage$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
If the cluster that you\'re modifying has one or more read replicas, all replicas must be running an engine version that\'s the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$DBInstanceParameterGroupName' => 'The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn\'t rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$DBClusterInstanceClass' => 'The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$StorageType' => 'The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don\'t specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$NetworkType' => 'The network type of the DB cluster.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn\'t manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can\'t change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$EngineMode' => 'The DB engine mode of the DB cluster, either provisioned or serverless.
The DB engine mode can be modified only from serverless to provisioned.
For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB cluster\'s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
', 'ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName' => 'The name of the DB cluster parameter group to modify.
', 'ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier' => 'The identifier for the DB cluster snapshot to modify the attributes for.
', 'ModifyDBClusterSnapshotAttributeMessage$AttributeName' => 'The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.
The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify ApplyImmediately in your request.
Default: Uses existing setting
Constraints:
If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn\'t in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
Example: mydbsubnetgroup
The new password for the master user.
Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Amazon RDS API operations never return the password, so this operation provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.)
RDS Custom
Default: Uses existing setting
Constraints:
Can\'t be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can\'t include the "&" (ampersand) or the "\'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn\'t result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn\'t rebooted automatically, and the parameter changes aren\'t applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn\'t apply to RDS Custom DB instances.
Default: Uses existing setting
Constraints:
Must be in the same DB parameter group family as the DB instance.
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
This setting doesn\'t apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, which might result in an outage. Changing this parameter doesn\'t result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter causes a reboot of the DB instance. If you change this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
If the instance that you\'re modifying is acting as a read replica, the engine version that you specify must be the same or higher than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.
Constraints:
If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
The license model for the DB instance.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
The option group to associate the DB instance with.
Changing this parameter doesn\'t result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren\'t interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance after it is associated with a DB instance.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$NewDBInstanceIdentifier' => 'The new identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable ApplyImmediately. This value is stored as a lowercase string.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The storage type to associate with the DB instance.
If you specify io1, io2, or gp3 you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$TdeCredentialPassword' => 'The password for the given ARN from the key store in order to access the device.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'ModifyDBInstanceMessage$Domain' => 'The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$DomainFqdn' => 'The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don\'t specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values: IPV4 | DUAL
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn\'t manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can\'t change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
', 'ModifyDBInstanceMessage$Engine' => 'The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can\'t convert a CDB to a non-CDB.
You can\'t convert a replica database.
You can\'t convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can\'t convert the existing custom parameter or option group when it has options or parameters that are permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To avoid reverting to the default, specify a new parameter group with --db-parameter-group-name and a new option group with --option-group-name.
The name of the DB parameter group.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
The identifier for the DBProxy to modify.
The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
', 'ModifyDBProxyTargetGroupRequest$TargetGroupName' => 'The name of the target group to modify.
', 'ModifyDBProxyTargetGroupRequest$DBProxyName' => 'The name of the proxy.
', 'ModifyDBProxyTargetGroupRequest$NewName' => 'The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
The identifier of the recommendation to update.
', 'ModifyDBRecommendationMessage$Locale' => 'The language of the modified recommendation.
', 'ModifyDBRecommendationMessage$Status' => 'The recommendation status to update.
Valid values:
active
dismissed
The identifier for the DB snapshot to modify the attributes for.
', 'ModifyDBSnapshotAttributeMessage$AttributeName' => 'The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
The identifier of the DB snapshot to modify.
', 'ModifyDBSnapshotMessage$EngineVersion' => 'The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.
Oracle
19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots)
19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots)
12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.
', 'ModifyDBSnapshotMessage$OptionGroupName' => 'The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.
', 'ModifyDBSubnetGroupMessage$DBSubnetGroupName' => 'The name for the DB subnet group. This value is stored as a lowercase string. You can\'t modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The description for the DB subnet group.
', 'ModifyEventSubscriptionMessage$SubscriptionName' => 'The name of the RDS event notification subscription.
', 'ModifyEventSubscriptionMessage$SnsTopicArn' => 'The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
', 'ModifyEventSubscriptionMessage$SourceType' => 'The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn\'t specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The cluster identifier for the global cluster to modify. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster.
The new cluster identifier for the global database cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
The version number of the database engine to which you want to upgrade.
To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query \'*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]\'
To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query \'*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]\'
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance
', 'ModifyTenantDatabaseMessage$DBInstanceIdentifier' => 'The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DB instance.
The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.
Constraints:
Must match the identifier of an existing tenant database.
The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.
Constraints:
Can\'t be the string null or any other reserved word.
Can\'t be longer than 8 characters.
The name of the option.
', 'Option$OptionDescription' => 'The description of the option.
', 'Option$OptionVersion' => 'The version of the option.
', 'OptionConfiguration$OptionName' => 'The configuration of options to include in a group.
', 'OptionConfiguration$OptionVersion' => 'The version for the option.
', 'OptionGroup$OptionGroupName' => 'Specifies the name of the option group.
', 'OptionGroup$OptionGroupDescription' => 'Provides a description of the option group.
', 'OptionGroup$EngineName' => 'Indicates the name of the engine that this option group can be applied to.
', 'OptionGroup$MajorEngineVersion' => 'Indicates the major engine version associated with this option group.
', 'OptionGroup$VpcId' => 'If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
Specifies the Amazon Resource Name (ARN) for the option group.
', 'OptionGroup$SourceOptionGroup' => 'Specifies the name of the option group from which this option group is copied.
', 'OptionGroup$SourceAccountId' => 'Specifies the Amazon Web Services account ID for the option group from which this option group is copied.
', 'OptionGroupMembership$OptionGroupName' => 'The name of the option group that the instance belongs to.
', 'OptionGroupMembership$Status' => 'The status of the DB instance\'s option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.
The name of the option.
', 'OptionGroupOption$Description' => 'The description of the option.
', 'OptionGroupOption$EngineName' => 'The name of the engine that this option can be applied to.
', 'OptionGroupOption$MajorEngineVersion' => 'Indicates the major engine version that the option is available for.
', 'OptionGroupOption$MinimumRequiredMinorEngineVersion' => 'The minimum required engine version for the option to be applied.
', 'OptionGroupOptionSetting$SettingName' => 'The name of the option group option.
', 'OptionGroupOptionSetting$SettingDescription' => 'The description of the option group option.
', 'OptionGroupOptionSetting$DefaultValue' => 'The default value for the option group option.
', 'OptionGroupOptionSetting$ApplyType' => 'The DB engine specific parameter type for the option group option.
', 'OptionGroupOptionSetting$AllowedValues' => 'Indicates the acceptable values for the option group option.
', 'OptionGroupOptionsMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option that has settings that you can set.
', 'OptionSetting$Value' => 'The current value of the option setting.
', 'OptionSetting$DefaultValue' => 'The default value of the option setting.
', 'OptionSetting$Description' => 'The description of the option setting.
', 'OptionSetting$ApplyType' => 'The DB engine specific parameter type.
', 'OptionSetting$DataType' => 'The data type of the option setting.
', 'OptionSetting$AllowedValues' => 'The allowed values of the option setting.
', 'OptionVersion$Version' => 'The version of the option.
', 'OptionsConflictsWith$member' => NULL, 'OptionsDependedOn$member' => NULL, 'OrderableDBInstanceOption$Engine' => 'The engine type of a DB instance.
', 'OrderableDBInstanceOption$EngineVersion' => 'The engine version of a DB instance.
', 'OrderableDBInstanceOption$DBInstanceClass' => 'The DB instance class for a DB instance.
', 'OrderableDBInstanceOption$LicenseModel' => 'The license model for a DB instance.
', 'OrderableDBInstanceOption$AvailabilityZoneGroup' => 'The Availability Zone group for a DB instance.
', 'OrderableDBInstanceOption$StorageType' => 'The storage type for a DB instance.
', 'OrderableDBInstanceOptionsMessage$Marker' => 'An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the Outpost.
', 'Parameter$ParameterName' => 'The name of the parameter.
', 'Parameter$ParameterValue' => 'The value of the parameter.
', 'Parameter$Description' => 'Provides a description of the parameter.
', 'Parameter$Source' => 'The source of the parameter value.
', 'Parameter$ApplyType' => 'Specifies the engine specific parameters type.
', 'Parameter$DataType' => 'Specifies the valid data type for the parameter.
', 'Parameter$AllowedValues' => 'Specifies the valid range of values for the parameter.
', 'Parameter$MinimumEngineVersion' => 'The earliest engine version to which the parameter can apply.
', 'PendingMaintenanceAction$Action' => 'The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.
Indicates the type of opt-in request that has been received for the resource.
', 'PendingMaintenanceAction$Description' => 'A description providing more detail about the maintenance action.
', 'PendingMaintenanceActionsMessage$Marker' => 'An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
The name of the compute and memory capacity class for the DB instance.
', 'PendingModifiedValues$MasterUserPassword' => 'The master credentials for the DB instance.
', 'PendingModifiedValues$EngineVersion' => 'The database engine version.
', 'PendingModifiedValues$LicenseModel' => 'The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
The database identifier for the DB instance.
', 'PendingModifiedValues$StorageType' => 'The storage type of the DB instance.
', 'PendingModifiedValues$CACertificateIdentifier' => 'The identifier of the CA certificate for the DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'PendingModifiedValues$DBSubnetGroupName' => 'The DB subnet group for the DB instance.
', 'PendingModifiedValues$Engine' => 'The database engine of the DB instance.
', 'PerformanceInsightsMetricDimensionGroup$Group' => 'The available dimension groups for Performance Insights metric type.
', 'PerformanceInsightsMetricQuery$Metric' => 'The name of a Performance Insights metric to be measured.
Valid Values:
db.load.avg - A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg - The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
The analysis of the performance issue. The information might contain markdown.
', 'ProcessorFeature$Name' => 'The name of the processor feature. Valid names are coreCount and threadsPerCore.
The value of a processor feature name.
', 'PromoteReadReplicaDBClusterMessage$DBClusterIdentifier' => 'The identifier of the DB cluster read replica to promote. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster read replica.
Example: my-cluster-replica1
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing read replica DB instance.
Example: mydbinstance
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
', 'PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId' => 'Customer-specified identifier to track this reservation.
Example: myreservationID
', 'RdsCustomClusterConfiguration$InterconnectSubnetId' => 'Reserved for future use.
', 'RdsCustomClusterConfiguration$TransitGatewayMulticastDomainId' => 'Reserved for future use.
', 'ReadReplicaDBClusterIdentifierList$member' => NULL, 'ReadReplicaDBInstanceIdentifierList$member' => NULL, 'ReadReplicaIdentifierList$member' => NULL, 'ReadersArnList$member' => NULL, 'RebootDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBCluster.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
The unique identifier of the recommended action.
', 'RecommendedAction$Title' => 'A short description to summarize the action. The description might contain markdown.
', 'RecommendedAction$Description' => 'A detailed description of the action. The description might contain markdown.
', 'RecommendedAction$Operation' => 'An API operation for the action.
', 'RecommendedAction$Status' => 'The status of the action.
ready
applied
scheduled
resolved
The key of the parameter to use with the RecommendedAction API operation.
The value of the parameter to use with the RecommendedAction API operation.
A unique identifier of the updated recommendation action.
', 'RecommendedActionUpdate$Status' => 'The status of the updated recommendation action.
applied
scheduled
The frequency of the recurring charge.
', 'RegisterDBProxyTargetsRequest$DBProxyName' => 'The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
The identifier of the DBProxyTargetGroup.
The cluster identifier to detach from the Aurora global database cluster.
', 'RemoveFromGlobalClusterMessage$DbClusterIdentifier' => 'The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.
', 'RemoveRoleFromDBClusterMessage$DBClusterIdentifier' => 'The name of the DB cluster to disassociate the IAM role from.
', 'RemoveRoleFromDBClusterMessage$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
', 'RemoveRoleFromDBInstanceMessage$DBInstanceIdentifier' => 'The name of the DB instance to disassociate the IAM role from.
', 'RemoveRoleFromDBInstanceMessage$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example, arn:aws:iam::123456789012:role/AccessRole.
The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
The name of the RDS event notification subscription you want to remove a source identifier from.
', 'RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier' => 'The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
', 'RemoveTagsFromResourceMessage$ResourceName' => 'The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
', 'ReservedDBInstance$ReservedDBInstanceId' => 'The unique identifier for the reservation.
', 'ReservedDBInstance$ReservedDBInstancesOfferingId' => 'The offering identifier.
', 'ReservedDBInstance$DBInstanceClass' => 'The DB instance class for the reserved DB instance.
', 'ReservedDBInstance$CurrencyCode' => 'The currency code for the reserved DB instance.
', 'ReservedDBInstance$ProductDescription' => 'The description of the reserved DB instance.
', 'ReservedDBInstance$OfferingType' => 'The offering type of this reserved DB instance.
', 'ReservedDBInstance$State' => 'The state of the reserved DB instance.
', 'ReservedDBInstance$ReservedDBInstanceArn' => 'The Amazon Resource Name (ARN) for the reserved DB instance.
', 'ReservedDBInstance$LeaseId' => 'The unique identifier for the lease associated with the reserved DB instance.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The offering identifier.
', 'ReservedDBInstancesOffering$DBInstanceClass' => 'The DB instance class for the reserved DB instance.
', 'ReservedDBInstancesOffering$CurrencyCode' => 'The currency code for the reserved DB instance offering.
', 'ReservedDBInstancesOffering$ProductDescription' => 'The database engine used by the offering.
', 'ReservedDBInstancesOffering$OfferingType' => 'The offering type.
', 'ReservedDBInstancesOfferingMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB cluster parameter group to reset.
', 'ResetDBParameterGroupMessage$DBParameterGroupName' => 'The name of the DB parameter group.
Constraints:
Must match the name of an existing DBParameterGroup.
The ARN of the resource that has pending maintenance actions.
', 'RestoreDBClusterFromS3Message$CharacterSetName' => 'A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
', 'RestoreDBClusterFromS3Message$DatabaseName' => 'The database name for the restored DB cluster.
', 'RestoreDBClusterFromS3Message$DBClusterIdentifier' => 'The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn\'t case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The name of the database engine to be used for this DB cluster.
Valid Values: aurora-mysql (for Aurora MySQL)
The version number of the database engine to use.
To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints:
Must contain from 8 to 41 characters.
Can\'t be specified if ManageMasterUserPassword is turned on.
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can\'t be removed from an option group. An option group can\'t be removed from a DB cluster once it is associated with a DB cluster.
', 'RestoreDBClusterFromS3Message$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
', 'RestoreDBClusterFromS3Message$KmsKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid Values: mysql
The version of the database that the backup files were created from.
MySQL versions 5.7 and 8.0 are supported.
Example: 5.7.40, 8.0.28
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
', 'RestoreDBClusterFromS3Message$S3Prefix' => 'The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
', 'RestoreDBClusterFromS3Message$S3IngestionRoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
', 'RestoreDBClusterFromS3Message$Domain' => 'Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
', 'RestoreDBClusterFromS3Message$DomainIAMRoleName' => 'Specify the name of the IAM role to be used when making API calls to the Directory Service.
', 'RestoreDBClusterFromS3Message$NetworkType' => 'The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
', 'RestoreDBClusterFromS3Message$MasterUserSecretKmsKeyId' => 'The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
', 'RestoreDBClusterFromS3Message$StorageType' => 'Specifies the storage type to be associated with the DB cluster.
Valid Values: aurora, aurora-iopt1
Default: aurora
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$DBClusterIdentifier' => 'The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn\'t case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier' => 'The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$Engine' => 'The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$EngineVersion' => 'The version of the database engine to use for the new DB cluster. If you don\'t specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName' => 'The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$DatabaseName' => 'The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$OptionGroupName' => 'The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can\'t be modified.
', 'RestoreDBClusterFromSnapshotMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When you don\'t specify a value for the KmsKeyId parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn\'t encrypted, then the restored DB cluster isn\'t encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$EngineMode' => 'The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$DBClusterParameterGroupName' => 'The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$Domain' => 'The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$DomainIAMRoleName' => 'The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$DBClusterInstanceClass' => 'The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$StorageType' => 'Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$NetworkType' => 'The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$DBClusterIdentifier' => 'The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$RestoreType' => 'The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
If you don\'t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier' => 'The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$DBSubnetGroupName' => 'The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$OptionGroupName' => 'The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can\'t be modified.
', 'RestoreDBClusterToPointInTimeMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you don\'t specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn\'t encrypted, then the restored DB cluster isn\'t encrypted.
If DBClusterIdentifier refers to a DB cluster that isn\'t encrypted, then the restore request is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$DBClusterParameterGroupName' => 'The name of the custom DB cluster parameter group to associate with this DB cluster.
If the DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$Domain' => 'The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$DomainIAMRoleName' => 'The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$EngineMode' => 'The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$DBClusterInstanceClass' => 'The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$StorageType' => 'Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$NetworkType' => 'The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$SourceDbClusterResourceId' => 'The resource ID of the source DB cluster from which to restore.
', 'RestoreDBInstanceFromDBSnapshotMessage$DBInstanceIdentifier' => 'The name of the DB instance to create from the DB snapshot. This parameter isn\'t case-sensitive.
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DB snapshot.
Can\'t be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn\'t specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
', 'RestoreDBInstanceFromDBSnapshotMessage$AvailabilityZone' => 'The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The name of the DB subnet group to use for the new instance.
Constraints:
If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
License model information for the restored DB instance.
This setting doesn\'t apply to RDS Custom.
Default: Same as source.
Valid Values: license-included | bring-your-own-license | general-public-license
The name of the database for the restored DB instance.
This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn\'t apply to the other engines or to RDS Custom DB instances.
', 'RestoreDBInstanceFromDBSnapshotMessage$Engine' => 'The database engine to use for the new instance.
This setting doesn\'t apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance after it is associated with a DB instance.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$StorageType' => 'Specifies the storage type to be associated with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialPassword' => 'The password for the given ARN from the key store in order to access the device.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$Domain' => 'The Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$DomainFqdn' => 'The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
Can\'t be longer than 64 characters.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to RDS Custom DB instances.
', 'RestoreDBInstanceFromDBSnapshotMessage$DBParameterGroupName' => 'The name of the DB parameter group to associate with this DB instance.
If you don\'t specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.
This setting doesn\'t apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DB parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$BackupTarget' => 'Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromDBSnapshotMessage$NetworkType' => 'The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromDBSnapshotMessage$DBClusterSnapshotIdentifier' => 'The identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can\'t be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn\'t specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can\'t be the identifier of an Aurora DB cluster snapshot.
The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'RestoreDBInstanceFromS3Message$DBName' => 'The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn\'t supported on the db.t2.micro DB instance class.
', 'RestoreDBInstanceFromS3Message$Engine' => 'The name of the database engine to be used for this instance.
Valid Values: mysql
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The password for the master user.
Constraints:
Can\'t be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can\'t include the "&" (ampersand) or the "\'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can\'t be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
The license model for this DB instance. Use general-public-license.
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
', 'RestoreDBInstanceFromS3Message$StorageType' => 'Specifies the storage type to be associated with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The name of the engine of your source database.
Valid Values: mysql
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
The name of your Amazon S3 bucket that contains your database backup file.
', 'RestoreDBInstanceFromS3Message$S3Prefix' => 'The prefix of your Amazon S3 bucket.
', 'RestoreDBInstanceFromS3Message$S3IngestionRoleArn' => 'An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
', 'RestoreDBInstanceFromS3Message$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$MasterUserSecretKmsKeyId' => 'The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
', 'RestoreDBInstanceFromS3Message$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier' => 'The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
The name of the new DB instance to create.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DB instance class as the original DB instance.
', 'RestoreDBInstanceToPointInTimeMessage$AvailabilityZone' => 'The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraints:
You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints:
If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
The license model information for the restored DB instance.
This setting doesn\'t apply to RDS Custom.
Valid Values: license-included | bring-your-own-license | general-public-license
Default: Same as the source.
', 'RestoreDBInstanceToPointInTimeMessage$DBName' => 'The database name for the restored DB instance.
This parameter doesn\'t apply to the following DB instances:
RDS Custom
RDS for Db2
RDS for MariaDB
RDS for MySQL
The database engine to use for the new instance.
This setting doesn\'t apply to RDS Custom.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Default: The same as source
Constraints:
Must be compatible with the engine of the source.
The name of the option group to use for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance after it is associated with a DB instance
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$StorageType' => 'The storage type to associate with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
Constraints:
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$TdeCredentialPassword' => 'The password for the given ARN from the key store in order to access the device.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$Domain' => 'The Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn\'t apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to RDS Custom DB instances.
', 'RestoreDBInstanceToPointInTimeMessage$DomainFqdn' => 'The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
Can\'t be longer than 64 characters.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
This setting doesn\'t apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DB parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
The resource ID of the source DB instance from which to restore.
', 'RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceAutomatedBackupsArn' => 'The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$CustomIamInstanceProfile' => 'The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$BackupTarget' => 'The location for storing automated backups and manual snapshots for the restored DB instance.
Valid Values:
outposts (Amazon Web Services Outposts)
region (Amazon Web Services Region)
Default: region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values:
IPV4
DUAL
The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'RevokeDBSecurityGroupIngressMessage$DBSecurityGroupName' => 'The name of the DB security group to revoke ingress from.
', 'RevokeDBSecurityGroupIngressMessage$CIDRIP' => 'The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can\'t be provided.
The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn\'t an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn\'t found in the timeout period.
If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
', 'ScalingConfigurationInfo$TimeoutAction' => 'The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn\'t found in the timeout period.
The name of the source Amazon Web Services Region.
', 'SourceRegion$Endpoint' => 'The endpoint for the source Amazon Web Services Region endpoint.
', 'SourceRegion$Status' => 'The status of the source Amazon Web Services Region.
', 'SourceRegionMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'StartActivityStreamResponse$KmsKeyId' => 'The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
', 'StartActivityStreamResponse$KinesisStreamName' => 'The name of the Amazon Kinesis data stream to be used for the database activity stream.
', 'StartDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
', 'StartDBInstanceAutomatedBackupsReplicationMessage$SourceDBInstanceArn' => 'The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It\'s ignored in other Amazon Web Services Regions.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
The user-supplied instance identifier.
', 'StartExportTaskMessage$ExportTaskIdentifier' => 'A unique identifier for the export task. This ID isn\'t an identifier for the Amazon S3 bucket where the data is to be exported.
', 'StartExportTaskMessage$SourceArn' => 'The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
', 'StartExportTaskMessage$S3BucketName' => 'The name of the Amazon S3 bucket to export the snapshot or cluster data to.
', 'StartExportTaskMessage$IamRoleArn' => 'The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
s3:PutObject*
s3:GetObject*
s3:ListBucket
s3:DeleteObject*
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
arn:aws:s3:::your-s3-bucket
arn:aws:s3:::your-s3-bucket/*
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:Encrypt
kms:Decrypt
kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext
kms:ReEncryptFrom
kms:ReEncryptTo
kms:CreateGrant
kms:DescribeKey
kms:RetireGrant
The Amazon S3 bucket prefix to use as the file name and path of the exported data.
', 'StopActivityStreamRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'StopActivityStreamResponse$KinesisStreamName' => 'The name of the Amazon Kinesis data stream used for the database activity stream.
', 'StopDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
', 'StopDBInstanceAutomatedBackupsReplicationMessage$SourceDBInstanceArn' => 'The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automate backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
The user-supplied instance identifier.
', 'StopDBInstanceMessage$DBSnapshotIdentifier' => 'The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
', 'StringList$member' => NULL, 'Subnet$SubnetIdentifier' => 'The identifier of the subnet.
', 'Subnet$SubnetStatus' => 'The status of the subnet.
', 'SubnetIdentifierList$member' => NULL, 'SwitchoverReadReplicaMessage$DBInstanceIdentifier' => 'The DB instance identifier of the current standby database. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing Oracle read replica DB instance.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can\'t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can\'t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$").
A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.
The ID of the DB instance that contains the tenant database.
', 'TenantDatabase$TenantDBName' => 'The database name of the tenant database.
', 'TenantDatabase$Status' => 'The status of the tenant database.
', 'TenantDatabase$MasterUsername' => 'The master username of the tenant database.
', 'TenantDatabase$DbiResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the DB instance.
', 'TenantDatabase$TenantDatabaseResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the tenant database.
', 'TenantDatabase$TenantDatabaseARN' => 'The Amazon Resource Name (ARN) for the tenant database.
', 'TenantDatabase$CharacterSetName' => 'The character set of the tenant database.
', 'TenantDatabase$NcharCharacterSetName' => 'The NCHAR character set name of the tenant database.
The name of the tenant database.
', 'TenantDatabasesMessage$Marker' => 'An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the time zone.
', 'UpgradeTarget$Engine' => 'The name of the upgrade target database engine.
', 'UpgradeTarget$EngineVersion' => 'The version number of the upgrade target database engine.
', 'UpgradeTarget$Description' => 'The version of the database engine that a DB instance can be upgraded to.
', 'UserAuthConfig$Description' => 'A user-specified description about the authentication used by a proxy to log in as a specific database user.
', 'UserAuthConfig$UserName' => 'The name of the database user to which the proxy connects.
', 'UserAuthConfig$SecretArn' => 'The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
', 'UserAuthConfigInfo$Description' => 'A user-specified description about the authentication used by a proxy to log in as a specific database user.
', 'UserAuthConfigInfo$UserName' => 'The name of the database user to which the proxy connects.
', 'UserAuthConfigInfo$SecretArn' => 'The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
', 'ValidStorageOptions$StorageType' => 'The valid storage types for your DB instance. For example: gp2, gp3, io1, io2.
', 'VpcSecurityGroupIdList$member' => NULL, 'VpcSecurityGroupMembership$VpcSecurityGroupId' => 'The name of the VPC security group.
', 'VpcSecurityGroupMembership$Status' => 'The membership status of the VPC security group.
Currently, the only valid status is active.
The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn\'t specified, no prefix is assumed.
The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
', 'CreateCustomDBEngineVersionMessage$SourceCustomDbEngineVersionIdentifier' => 'The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can\'t specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.
Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.
Default: no session pinning filters
', 'ConnectionPoolConfigurationInfo$SessionPinningFilters' => 'Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
List of DB instance identifiers that are part of the custom endpoint group.
', 'CreateDBClusterEndpointMessage$ExcludedMembers' => 'List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.
', 'CreateDBInstanceMessage$DomainDnsIps' => 'The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
', 'CreateDBProxyEndpointRequest$VpcSecurityGroupIds' => 'The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
', 'CreateDBProxyRequest$VpcSubnetIds' => 'One or more VPC subnet IDs to associate with the new proxy.
', 'CreateDBProxyRequest$VpcSecurityGroupIds' => 'One or more VPC security group IDs to associate with the new proxy.
', 'DBCluster$CustomEndpoints' => 'The custom endpoints associated with the DB cluster.
', 'DBClusterEndpoint$StaticMembers' => 'List of DB instance identifiers that are part of the custom endpoint group.
', 'DBClusterEndpoint$ExcludedMembers' => 'List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
', 'DBProxy$VpcSecurityGroupIds' => 'Provides a list of VPC security groups that the proxy belongs to.
', 'DBProxy$VpcSubnetIds' => 'The EC2 subnet IDs for the proxy.
', 'DBProxyEndpoint$VpcSecurityGroupIds' => 'Provides a list of VPC security groups that the DB proxy endpoint belongs to.
', 'DBProxyEndpoint$VpcSubnetIds' => 'The EC2 subnet IDs for the DB proxy endpoint.
', 'DBSubnetGroup$SupportedNetworkTypes' => 'The network type of the DB subnet group.
Valid values:
IPV4
DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'DeregisterDBProxyTargetsRequest$DBInstanceIdentifiers' => 'One or more DB instance identifiers.
', 'DeregisterDBProxyTargetsRequest$DBClusterIdentifiers' => 'One or more DB cluster identifiers.
', 'DomainMembership$DnsIps' => 'The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
', 'ExportTask$ExportOnly' => 'The data exported from the snapshot or cluster.
Valid Values:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
List of DB instance identifiers that are part of the custom endpoint group.
', 'ModifyDBClusterEndpointMessage$ExcludedMembers' => 'List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
', 'ModifyDBInstanceMessage$DomainDnsIps' => 'The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.
', 'ModifyDBProxyRequest$SecurityGroups' => 'The new list of security groups for the DBProxy.
The network types supported by the DB instance (IPV4 or DUAL).
A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'PerformanceInsightsMetricDimensionGroup$Dimensions' => 'A list of specific dimensions from a dimension group. If this list isn\'t included, then all of the dimensions in the group were requested, or are present in the response.
', 'RecommendedAction$ApplyModes' => 'The methods to apply the recommended action.
Valid values:
manual - The action requires you to resolve the recommendation manually.
immediately - The action is applied immediately.
next-maintainance-window - The action is applied during the next scheduled maintainance.
One or more DB instance identifiers.
', 'RegisterDBProxyTargetsRequest$DBClusterIdentifiers' => 'One or more DB cluster identifiers.
', 'RestoreDBInstanceFromDBSnapshotMessage$DomainDnsIps' => 'The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The data to be exported from the snapshot or cluster. If this parameter isn\'t provided, all of the data is exported.
Valid Values:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
This data type is used as a response element for the DescribeDBSubnetGroups operation.
The DB subnet is already in use in the Availability Zone.
', 'refs' => [], ], 'SubnetIdentifierList' => [ 'base' => NULL, 'refs' => [ 'CreateDBSubnetGroupMessage$SubnetIds' => 'The EC2 Subnet IDs for the DB subnet group.
', 'ModifyDBSubnetGroupMessage$SubnetIds' => 'The EC2 subnet IDs for the DB subnet group.
', ], ], 'SubnetList' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroup$Subnets' => 'Contains a list of Subnet elements.
The supplied subscription name already exists.
', 'refs' => [], ], 'SubscriptionCategoryNotFoundFault' => [ 'base' => 'The supplied category does not exist.
', 'refs' => [], ], 'SubscriptionNotFoundFault' => [ 'base' => 'The subscription name does not exist.
', 'refs' => [], ], 'SupportedCharacterSetsList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedCharacterSets' => 'A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
Contains the details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'refs' => [ 'SwitchoverDetailList$member' => NULL, ], ], 'SwitchoverDetailList' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$SwitchoverDetails' => 'The details about each source and target resource in the blue/green deployment.
', ], ], 'SwitchoverDetailStatus' => [ 'base' => NULL, 'refs' => [ 'SwitchoverDetail$Status' => 'The switchover status of a resource in a blue/green deployment.
Values:
PROVISIONING - The resource is being prepared to switch over.
AVAILABLE - The resource is ready to switch over.
SWITCHOVER_IN_PROGRESS - The resource is being switched over.
SWITCHOVER_COMPLETED - The resource has been switched over.
SWITCHOVER_FAILED - The resource attempted to switch over but failed.
MISSING_SOURCE - The source resource has been deleted.
MISSING_TARGET - The target resource has been deleted.
The amount of time, in seconds, for the switchover to complete.
Default: 300
If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.
', ], ], 'TStamp' => [ 'base' => NULL, 'refs' => [ 'BacktrackDBClusterMessage$BacktrackTo' => 'The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.
If the specified time isn\'t a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.
Constraints:
Must contain a valid ISO 8601 timestamp.
Can\'t contain a timestamp set in the future.
Example: 2017-07-08T18:00Z
The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).
', 'BlueGreenDeployment$DeleteTime' => 'The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).
', 'Certificate$ValidFrom' => 'The starting date from which the certificate is valid.
', 'Certificate$ValidTill' => 'The final date that the certificate continues to be valid.
', 'Certificate$CustomerOverrideValidTill' => 'If there is an override for the default certificate identifier, when the override expires.
', 'CertificateDetails$ValidTill' => 'The expiration date of the DB instance’s server certificate.
', 'DBCluster$AutomaticRestartTime' => 'The time when a stopped DB cluster is restarted automatically.
', 'DBCluster$EarliestRestorableTime' => 'The earliest time to which a database can be restored with point-in-time restore.
', 'DBCluster$LatestRestorableTime' => 'The latest time to which a database can be restored with point-in-time restore.
', 'DBCluster$ClusterCreateTime' => 'The time when the DB cluster was created, in Universal Coordinated Time (UTC).
', 'DBCluster$EarliestBacktrackTime' => 'The earliest time to which a DB cluster can be backtracked.
', 'DBCluster$IOOptimizedNextAllowedModificationTime' => 'The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
This setting is only for Aurora DB clusters.
', 'DBClusterAutomatedBackup$ClusterCreateTime' => 'The time when the DB cluster was created, in Universal Coordinated Time (UTC).
', 'DBClusterBacktrack$BacktrackTo' => 'The timestamp of the time to which the DB cluster was backtracked.
', 'DBClusterBacktrack$BacktrackedFrom' => 'The timestamp of the time from which the DB cluster was backtracked.
', 'DBClusterBacktrack$BacktrackRequestCreationTime' => 'The timestamp of the time at which the backtrack was requested.
', 'DBClusterSnapshot$SnapshotCreateTime' => 'The time when the snapshot was taken, in Universal Coordinated Time (UTC).
', 'DBClusterSnapshot$ClusterCreateTime' => 'The time when the DB cluster was created, in Universal Coordinated Time (UTC).
', 'DBEngineVersion$CreateTime' => 'The creation time of the DB engine version.
', 'DBInstance$AutomaticRestartTime' => 'The time when a stopped DB instance is restarted automatically.
', 'DBInstance$InstanceCreateTime' => 'The date and time when the DB instance was created.
', 'DBInstance$LatestRestorableTime' => 'The latest time to which a database in this DB instance can be restored with point-in-time restore.
', 'DBInstance$ResumeFullAutomationModeTime' => 'The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
', 'DBInstanceAutomatedBackup$InstanceCreateTime' => 'The date and time when the DB instance was created.
', 'DBProxy$CreatedDate' => 'The date and time when the proxy was first created.
', 'DBProxy$UpdatedDate' => 'The date and time when the proxy was last updated.
', 'DBProxyEndpoint$CreatedDate' => 'The date and time when the DB proxy endpoint was first created.
', 'DBProxyTargetGroup$CreatedDate' => 'The date and time when the target group was first created.
', 'DBProxyTargetGroup$UpdatedDate' => 'The date and time when the target group was last updated.
', 'DBRecommendation$CreatedTime' => 'The time when the recommendation was created. For example, 2023-09-28T01:13:53.931000+00:00.
The time when the recommendation was last updated.
', 'DBSnapshot$SnapshotCreateTime' => 'Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
', 'DBSnapshot$InstanceCreateTime' => 'Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
', 'DBSnapshot$OriginalSnapshotCreateTime' => 'Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn\'t change when the snapshot is copied.
', 'DBSnapshot$SnapshotDatabaseTime' => 'The timestamp of the most recent transaction applied to the database that you\'re backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
', 'DBSnapshotTenantDatabase$TenantDatabaseCreateTime' => 'The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If you copy the snapshot, the creation time changes.
', 'DescribeDBRecommendationsMessage$LastUpdatedAfter' => 'A filter to include only the recommendations that were updated after this specified time.
', 'DescribeDBRecommendationsMessage$LastUpdatedBefore' => 'A filter to include only the recommendations that were updated before this specified time.
', 'DescribeEventsMessage$StartTime' => 'The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
', 'DescribeEventsMessage$EndTime' => 'The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
', 'Event$Date' => 'Specifies the date and time of the event.
', 'ExportTask$SnapshotTime' => 'The time when the snapshot was created.
', 'ExportTask$TaskStartTime' => 'The time when the snapshot or cluster export task started.
', 'ExportTask$TaskEndTime' => 'The time when the snapshot or cluster export task ended.
', 'Integration$CreateTime' => 'The time when the integration was created, in Universal Coordinated Time (UTC).
', 'OptionGroup$CopyTimestamp' => 'Indicates when the option group was copied.
', 'PendingMaintenanceAction$AutoAppliedAfterDate' => 'The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.
', 'PendingMaintenanceAction$ForcedApplyDate' => 'The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
', 'PendingMaintenanceAction$CurrentApplyDate' => 'The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
', 'PerformanceIssueDetails$StartTime' => 'The time when the performance issue started.
', 'PerformanceIssueDetails$EndTime' => 'The time when the performance issue stopped.
', 'ReservedDBInstance$StartTime' => 'The time the reservation started.
', 'RestoreDBClusterToPointInTimeMessage$RestoreToTime' => 'The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter isn\'t provided
Can\'t be specified if the UseLatestRestorableTime parameter is enabled
Can\'t be specified if the RestoreType parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBInstanceToPointInTimeMessage$RestoreTime' => 'The date and time to restore from.
Constraints:
Must be a time in Universal Coordinated Time (UTC) format.
Must be before the latest restorable time for the DB instance.
Can\'t be specified if the UseLatestRestorableTime parameter is enabled.
Example: 2009-09-07T23:45:00Z
The earliest time you can restore an instance to.
', 'RestoreWindow$LatestTime' => 'The latest time you can restore an instance to.
', 'TenantDatabase$TenantDatabaseCreateTime' => 'The creation time of the tenant database.
', ], ], 'Tag' => [ 'base' => 'Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'refs' => [ 'AddTagsToResourceMessage$Tags' => 'The tags to be assigned to the Amazon RDS resource.
', 'BlueGreenDeployment$TagList' => NULL, 'CopyDBClusterParameterGroupMessage$Tags' => NULL, 'CopyDBClusterSnapshotMessage$Tags' => NULL, 'CopyDBParameterGroupMessage$Tags' => NULL, 'CopyDBSnapshotMessage$Tags' => NULL, 'CopyOptionGroupMessage$Tags' => NULL, 'CreateBlueGreenDeploymentRequest$Tags' => 'Tags to assign to the blue/green deployment.
', 'CreateCustomDBEngineVersionMessage$Tags' => NULL, 'CreateDBClusterEndpointMessage$Tags' => 'The tags to be assigned to the Amazon RDS resource.
', 'CreateDBClusterMessage$Tags' => 'Tags to assign to the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterParameterGroupMessage$Tags' => 'Tags to assign to the DB cluster parameter group.
', 'CreateDBClusterSnapshotMessage$Tags' => 'The tags to be assigned to the DB cluster snapshot.
', 'CreateDBInstanceMessage$Tags' => 'Tags to assign to the DB instance.
', 'CreateDBInstanceReadReplicaMessage$Tags' => NULL, 'CreateDBParameterGroupMessage$Tags' => 'Tags to assign to the DB parameter group.
', 'CreateDBProxyEndpointRequest$Tags' => NULL, 'CreateDBProxyRequest$Tags' => 'An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
', 'CreateDBSecurityGroupMessage$Tags' => 'Tags to assign to the DB security group.
', 'CreateDBSnapshotMessage$Tags' => NULL, 'CreateDBSubnetGroupMessage$Tags' => 'Tags to assign to the DB subnet group.
', 'CreateEventSubscriptionMessage$Tags' => NULL, 'CreateIntegrationMessage$Tags' => NULL, 'CreateOptionGroupMessage$Tags' => 'Tags to assign to the option group.
', 'CreateTenantDatabaseMessage$Tags' => NULL, 'DBCluster$TagList' => NULL, 'DBClusterSnapshot$TagList' => NULL, 'DBEngineVersion$TagList' => NULL, 'DBInstance$TagList' => NULL, 'DBSnapshot$TagList' => NULL, 'DBSnapshotTenantDatabase$TagList' => NULL, 'Integration$Tags' => NULL, 'PurchaseReservedDBInstancesOfferingMessage$Tags' => NULL, 'RestoreDBClusterFromS3Message$Tags' => NULL, 'RestoreDBClusterFromSnapshotMessage$Tags' => 'The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$Tags' => NULL, 'RestoreDBInstanceFromDBSnapshotMessage$Tags' => NULL, 'RestoreDBInstanceFromS3Message$Tags' => 'A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$Tags' => NULL, 'TagListMessage$TagList' => 'List of tags returned by the ListTagsForResource operation.
The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.
', ], ], 'TargetDBInstanceClass' => [ 'base' => NULL, 'refs' => [ 'CreateBlueGreenDeploymentRequest$TargetDBInstanceClass' => 'Specify the DB instance class for the databases in the green environment.
This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you\'re creating a blue/green deployment from an Aurora DB cluster, don\'t specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.
', ], ], 'TargetDBParameterGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateBlueGreenDeploymentRequest$TargetDBParameterGroupName' => 'The DB parameter group associated with the DB instance in the green environment.
To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.
', ], ], 'TargetEngineVersion' => [ 'base' => NULL, 'refs' => [ 'CreateBlueGreenDeploymentRequest$TargetEngineVersion' => 'The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
', ], ], 'TargetGroupList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBProxyTargetGroupsResponse$TargetGroups' => 'An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.
Information about the connection health of an RDS Proxy target.
', 'refs' => [ 'DBProxyTarget$TargetHealth' => 'Information about the connection health of the RDS Proxy target.
', ], ], 'TargetHealthReason' => [ 'base' => NULL, 'refs' => [ 'TargetHealth$Reason' => 'The reason for the current health State of the RDS Proxy target.
An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
One or more DBProxyTarget objects that are created when you register targets with a target group.
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
', ], ], 'TargetState' => [ 'base' => NULL, 'refs' => [ 'TargetHealth$State' => 'The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering > unavailable > available > unavailable > available
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
', ], ], 'TenantDatabase' => [ 'base' => 'A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases action.
You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
', 'refs' => [], ], 'TenantDatabaseNotFoundFault' => [ 'base' => 'The specified tenant database wasn\'t found in the DB instance.
', 'refs' => [], ], 'TenantDatabasePendingModifiedValues' => [ 'base' => 'A response element in the ModifyTenantDatabase operation that describes changes that will be applied. Specific changes are identified by subelements.
Information about pending changes for a tenant database.
', ], ], 'TenantDatabaseQuotaExceededFault' => [ 'base' => 'You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
', 'refs' => [], ], 'TenantDatabasesList' => [ 'base' => NULL, 'refs' => [ 'TenantDatabasesMessage$TenantDatabases' => 'An array of the tenant databases requested by the DescribeTenantDatabases operation.
A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.
The specified DB engine version isn\'t supported for Aurora Limitless Database.
', 'refs' => [], ], 'UpgradeTarget' => [ 'base' => 'The version of the database engine that a DB instance can be upgraded to.
', 'refs' => [ 'ValidUpgradeTargetList$member' => NULL, ], ], 'UserAuthConfig' => [ 'base' => 'Specifies the details of authentication used by a proxy to log in as a specific database user.
', 'refs' => [ 'UserAuthConfigList$member' => NULL, ], ], 'UserAuthConfigInfo' => [ 'base' => 'Returns the details of authentication used by a proxy to log in as a specific database user.
', 'refs' => [ 'UserAuthConfigInfoList$member' => NULL, ], ], 'UserAuthConfigInfoList' => [ 'base' => NULL, 'refs' => [ 'DBProxy$Auth' => 'One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
', ], ], 'UserAuthConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateDBProxyRequest$Auth' => 'The authorization mechanism that the proxy uses.
', 'ModifyDBProxyRequest$Auth' => 'The new authentication settings for the DBProxy.
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.
Valid storage options for your DB instance.
', ], ], 'ValidUpgradeTargetList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$ValidUpgradeTarget' => 'A list of engine versions that this database engine version can be upgraded to.
', ], ], 'VpcSecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBInstanceMessage$VpcSecurityGroupIds' => 'A list of Amazon EC2 VPC security groups to associate with this DB instance.
This setting doesn\'t apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group\'s VPC.
', 'CreateDBInstanceReadReplicaMessage$VpcSecurityGroupIds' => 'A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn\'t apply to RDS Custom DB instances.
Default: The default EC2 VPC security group for the DB subnet group\'s VPC.
', 'ModifyDBClusterMessage$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBInstanceMessage$VpcSecurityGroupIds' => 'A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
A list of VpcSecurityGroupMembership name strings used for this option.
', 'RestoreDBClusterFromS3Message$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with the restored DB cluster.
', 'RestoreDBClusterFromSnapshotMessage$VpcSecurityGroupIds' => 'A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$VpcSecurityGroupIds' => 'A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBInstanceFromDBSnapshotMessage$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group\'s VPC.
', 'RestoreDBInstanceFromS3Message$VpcSecurityGroupIds' => 'A list of VPC security groups to associate with this DB instance.
', 'RestoreDBInstanceToPointInTimeMessage$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group\'s VPC.
', ], ], 'VpcSecurityGroupMembership' => [ 'base' => 'This data type is used as a response element for queries on VPC security group membership.
', 'refs' => [ 'VpcSecurityGroupMembershipList$member' => NULL, ], ], 'VpcSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$VpcSecurityGroups' => 'The list of VPC security groups that the DB cluster belongs to.
', 'DBInstance$VpcSecurityGroups' => 'The list of Amazon EC2 VPC security groups that the DB instance belongs to.
', 'Option$VpcSecurityGroupMemberships' => 'If the option requires access to a port, then this VPC security group allows access to the port.
', ], ], 'WriteForwardingStatus' => [ 'base' => NULL, 'refs' => [ 'DBCluster$GlobalWriteForwardingStatus' => 'The status of write forwarding for a secondary cluster in an Aurora global database.
', 'GlobalClusterMember$GlobalWriteForwardingStatus' => 'The status of write forwarding for a secondary cluster in the global cluster.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance\'s compute resources and storage capacity to meet your application\'s demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
Associates an Identity and Access Management (IAM) role with a DB cluster.
', 'AddRoleToDBInstance' => 'Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be available.
This command doesn\'t apply to RDS Custom.
', 'AddSourceIdentifierToSubscription' => 'Adds a source identifier to an existing RDS event notification subscription.
', 'AddTagsToResource' => 'Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
', 'ApplyPendingMaintenanceAction' => 'Applies a pending maintenance action to a resource (for example, to a DB instance).
', 'AuthorizeDBSecurityGroupIngress' => 'Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can\'t authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can\'t authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Backtracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
This action applies only to Aurora MySQL DB clusters.
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn\'t removed.
', 'CopyDBClusterParameterGroup' => 'Copies the specified DB cluster parameter group.
You can\'t copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:
KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'CopyDBParameterGroup' => 'Copies the specified DB parameter group.
You can\'t copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.
Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.
This command doesn\'t apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
', 'CopyOptionGroup' => 'Copies the specified option group.
', 'CreateBlueGreenDeployment' => 'Creates a blue/green deployment.
A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.
You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'CreateCustomDBEngineVersion' => 'Creates a custom DB engine version (CEV).
', 'CreateDBCluster' => 'Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action applies only to Aurora DB clusters.
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you\'ve created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'CreateDBClusterSnapshot' => 'Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'CreateDBInstance' => 'Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
', 'CreateDBInstanceReadReplica' => 'Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn\'t support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance operation.
All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you\'ve created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
This command doesn\'t apply to RDS Custom.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Creates a new DB proxy.
', 'CreateDBProxyEndpoint' => 'Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy\'s default VPC.
Creates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
', 'CreateDBSnapshot' => 'Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
', 'CreateEventSubscription' => 'Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don\'t specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.
For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.
For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.
', 'CreateGlobalCluster' => 'Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This operation applies only to Aurora DB clusters.
Creates a zero-ETL integration with Amazon Redshift.
', 'CreateOptionGroup' => 'Creates a new option group. You can create up to 20 option groups.
This command doesn\'t apply to RDS Custom.
', 'CreateTenantDatabase' => 'Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.
', 'DeleteBlueGreenDeployment' => 'Deletes a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'DeleteCustomDBEngineVersion' => 'Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
The MediaImport service that imports files from Amazon S3 to create CEVs isn\'t integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren\'t logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event.
For more information, see Deleting a CEV in the Amazon RDS User Guide.
', 'DeleteDBCluster' => 'The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can\'t be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
If you\'re deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DeleteDBClusterAutomatedBackup' => 'Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can\'t be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DeleteDBClusterSnapshot' => 'Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DeleteDBInstance' => 'Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can\'t be recovered. However, manual DB snapshots of the DB instance aren\'t deleted.
If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. This operation can\'t be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can\'t delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it\'s no longer a read replica. After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don\'t terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
Deletes a specified DB parameter group. The DB parameter group to be deleted can\'t be associated with any DB instances.
', 'DeleteDBProxy' => 'Deletes an existing DB proxy.
', 'DeleteDBProxyEndpoint' => 'Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy\'s default VPC.
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Deletes an Aurora Limitless Database DB shard group.
', 'DeleteDBSnapshot' => 'Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the available state to be deleted.
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
Deletes an RDS event notification subscription.
', 'DeleteGlobalCluster' => 'Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
Deletes a zero-ETL integration with Amazon Redshift.
', 'DeleteOptionGroup' => 'Deletes an existing option group.
', 'DeleteTenantDatabase' => 'Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.
You can\'t delete a tenant database when it is the only tenant in the DB instance.
', 'DeregisterDBProxyTargets' => 'Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota\'s maximum value.
This command doesn\'t take any parameters.
', 'DescribeBlueGreenDeployments' => 'Describes one or more blue/green deployments.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'DescribeCertificates' => 'Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'DescribeDBClusterAutomatedBackups' => 'Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.
All parameters are optional.
', 'DescribeDBClusterBacktracks' => 'Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DescribeDBClusterParameters' => 'Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DescribeDBClusterSnapshotAttributes' => 'Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'DescribeDBClusters' => 'Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
', 'DescribeDBEngineVersions' => 'Describes the properties of specific versions of DB engines.
', 'DescribeDBInstanceAutomatedBackups' => 'Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.
All parameters are optional.
', 'DescribeDBInstances' => 'Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Returns a list of DB log files for the DB instance.
This command doesn\'t apply to RDS Custom.
', 'DescribeDBParameterGroups' => 'Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Returns the detailed parameter list for a particular DB parameter group.
', 'DescribeDBProxies' => 'Returns information about DB proxies.
', 'DescribeDBProxyEndpoints' => 'Returns information about DB proxy endpoints.
', 'DescribeDBProxyTargetGroups' => 'Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
Returns information about DBProxyTarget objects. This API supports pagination.
Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
', 'DescribeDBSecurityGroups' => 'Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Describes existing Aurora Limitless Database DB shard groups.
', 'DescribeDBSnapshotAttributes' => 'Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.
You can use this command to inspect the tenant databases within a snapshot before restoring it. You can\'t directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.
', 'DescribeDBSnapshots' => 'Returns information about DB snapshots. This API action supports pagination.
', 'DescribeDBSubnetGroups' => 'Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
', 'DescribeEngineDefaultClusterParameters' => 'Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
', 'DescribeEngineDefaultParameters' => 'Returns the default engine and system parameter information for the specified database engine.
', 'DescribeEventCategories' => 'Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
', 'DescribeEventSubscriptions' => 'Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.
By default, RDS returns events that were generated in the past hour.
Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
', 'DescribeGlobalClusters' => 'Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Describe one or more zero-ETL integrations with Amazon Redshift.
', 'DescribeOptionGroupOptions' => 'Describes all available options for the specified engine.
', 'DescribeOptionGroups' => 'Describes the available option groups.
', 'DescribeOrderableDBInstanceOptions' => 'Describes the orderable DB instance options for a specified DB engine.
', 'DescribePendingMaintenanceActions' => 'Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
', 'DescribeReservedDBInstances' => 'Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
', 'DescribeReservedDBInstancesOfferings' => 'Lists available reserved DB instance offerings.
', 'DescribeSourceRegions' => 'Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference.
Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.
', 'DescribeValidDBInstanceModifications' => 'You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
This command doesn\'t apply to RDS Custom.
', 'DisableHttpEndpoint' => 'Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn\'t apply to RDS Custom.
', 'EnableHttpEndpoint' => 'Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn\'t enabled.
When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.
Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'FailoverGlobalCluster' => 'Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."
Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.
How you use this operation depends on whether you are failing over or switching over your global database cluster:
Failing over - Specify the AllowDataLoss parameter and don\'t specify the Switchover parameter.
Switching over - Specify the Switchover parameter or omit it, but don\'t specify the AllowDataLoss parameter.
About failing over and switching over
While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:
Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn\'t replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.
Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.
For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'ModifyActivityStream' => 'Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn\'t required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
', 'ModifyCertificates' => 'Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
', 'ModifyCurrentDBClusterCapacity' => 'Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This operation only applies to Aurora Serverless v1 DB clusters.
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn\'t integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren\'t logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
', 'ModifyDBCluster' => 'Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'ModifyDBClusterEndpoint' => 'Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This operation only applies to Aurora DB clusters.
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create operation before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'ModifyDBClusterSnapshotAttribute' => 'Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.
Don\'t add the all value for any manual DB cluster snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify operation before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Changes the settings for an existing DB proxy.
', 'ModifyDBProxyEndpoint' => 'Changes the settings for an existing DB proxy endpoint.
', 'ModifyDBProxyTargetGroup' => 'Modifies the properties of a DBProxyTargetGroup.
Updates the recommendation status and recommended action status for the specified recommendation.
', 'ModifyDBShardGroup' => 'Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
', 'ModifyDBSnapshot' => 'Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn\'t apply to RDS Custom or RDS for Db2.
', 'ModifyDBSnapshotAttribute' => 'Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.
Don\'t add the all value for any manual DB snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
', 'ModifyEventSubscription' => 'Modifies an existing RDS event notification subscription. You can\'t modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora global database clusters.
Modifies a zero-ETL integration with Amazon Redshift.
Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don\'t support modifying the integration.
Modifies an existing option group.
', 'ModifyTenantDatabase' => 'Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.
', 'PromoteReadReplica' => 'Promotes a read replica DB instance to a standalone DB instance.
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.
This command doesn\'t apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
Promotes a read replica DB cluster to a standalone DB cluster.
', 'PurchaseReservedDBInstancesOffering' => 'Purchases a reserved DB instance offering.
', 'RebootDBCluster' => 'You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'RebootDBInstance' => 'You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn\'t apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect.
This operation applies only to Aurora Limitless Database DBb shard groups.
', 'RegisterDBProxyTargets' => 'Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
This operation only applies to Aurora DB clusters.
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'RemoveRoleFromDBInstance' => 'Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
', 'RemoveSourceIdentifierFromSubscription' => 'Removes a source identifier from an existing RDS event notification subscription.
', 'RemoveTagsFromResource' => 'Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'ResetDBClusterParameterGroup' => 'Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'ResetDBParameterGroup' => 'Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 operation has completed and the DB cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don\'t specify a security group, the new DB cluster is associated with the default security group.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'RestoreDBClusterToPointInTime' => 'Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime operation has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromDBSnapshot' => 'Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source\'s original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn\'t allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This operation doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTime' => 'Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
This operation doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
EC2-Classic was retired on August 15, 2022. If you haven\'t migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
', 'StartDBCluster' => 'Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
This command doesn\'t apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn\'t apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
', 'StartExportTask' => 'Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.
You can\'t export snapshot data from Db2 or RDS Custom DB instances.
You can\'t export cluster data from Multi-AZ DB clusters.
For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
', 'StopActivityStream' => 'Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation.
For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
', 'StopDBCluster' => 'Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster\'s metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance\'s metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn\'t apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
Stops automated backup replication for a DB instance.
This command doesn\'t apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
', 'SwitchoverBlueGreenDeployment' => 'Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'SwitchoverGlobalCluster' => 'Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."
Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.
This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.
Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.
', ], 'shapes' => [ 'AccountAttributesMessage' => [ 'base' => 'Data returned by the DescribeAccountAttributes action.
', 'refs' => [], ], 'AccountQuota' => [ 'base' => 'Describes a quota for an Amazon Web Services account.
The following are account quotas:
AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.
AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.
CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.
DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.
DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.
DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.
DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.
DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account.
Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.
DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.
DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.
DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.
EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.
ManualClusterSnapshots - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account.
ManualSnapshots - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account.
OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.
ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.
ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.
SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.
', 'refs' => [ 'AccountQuotaList$member' => NULL, ], ], 'AccountQuotaList' => [ 'base' => NULL, 'refs' => [ 'AccountAttributesMessage$AccountQuotas' => 'A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
', 'DBInstance$ActivityStreamMode' => 'The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
', 'ModifyActivityStreamResponse$Mode' => 'The mode of the database activity stream.
', 'StartActivityStreamRequest$Mode' => 'Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
', 'StartActivityStreamResponse$Mode' => 'The mode of the database activity stream.
', ], ], 'ActivityStreamModeList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$SupportedActivityStreamModes' => 'The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn\'t supported, the return value is an empty list.
The status of the policy state of the activity stream.
', 'ModifyActivityStreamResponse$PolicyStatus' => 'The status of the modification to the policy state of the database activity stream.
', ], ], 'ActivityStreamStatus' => [ 'base' => NULL, 'refs' => [ 'DBCluster$ActivityStreamStatus' => 'The status of the database activity stream.
', 'DBInstance$ActivityStreamStatus' => 'The status of the database activity stream.
', 'ModifyActivityStreamResponse$Status' => 'The status of the modification to the database activity stream.
', 'StartActivityStreamResponse$Status' => 'The status of the database activity stream.
', 'StopActivityStreamResponse$Status' => 'The status of the database activity stream.
', ], ], 'AddRoleToDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'AddRoleToDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'AddSourceIdentifierToSubscriptionMessage' => [ 'base' => '', 'refs' => [], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsToResourceMessage' => [ 'base' => '', 'refs' => [], ], 'ApplyMethod' => [ 'base' => NULL, 'refs' => [ 'Parameter$ApplyMethod' => 'Indicates when to apply parameter updates.
', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'base' => '', 'refs' => [], ], 'ApplyPendingMaintenanceActionResult' => [ 'base' => NULL, 'refs' => [], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$TargetArn' => 'The ARN of the Redshift data warehouse to use as the target for replication.
', 'Integration$TargetArn' => 'The ARN of the Redshift data warehouse used as the target for replication.
', ], ], 'AttributeValueList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttribute$AttributeValues' => 'The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
The value or values for the manual DB snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
A list of DB snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.
The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
', ], ], 'AuthScheme' => [ 'base' => NULL, 'refs' => [ 'UserAuthConfig$AuthScheme' => 'The type of authentication that the proxy uses for connections from the proxy to the underlying database.
', 'UserAuthConfigInfo$AuthScheme' => 'The type of authentication that the proxy uses for connections from the proxy to the underlying database.
', ], ], 'AuthorizationAlreadyExistsFault' => [ 'base' => 'The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.
', 'refs' => [], ], 'AuthorizationNotFoundFault' => [ 'base' => 'The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
', 'refs' => [], ], 'AuthorizationQuotaExceededFault' => [ 'base' => 'The DB security group authorization quota has been reached.
', 'refs' => [], ], 'AuthorizeDBSecurityGroupIngressMessage' => [ 'base' => '', 'refs' => [], ], 'AuthorizeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'AutomationMode' => [ 'base' => NULL, 'refs' => [ 'DBInstance$AutomationMode' => 'The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
The automation mode of the RDS Custom DB instance. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes.
The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
A list of Availability Zones for a DB instance.
', ], ], 'AvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$AvailabilityZones' => 'A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.
For information on AZs, see Availability Zones in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Constraints:
Can\'t specify more than three AZs.
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
', 'DBClusterAutomatedBackup$AvailabilityZones' => 'The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
', 'DBClusterSnapshot$AvailabilityZones' => 'The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
', 'RestoreDBClusterFromS3Message$AvailabilityZones' => 'A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
', 'RestoreDBClusterFromSnapshotMessage$AvailabilityZones' => 'Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
', ], ], 'AvailableProcessorFeature' => [ 'base' => 'Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
', 'refs' => [ 'AvailableProcessorFeatureList$member' => NULL, ], ], 'AvailableProcessorFeatureList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$AvailableProcessorFeatures' => 'A list of the available processor features for the DB instance class of a DB instance.
', 'ValidDBInstanceModificationsMessage$ValidProcessorFeatures' => 'Valid processor features for your DB instance.
', ], ], 'AwsBackupRecoveryPointArn' => [ 'base' => NULL, 'refs' => [ 'ModifyDBClusterMessage$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'ModifyDBInstanceMessage$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn\'t apply to RDS Custom DB instances.
', ], ], 'BacktrackDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'BackupPolicyNotFoundFault' => [ 'base' => NULL, 'refs' => [], ], 'BlueGreenDeployment' => [ 'base' => 'Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'refs' => [ 'BlueGreenDeploymentList$member' => NULL, 'CreateBlueGreenDeploymentResponse$BlueGreenDeployment' => NULL, 'DeleteBlueGreenDeploymentResponse$BlueGreenDeployment' => NULL, 'SwitchoverBlueGreenDeploymentResponse$BlueGreenDeployment' => NULL, ], ], 'BlueGreenDeploymentAlreadyExistsFault' => [ 'base' => 'A blue/green deployment with the specified name already exists.
', 'refs' => [], ], 'BlueGreenDeploymentIdentifier' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$BlueGreenDeploymentIdentifier' => 'The unique identifier of the blue/green deployment.
', 'DeleteBlueGreenDeploymentRequest$BlueGreenDeploymentIdentifier' => 'The unique identifier of the blue/green deployment to delete. This parameter isn\'t case-sensitive.
Constraints:
Must match an existing blue/green deployment identifier.
The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn\'t case-sensitive.
Constraints:
Must match an existing blue/green deployment identifier.
The unique identifier of the blue/green deployment.
Constraints:
Must match an existing blue/green deployment identifier.
A list of blue/green deployments in the current account and Amazon Web Services Region.
', ], ], 'BlueGreenDeploymentName' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$BlueGreenDeploymentName' => 'The user-supplied name of the blue/green deployment.
', 'CreateBlueGreenDeploymentRequest$BlueGreenDeploymentName' => 'The name of the blue/green deployment.
Constraints:
Can\'t be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
BlueGreenDeploymentIdentifier doesn\'t refer to an existing blue/green deployment.
The status of the blue/green deployment.
Valid Values:
PROVISIONING - Resources are being created in the green environment.
AVAILABLE - Resources are available in the green environment.
SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.
SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.
INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn\'t possible.
SWITCHOVER_FAILED - Switchover was attempted but failed.
DELETING - The blue/green deployment is being deleted.
Additional information about the status of the blue/green deployment.
', ], ], 'BlueGreenDeploymentTask' => [ 'base' => 'Details about a task for a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'refs' => [ 'BlueGreenDeploymentTaskList$member' => NULL, ], ], 'BlueGreenDeploymentTaskList' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$Tasks' => 'Either tasks to be performed or tasks that have been completed on the target database before switchover.
', ], ], 'BlueGreenDeploymentTaskName' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeploymentTask$Name' => 'The name of the blue/green deployment task.
', ], ], 'BlueGreenDeploymentTaskStatus' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeploymentTask$Status' => 'The status of the blue/green deployment task.
Valid Values:
PENDING - The resource is being prepared for deployment.
IN_PROGRESS - The resource is being deployed.
COMPLETED - The resource has been deployed.
FAILED - Deployment of the resource failed.
Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
', 'CreateDBProxyRequest$DebugLogging' => 'Specifies whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
', 'DBCluster$StorageEncrypted' => 'Indicates whether the DB cluster is encrypted.
', 'DBCluster$AutoMinorVersionUpgrade' => 'Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterAutomatedBackup$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'DBClusterAutomatedBackup$StorageEncrypted' => 'Indicates whether the source DB cluster is encrypted.
', 'DBClusterMember$IsClusterWriter' => 'Indicates whether the cluster member is the primary DB instance for the DB cluster.
', 'DBClusterSnapshot$StorageEncrypted' => 'Indicates whether the DB cluster snapshot is encrypted.
', 'DBClusterSnapshot$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'DBClusterStatusInfo$Normal' => 'Reserved for future use.
', 'DBEngineVersion$SupportsLogExportsToCloudwatchLogs' => 'Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
', 'DBEngineVersion$SupportsReadReplica' => 'Indicates whether the database engine version supports read replicas.
', 'DBEngineVersion$SupportsParallelQuery' => 'Indicates whether you can use Aurora parallel query with a specific DB engine version.
', 'DBEngineVersion$SupportsGlobalDatabases' => 'Indicates whether you can use Aurora global databases with a specific DB engine version.
', 'DBEngineVersion$SupportsBabelfish' => 'Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
', 'DBEngineVersion$SupportsLimitlessDatabase' => 'Indicates whether the DB engine version supports Aurora Limitless Database.
', 'DBEngineVersion$SupportsIntegrations' => 'Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
', 'DBInstance$MultiAZ' => 'Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn\'t apply to RDS Custom DB instances.
', 'DBInstance$AutoMinorVersionUpgrade' => 'Indicates whether minor version patches are applied automatically.
', 'DBInstance$PubliclyAccessible' => 'Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'DBInstance$StorageEncrypted' => 'Indicates whether the DB instance is encrypted.
', 'DBInstance$CopyTagsToSnapshot' => 'Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn\'t apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
', 'DBInstance$DeletionProtection' => 'Indicates whether the DB instance has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
', 'DBInstance$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'DBInstanceAutomatedBackup$Encrypted' => 'Indicates whether the automated backup is encrypted.
', 'DBInstanceAutomatedBackup$IAMDatabaseAuthenticationEnabled' => 'True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
', 'DBInstanceStatusInfo$Normal' => 'Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).
', 'DBProxy$RequireTLS' => 'Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
', 'DBProxy$DebugLogging' => 'Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
', 'DBProxyEndpoint$IsDefault' => 'Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
', 'DBProxyTargetGroup$IsDefault' => 'Indicates whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.
Indicates whether the DB snapshot is encrypted.
', 'DBSnapshot$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'DBSnapshot$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'DeleteDBClusterMessage$SkipFinalSnapshot' => 'Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn\'t specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn\'t specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
Specifies whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn\'t create a DB snapshot. If you don\'t enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn\'t enabled, and the DB snapshot is created.
If you don\'t enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
', 'DeleteTenantDatabaseMessage$SkipFinalSnapshot' => 'Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB instance. If you enable this parameter, RDS doesn\'t create a DB snapshot. If you don\'t enable this parameter, RDS creates a DB snapshot before it deletes the tenant database. By default, RDS doesn\'t skip the final snapshot. If you don\'t enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
', 'DescribeDBClustersMessage$IncludeShared' => 'Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
', 'DescribeDBEngineVersionsMessage$DefaultOnly' => 'Specifies whether to return only the default version of the specified engine or the engine and major version combination.
', 'DescribeDBSnapshotsMessage$IncludeShared' => 'Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn\'t apply to RDS Custom.
', 'DescribeDBSnapshotsMessage$IncludePublic' => 'Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn\'t apply to RDS Custom.
', 'DisableHttpEndpointResponse$HttpEndpointEnabled' => 'Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.
', 'DownloadDBLogFilePortionDetails$AdditionalDataPending' => 'A Boolean value that, if true, indicates there is more data to be downloaded.
', 'EnableHttpEndpointResponse$HttpEndpointEnabled' => 'Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.
', 'EventSubscription$Enabled' => 'Specifies whether the subscription is enabled. True indicates the subscription is enabled.
', 'FailoverState$IsDataLossAllowed' => 'Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it\'s a switchover.
', 'GlobalClusterMember$IsWriter' => 'Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.
', 'ModifyDBClusterMessage$ApplyImmediately' => 'Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$AllowMajorVersionUpgrade' => 'Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster\'s current version.
Specifies whether engine mode changes from serverless to provisioned are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster\'s current engine mode.
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
Specifies whether major version upgrades are allowed. Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that\'s a different major version than the DB instance\'s current version.
Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
', 'Option$Persistent' => 'Indicates whether this option is persistent.
', 'Option$Permanent' => 'Indicates whether this option is permanent.
', 'OptionGroup$AllowsVpcAndNonVpcInstanceMemberships' => 'Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
Indicates whether the option requires a port.
', 'OptionGroupOption$Persistent' => 'Persistent options can\'t be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
', 'OptionGroupOption$Permanent' => 'Permanent options can never be removed from an option group. An option group containing a permanent option can\'t be removed from a DB instance.
', 'OptionGroupOption$RequiresAutoMinorEngineVersionUpgrade' => 'If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
', 'OptionGroupOption$VpcOnly' => 'If true, you can only use this option with a DB instance that is in a VPC.
', 'OptionGroupOptionSetting$IsModifiable' => 'Indicates whether this option group option can be changed from the default value.
', 'OptionGroupOptionSetting$IsRequired' => 'Indicates whether a value must be specified for this option setting of the option group option.
', 'OptionSetting$IsModifiable' => 'Indicates whether the option setting can be modified from the default.
', 'OptionSetting$IsCollection' => 'Indicates whether the option setting is part of a collection.
', 'OptionVersion$IsDefault' => 'Indicates whether the version is the default version of the option.
', 'OrderableDBInstanceOption$MultiAZCapable' => 'Indicates whether a DB instance is Multi-AZ capable.
', 'OrderableDBInstanceOption$ReadReplicaCapable' => 'Indicates whether a DB instance can have a read replica.
', 'OrderableDBInstanceOption$Vpc' => 'Indicates whether a DB instance is in a VPC.
', 'OrderableDBInstanceOption$SupportsStorageEncryption' => 'Indicates whether a DB instance supports encrypted storage.
', 'OrderableDBInstanceOption$SupportsIops' => 'Indicates whether a DB instance supports provisioned IOPS.
', 'OrderableDBInstanceOption$SupportsEnhancedMonitoring' => 'Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
', 'OrderableDBInstanceOption$SupportsIAMDatabaseAuthentication' => 'Indicates whether a DB instance supports IAM database authentication.
', 'OrderableDBInstanceOption$SupportsPerformanceInsights' => 'Indicates whether a DB instance supports Performance Insights.
', 'OrderableDBInstanceOption$OutpostCapable' => 'Indicates whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'OrderableDBInstanceOption$SupportsGlobalDatabases' => 'Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
', 'OrderableDBInstanceOption$SupportsClusters' => 'Indicates whether DB instances can be configured as a Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
', 'OrderableDBInstanceOption$SupportsStorageThroughput' => 'Indicates whether a DB instance supports storage throughput.
', 'OrderableDBInstanceOption$SupportsDedicatedLogVolume' => 'Indicates whether a DB instance supports using a dedicated log volume (DLV).
', 'Parameter$IsModifiable' => 'Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
Indicates whether the reservation applies to Multi-AZ deployments.
', 'ReservedDBInstancesOffering$MultiAZ' => 'Indicates whether the offering applies to Multi-AZ deployments.
', 'ResetDBClusterParameterGroupMessage$ResetAllParameters' => 'Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can\'t use this parameter if there is a list of parameter names specified for the Parameters parameter.
Specifies whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
', 'RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime' => 'Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn\'t restored to the latest restorable backup time.
Constraints: Can\'t be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBInstanceToPointInTimeMessage$UseLatestRestorableTime' => 'Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn\'t restored from the latest backup time.
Constraints:
Can\'t be specified if the RestoreTime parameter is provided.
Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
', 'StartActivityStreamResponse$ApplyImmediately' => 'Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
', 'TenantDatabase$DeletionProtection' => 'Specifies whether deletion protection is enabled for the DB instance.
', 'UpgradeTarget$AutoUpgrade' => 'Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
This parameter is dynamic, and is set by RDS.
', 'UpgradeTarget$IsMajorVersionUpgrade' => 'Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
', 'ValidDBInstanceModificationsMessage$SupportsDedicatedLogVolume' => 'Indicates whether a DB instance supports using a dedicated log volume (DLV).
', 'ValidStorageOptions$SupportsStorageAutoscaling' => 'Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'BacktrackDBClusterMessage$Force' => 'Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
', 'BacktrackDBClusterMessage$UseEarliestTimeOnPointInTimeUnavailable' => 'Specifies whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
', 'Certificate$CustomerOverride' => 'Indicates whether there is an override for the default certificate identifier.
', 'ClusterPendingModifiedValues$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'CopyDBClusterSnapshotMessage$CopyTags' => 'Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
', 'CopyDBSnapshotMessage$CopyTags' => 'Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren\'t copied.
', 'CopyDBSnapshotMessage$CopyOptionGroup' => 'Specifies whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.
', 'CreateBlueGreenDeploymentRequest$UpgradeTargetStorageConfig' => 'Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see Upgrading the storage file system for a DB instance.
', 'CreateCustomDBEngineVersionMessage$UseAwsProvidedLatestImage' => 'Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can\'t also specify ImageId.
Specifies whether the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$DeletionProtection' => 'Specifies whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$EnableHttpEndpoint' => 'Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn\'t enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
RDS Data API is supported with the following DB clusters:
Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$EnableGlobalWriteForwarding' => 'Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$PubliclyAccessible' => 'Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$EnablePerformanceInsights' => 'Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$EnableLimitlessDatabase' => 'Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
', 'CreateDBClusterMessage$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren\'t allowed on reader DB instances.
Valid for: Aurora DB clusters only
', 'CreateDBInstanceMessage$MultiAZ' => 'Specifies whether the DB instance is a Multi-AZ deployment. You can\'t set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
RDS Custom
Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
Specifes whether the DB instance is encrypted. By default, it isn\'t encrypted.
For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.
This setting doesn\'t apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.
', 'CreateDBInstanceMessage$CopyTagsToSnapshot' => 'Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn\'t apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
', 'CreateDBInstanceMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)
RDS Custom
Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$DeletionProtection' => 'Specifies whether the DB instance has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
This setting doesn\'t apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'CreateDBInstanceMessage$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'CreateDBInstanceMessage$MultiTenant' => 'Specifies whether to use the multi-tenant configuration or the single-tenant configuration (default). This parameter only applies to RDS for Oracle container database (CDB) engines.
Note the following restrictions:
The DB engine that you specify in the request must support the multi-tenant configuration. If you attempt to enable the multi-tenant configuration on a DB engine that doesn\'t support it, the request fails.
If you specify the multi-tenant configuration when you create your DB instance, you can\'t later modify this DB instance to use the single-tenant configuration.
Specifies whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade' => 'Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.
This setting doesn\'t apply to RDS Custom DB instances.
Default: Inherits the value from the source DB instance.
', 'CreateDBInstanceReadReplicaMessage$PubliclyAccessible' => 'Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren\'t copied.
', 'CreateDBInstanceReadReplicaMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights' => 'Specifies whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB instance. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
', 'CreateDBInstanceReadReplicaMessage$EnableCustomerOwnedIp' => 'Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'CreateDBInstanceReadReplicaMessage$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'CreateDBInstanceReadReplicaMessage$UpgradeStorageConfig' => 'Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.
', 'CreateDBShardGroupMessage$PubliclyAccessible' => 'Specifies whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group\'s VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn\'t permit it.
When the DB shard group isn\'t publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
Specifies whether to activate the subscription. If the event notification subscription isn\'t activated, the subscription is created but not active.
', 'CreateGlobalClusterMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the new global database cluster. The global database can\'t be deleted when deletion protection is enabled.
', 'CreateGlobalClusterMessage$StorageEncrypted' => 'Specifies whether to enable storage encryption for the new global database cluster.
Constraints:
Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.
Indicates whether the DB cluster has instances in multiple Availability Zones.
', 'DBCluster$IAMDatabaseAuthenticationEnabled' => 'Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'DBCluster$DeletionProtection' => 'Indicates whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled.
', 'DBCluster$HttpEndpointEnabled' => 'Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
', 'DBCluster$CopyTagsToSnapshot' => 'Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
', 'DBCluster$CrossAccountClone' => 'Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
', 'DBCluster$GlobalWriteForwardingRequested' => 'Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$PerformanceInsightsEnabled' => 'Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBEngineVersion$SupportsCertificateRotationWithoutRestart' => 'Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
', 'DBEngineVersion$SupportsLocalWriteForwarding' => 'Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren\'t allowed on reader DB instances.
Valid for: Aurora DB clusters only
', 'DBInstance$PerformanceInsightsEnabled' => 'Indicates whether Performance Insights is enabled for the DB instance.
', 'DBInstance$CustomerOwnedIpEnabled' => 'Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'DBInstance$ActivityStreamEngineNativeAuditFieldsIncluded' => 'Indicates whether engine-native audit fields are included in the database activity stream.
', 'DBInstance$IsStorageConfigUpgradeAvailable' => 'Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
', 'DBInstance$MultiTenant' => 'Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
', 'DBInstanceAutomatedBackup$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'DBInstanceAutomatedBackup$MultiTenant' => 'Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
', 'DBShardGroup$PubliclyAccessible' => 'Indicates whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group\'s VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB shard group doesn\'t permit it.
When the DB shard group isn\'t publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
For more information, see CreateDBShardGroup.
This setting is only for Aurora Limitless Database.
', 'DBSnapshot$MultiTenant' => 'Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
', 'DeleteBlueGreenDeploymentRequest$DeleteTarget' => 'Specifies whether to delete the resources in the green environment. You can\'t specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.
Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn\'t case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.
', 'DeleteDBInstanceMessage$DeleteAutomatedBackups' => 'Specifies whether to remove automated backups immediately after the DB instance is deleted. This parameter isn\'t case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
', 'DescribeDBEngineVersionsMessage$ListSupportedCharacterSets' => 'Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
', 'DescribeDBEngineVersionsMessage$ListSupportedTimezones' => 'Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
', 'DescribeDBEngineVersionsMessage$IncludeAll' => 'Specifies whether to also list the engine versions that aren\'t available. The default is to list only available engine versions.
', 'DescribeOrderableDBInstanceOptionsMessage$Vpc' => 'Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
', 'DescribeReservedDBInstancesMessage$MultiAZ' => 'Specifies whether to show only those reservations that support Multi-AZ.
', 'DescribeReservedDBInstancesOfferingsMessage$MultiAZ' => 'Specifies whether to show only those reservations that support Multi-AZ.
', 'FailoverGlobalClusterMessage$AllowDataLoss' => 'Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.
If you don\'t specify AllowDataLoss, the global database cluster operation defaults to a switchover.
Constraints:
Can\'t be specified together with the Switchover parameter.
Specifies whether to switch over this global database cluster.
Constraints:
Can\'t be specified together with the AllowDataLoss parameter.
The storage encryption setting for the global database cluster.
', 'GlobalCluster$DeletionProtection' => 'The deletion protection setting for the new global database cluster.
', 'ModifyActivityStreamResponse$EngineNativeAuditFieldsIncluded' => 'Indicates whether engine-native audit fields are included in the database activity stream.
', 'ModifyCertificatesMessage$RemoveCustomerOverride' => 'Specifies whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
', 'ModifyDBClusterMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$DeletionProtection' => 'Specifies whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$EnableHttpEndpoint' => 'Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn\'t enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$EnableGlobalWriteForwarding' => 'Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$AutoMinorVersionUpgrade' => 'Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$EnablePerformanceInsights' => 'Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn\'t manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can\'t specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$RotateMasterUserPassword' => 'Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren\'t allowed on reader DB instances.
Valid for: Aurora DB clusters only
', 'ModifyDBClusterMessage$EnableLimitlessDatabase' => 'Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
', 'ModifyDBInstanceMessage$MultiAZ' => 'Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn\'t result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$AutoMinorVersionUpgrade' => 'Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn\'t met, Amazon RDS applies the change as soon as possible and doesn\'t cause an outage.
For an RDS Custom DB instance, don\'t enable this setting. Otherwise, the operation returns an error.
', 'ModifyDBInstanceMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren\'t copied.
This setting doesn\'t apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.
Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
Specifies whether to remove the DB instance from the Active Directory domain.
', 'ModifyDBInstanceMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
This setting doesn\'t apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$EnablePerformanceInsights' => 'Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$DeletionProtection' => 'Specifies whether the DB instance has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
This setting doesn\'t apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see ModifyDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$EnableCustomerOwnedIp' => 'Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'ModifyDBInstanceMessage$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB instance doesn\'t manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can\'t specify MasterUserPassword.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
', 'ModifyDBInstanceMessage$MultiTenant' => 'Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user name, character set, and national character set metadata with this database. The tags associated with the instance also propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the CreateTenantDatabase operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can\'t later convert back to the single-tenant configuration. When you specify this parameter, you must also specify ApplyImmediately.
Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn\'t use TLS.
', 'ModifyDBProxyRequest$DebugLogging' => 'Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
', 'ModifyEventSubscriptionMessage$Enabled' => 'Specifies whether to activate the subscription.
', 'ModifyGlobalClusterMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the global database cluster. The global database cluster can\'t be deleted when deletion protection is enabled.
', 'ModifyGlobalClusterMessage$AllowMajorVersionUpgrade' => 'Specifies whether to allow major version upgrades.
Constraints: Must be enabled if you specify a value for the EngineVersion parameter that\'s a different major version than the global cluster\'s current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
', 'OptionGroupOption$SupportsOptionVersionDowngrade' => 'If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
', 'OptionGroupOption$CopyableCrossAccount' => 'Indicates whether the option can be copied across Amazon Web Services accounts.
', 'OrderableDBInstanceOption$SupportsStorageAutoscaling' => 'Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
', 'OrderableDBInstanceOption$SupportsKerberosAuthentication' => 'Indicates whether a DB instance supports Kerberos Authentication.
', 'PendingModifiedValues$MultiAZ' => 'Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
', 'PendingModifiedValues$IAMDatabaseAuthenticationEnabled' => 'Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
', 'PendingModifiedValues$DedicatedLogVolume' => 'Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>
', 'PendingModifiedValues$MultiTenant' => 'Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
', 'RebootDBInstanceMessage$ForceFailover' => 'Specifies whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can\'t enable force failover if the instance isn\'t configured for Multi-AZ.
', 'RestoreDBClusterFromS3Message$StorageEncrypted' => 'Specifies whether the restored DB cluster is encrypted.
', 'RestoreDBClusterFromS3Message$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
', 'RestoreDBClusterFromS3Message$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB cluster. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
', 'RestoreDBClusterFromS3Message$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
', 'RestoreDBClusterFromS3Message$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB cluster. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$PubliclyAccessible' => 'Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB cluster. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$PubliclyAccessible' => 'Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB cluster isn\'t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn\'t specified, and PubliclyAccessible isn\'t specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn\'t specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
', 'RestoreDBInstanceFromDBSnapshotMessage$MultiAZ' => 'Specifies whether the DB instance is a Multi-AZ deployment.
This setting doesn\'t apply to RDS Custom.
Constraint: You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade' => 'Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
', 'RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren\'t copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromDBSnapshotMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB instance. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
', 'RestoreDBInstanceFromDBSnapshotMessage$EnableCustomerOwnedIp' => 'Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn\'t apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'RestoreDBInstanceFromDBSnapshotMessage$DedicatedLogVolume' => 'Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
', 'RestoreDBInstanceFromS3Message$MultiAZ' => 'Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can\'t set the AvailabilityZone parameter.
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
', 'RestoreDBInstanceFromS3Message$PubliclyAccessible' => 'Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'RestoreDBInstanceFromS3Message$StorageEncrypted' => 'Specifies whether the new DB instance is encrypted or not.
', 'RestoreDBInstanceFromS3Message$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
', 'RestoreDBInstanceFromS3Message$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$EnablePerformanceInsights' => 'Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
', 'RestoreDBInstanceFromS3Message$DeletionProtection' => 'Specifies whether to enable deletion protection for the DB instance. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
', 'RestoreDBInstanceFromS3Message$ManageMasterUserPassword' => 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can\'t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
', 'RestoreDBInstanceToPointInTimeMessage$MultiAZ' => 'Secifies whether the DB instance is a Multi-AZ deployment.
This setting doesn\'t apply to RDS Custom.
Constraints:
You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster\'s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster\'s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn\'t permitted if the security group assigned to the DB cluster doesn\'t permit it.
When the DB instance isn\'t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
', 'RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade' => 'Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot' => 'Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
', 'RestoreDBInstanceToPointInTimeMessage$EnableIAMDatabaseAuthentication' => 'Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn\'t enabled.
This setting doesn\'t apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$UseDefaultProcessorFeatures' => 'Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$DeletionProtection' => 'Specifies whether the DB instance has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection isn\'t enabled. For more information, see Deleting a DB Instance.
', 'RestoreDBInstanceToPointInTimeMessage$EnableCustomerOwnedIp' => 'Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn\'t apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$DedicatedLogVolume' => 'Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
', 'ScalingConfiguration$AutoPause' => 'Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it\'s idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
', 'StartActivityStreamRequest$ApplyImmediately' => 'Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
', 'StartActivityStreamRequest$EngineNativeAuditFieldsIncluded' => 'Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
', 'StartActivityStreamResponse$EngineNativeAuditFieldsIncluded' => 'Indicates whether engine-native audit fields are included in the database activity stream.
', 'StopActivityStreamRequest$ApplyImmediately' => 'Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
', 'UpgradeTarget$SupportsParallelQuery' => 'Indicates whether you can use Aurora parallel query with the target engine version.
', 'UpgradeTarget$SupportsGlobalDatabases' => 'Indicates whether you can use Aurora global databases with the target engine version.
', 'UpgradeTarget$SupportsBabelfish' => 'Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
', 'UpgradeTarget$SupportsLimitlessDatabase' => 'Indicates whether the DB engine version supports Aurora Limitless Database.
', 'UpgradeTarget$SupportsLocalWriteForwarding' => 'Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren\'t allowed on reader DB instances.
Valid for: Aurora DB clusters only
', 'UpgradeTarget$SupportsIntegrations' => 'Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'CreateCustomDBEngineVersionMessage$DatabaseInstallationFilesS3BucketName' => 'The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', ], ], 'CancelExportTaskMessage' => [ 'base' => NULL, 'refs' => [], ], 'Certificate' => [ 'base' => 'A CA certificate for an Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'refs' => [ 'CertificateList$member' => NULL, 'ModifyCertificatesResult$Certificate' => NULL, ], ], 'CertificateDetails' => [ 'base' => 'Returns the details of the DB instance’s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'refs' => [ 'ClusterPendingModifiedValues$CertificateDetails' => NULL, 'DBCluster$CertificateDetails' => NULL, 'DBInstance$CertificateDetails' => 'The details of the DB instance\'s server certificate.
', ], ], 'CertificateList' => [ 'base' => NULL, 'refs' => [ 'CertificateMessage$Certificates' => 'The list of Certificate objects for the Amazon Web Services account.
Data returned by the DescribeCertificates action.
', 'refs' => [], ], 'CertificateNotFoundFault' => [ 'base' => ' CertificateIdentifier doesn\'t refer to an existing certificate.
This data type is used as a response element in the action DescribeDBEngineVersions.
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn\'t specified.
The type of authentication the proxy uses for connections from clients.
', 'UserAuthConfigInfo$ClientPasswordAuthType' => 'The type of authentication the proxy uses for connections from clients.
', ], ], 'CloudwatchLogsExportConfiguration' => [ 'base' => 'The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
', 'refs' => [ 'ModifyDBClusterMessage$CloudwatchLogsExportConfiguration' => 'The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
', 'ModifyDBInstanceMessage$CloudwatchLogsExportConfiguration' => 'The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn\'t apply to RDS Custom DB instances.
', ], ], 'ClusterPendingModifiedValues' => [ 'base' => 'This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
', ], ], 'ConnectionPoolConfiguration' => [ 'base' => 'Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.
The settings that determine the size and behavior of the connection pool for the target group.
', ], ], 'ConnectionPoolConfigurationInfo' => [ 'base' => 'Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.
The settings that determine the size and behavior of the connection pool for the target group.
', ], ], 'ContextAttribute' => [ 'base' => 'The additional attributes of RecommendedAction data type.
The supporting attributes to explain the recommended action.
', ], ], 'CopyDBClusterParameterGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'CopyDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CopyDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'CopyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyOptionGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CopyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateBlueGreenDeploymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBlueGreenDeploymentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCustomDBEngineVersionFault' => [ 'base' => 'An error occurred while trying to create the CEV.
', 'refs' => [], ], 'CreateCustomDBEngineVersionMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBClusterParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBInstanceReadReplicaMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSecurityGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBSecurityGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBShardGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSubnetGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSubscriptionMessage' => [ 'base' => '', 'refs' => [], ], 'CreateEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateIntegrationMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateOptionGroupMessage' => [ 'base' => '', 'refs' => [], ], 'CreateOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateTenantDatabaseMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateTenantDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'CustomAvailabilityZoneNotFoundFault' => [ 'base' => ' CustomAvailabilityZoneId doesn\'t refer to an existing custom Availability Zone identifier.
A value that indicates the AMI information.
', 'refs' => [ 'DBEngineVersion$Image' => 'The EC2 image
', ], ], 'CustomDBEngineVersionAlreadyExistsFault' => [ 'base' => 'A CEV with the specified name already exists.
', 'refs' => [], ], 'CustomDBEngineVersionManifest' => [ 'base' => NULL, 'refs' => [ 'CreateCustomDBEngineVersionMessage$Manifest' => 'The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
Version of the CEV manifest. The date is in the format YYYY-MM-DD.
Ordered list of installation files for the CEV.
Ordered list of OPatch installers used for the Oracle DB engine.
The PSU and RU patches for this CEV.
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see Creating the CEV manifest in the Amazon RDS User Guide.
', 'DBEngineVersion$CustomDBEngineVersionManifest' => 'JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they\'re listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
', ], ], 'CustomDBEngineVersionNotFoundFault' => [ 'base' => 'The specified CEV was not found.
', 'refs' => [], ], 'CustomDBEngineVersionQuotaExceededFault' => [ 'base' => 'You have exceeded your CEV quota.
', 'refs' => [], ], 'CustomEngineName' => [ 'base' => NULL, 'refs' => [ 'CreateCustomDBEngineVersionMessage$Engine' => 'The database engine. RDS Custom for Oracle supports the following values:
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
The database engine. RDS Custom for Oracle supports the following values:
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
The database engine. RDS Custom for Oracle supports the following values:
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
The availability status to be assigned to the CEV. Valid values are as follows:
You can use this CEV to create a new RDS Custom DB instance.
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can\'t patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
', 'refs' => [ 'CreateDBClusterResult$DBCluster' => NULL, 'DBClusterList$member' => NULL, 'DeleteDBClusterResult$DBCluster' => NULL, 'FailoverDBClusterResult$DBCluster' => NULL, 'ModifyDBClusterResult$DBCluster' => NULL, 'PromoteReadReplicaDBClusterResult$DBCluster' => NULL, 'RebootDBClusterResult$DBCluster' => NULL, 'RestoreDBClusterFromS3Result$DBCluster' => NULL, 'RestoreDBClusterFromSnapshotResult$DBCluster' => NULL, 'RestoreDBClusterToPointInTimeResult$DBCluster' => NULL, 'StartDBClusterResult$DBCluster' => NULL, 'StopDBClusterResult$DBCluster' => NULL, ], ], 'DBClusterAlreadyExistsFault' => [ 'base' => 'The user already has a DB cluster with the given identifier.
', 'refs' => [], ], 'DBClusterAutomatedBackup' => [ 'base' => 'An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
', 'refs' => [ 'DBClusterAutomatedBackupList$member' => NULL, 'DeleteDBClusterAutomatedBackupResult$DBClusterAutomatedBackup' => NULL, ], ], 'DBClusterAutomatedBackupList' => [ 'base' => NULL, 'refs' => [ 'DBClusterAutomatedBackupMessage$DBClusterAutomatedBackups' => 'A list of DBClusterAutomatedBackup backups.
No automated backup for this DB cluster was found.
', 'refs' => [], ], 'DBClusterAutomatedBackupQuotaExceededFault' => [ 'base' => 'The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.
', 'refs' => [], ], 'DBClusterBacktrack' => [ 'base' => 'This data type is used as a response element in the DescribeDBClusterBacktracks action.
Contains a list of backtracks for the user.
', ], ], 'DBClusterBacktrackMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.
BacktrackIdentifier doesn\'t refer to an existing backtrack.
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.
The specified custom endpoint can\'t be created because it already exists.
', 'refs' => [], ], 'DBClusterEndpointList' => [ 'base' => NULL, 'refs' => [ 'DBClusterEndpointMessage$DBClusterEndpoints' => 'Contains the details of the endpoints associated with the cluster and matching any filter conditions.
', ], ], 'DBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'DBClusterEndpointNotFoundFault' => [ 'base' => 'The specified custom endpoint doesn\'t exist.
', 'refs' => [], ], 'DBClusterEndpointQuotaExceededFault' => [ 'base' => 'The cluster already has the maximum number of custom endpoints.
', 'refs' => [], ], 'DBClusterIdentifier' => [ 'base' => NULL, 'refs' => [ 'FailoverGlobalClusterMessage$TargetDbClusterIdentifier' => 'The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
', 'SwitchoverGlobalClusterMessage$TargetDbClusterIdentifier' => 'The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
', ], ], 'DBClusterList' => [ 'base' => NULL, 'refs' => [ 'DBClusterMessage$DBClusters' => 'Contains a list of DB clusters for the user.
', ], ], 'DBClusterMember' => [ 'base' => 'Contains information about an instance that is part of a DB cluster.
', 'refs' => [ 'DBClusterMemberList$member' => NULL, ], ], 'DBClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DBClusterMembers' => 'The list of DB instances that make up the DB cluster.
', ], ], 'DBClusterMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBClusters action.
DBClusterIdentifier doesn\'t refer to an existing DB cluster.
The list of option group memberships for this DB cluster.
', ], ], 'DBClusterOptionGroupStatus' => [ 'base' => 'Contains status information for a DB cluster option group.
', 'refs' => [ 'DBClusterOptionGroupMemberships$member' => NULL, ], ], 'DBClusterParameterGroup' => [ 'base' => 'Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups action.
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
', 'refs' => [], ], 'DBClusterParameterGroupList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupsMessage$DBClusterParameterGroups' => 'A list of DB cluster parameter groups.
', ], ], 'DBClusterParameterGroupNameMessage' => [ 'base' => '', 'refs' => [], ], 'DBClusterParameterGroupNotFoundFault' => [ 'base' => ' DBClusterParameterGroupName doesn\'t refer to an existing DB cluster parameter group.
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
', 'refs' => [], ], 'DBClusterRole' => [ 'base' => 'Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
', 'refs' => [ 'DBClusterRoles$member' => NULL, ], ], 'DBClusterRoleAlreadyExistsFault' => [ 'base' => 'The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
', 'refs' => [], ], 'DBClusterRoleNotFoundFault' => [ 'base' => 'The specified IAM role Amazon Resource Name (ARN) isn\'t associated with the specified DB cluster.
', 'refs' => [], ], 'DBClusterRoleQuotaExceededFault' => [ 'base' => 'You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
', 'refs' => [], ], 'DBClusterRoles' => [ 'base' => NULL, 'refs' => [ 'DBCluster$AssociatedRoles' => 'A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
', ], ], 'DBClusterSnapshot' => [ 'base' => 'Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
The user already has a DB cluster snapshot with the given identifier.
', 'refs' => [], ], 'DBClusterSnapshotAttribute' => [ 'base' => 'Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The list of attributes and values for the manual DB cluster snapshot.
', ], ], 'DBClusterSnapshotAttributesResult' => [ 'base' => 'Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
Provides a list of DB cluster snapshots for the user.
', ], ], 'DBClusterSnapshotMessage' => [ 'base' => 'Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
DBClusterSnapshotIdentifier doesn\'t refer to an existing DB cluster snapshot.
Reserved for future use.
', 'refs' => [ 'DBClusterStatusInfoList$member' => NULL, ], ], 'DBClusterStatusInfoList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$StatusInfos' => 'Reserved for future use.
', ], ], 'DBEngineVersion' => [ 'base' => 'This data type is used as a response element in the action DescribeDBEngineVersions.
A list of DBEngineVersion elements.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
The user already has a DB instance with the given identifier.
', 'refs' => [], ], 'DBInstanceAutomatedBackup' => [ 'base' => 'An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
', 'refs' => [ 'DBInstanceAutomatedBackupList$member' => NULL, 'DeleteDBInstanceAutomatedBackupResult$DBInstanceAutomatedBackup' => NULL, 'StartDBInstanceAutomatedBackupsReplicationResult$DBInstanceAutomatedBackup' => NULL, 'StopDBInstanceAutomatedBackupsReplicationResult$DBInstanceAutomatedBackup' => NULL, ], ], 'DBInstanceAutomatedBackupList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceAutomatedBackupMessage$DBInstanceAutomatedBackups' => 'A list of DBInstanceAutomatedBackup instances.
Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.
No automated backup for this DB instance was found.
', 'refs' => [], ], 'DBInstanceAutomatedBackupQuotaExceededFault' => [ 'base' => 'The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
', 'refs' => [], ], 'DBInstanceAutomatedBackupsReplication' => [ 'base' => 'Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
', 'refs' => [ 'DBInstanceAutomatedBackupsReplicationList$member' => NULL, ], ], 'DBInstanceAutomatedBackupsReplicationList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$DBInstanceAutomatedBackupsReplications' => 'The list of replicated automated backups associated with the DB instance.
', 'DBInstanceAutomatedBackup$DBInstanceAutomatedBackupsReplications' => 'The list of replications to different Amazon Web Services Regions associated with the automated backup.
', ], ], 'DBInstanceList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceMessage$DBInstances' => 'A list of DBInstance instances.
Contains the result of a successful invocation of the DescribeDBInstances action.
DBInstanceIdentifier doesn\'t refer to an existing DB instance.
Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
', 'refs' => [ 'DBInstanceRoles$member' => NULL, ], ], 'DBInstanceRoleAlreadyExistsFault' => [ 'base' => 'The specified RoleArn or FeatureName value is already associated with the DB instance.
The specified RoleArn value doesn\'t match the specified feature for the DB instance.
You can\'t associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
', 'refs' => [], ], 'DBInstanceRoles' => [ 'base' => NULL, 'refs' => [ 'DBInstance$AssociatedRoles' => 'The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
', ], ], 'DBInstanceStatusInfo' => [ 'base' => 'Provides a list of status information for a DB instance.
', 'refs' => [ 'DBInstanceStatusInfoList$member' => NULL, ], ], 'DBInstanceStatusInfoList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$StatusInfos' => 'The status of a read replica. If the DB instance isn\'t a read replica, the value is blank.
', ], ], 'DBLogFileNotFoundFault' => [ 'base' => ' LogFileName doesn\'t refer to an existing DB log file.
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups action.
A DB parameter group with the same name exists.
', 'refs' => [], ], 'DBParameterGroupDetails' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBParameters action.
A list of DBParameterGroup instances.
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup operation.
DBParameterGroupName doesn\'t refer to an existing DB parameter group.
The request would result in the user exceeding the allowed number of DB parameter groups.
', 'refs' => [], ], 'DBParameterGroupStatus' => [ 'base' => 'The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
The list of DB parameter groups applied to this DB instance.
', ], ], 'DBParameterGroupsMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBParameterGroups action.
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies action.
The DBProxy structure corresponding to the new proxy.
The data structure representing the details of the DB proxy that you delete.
', 'ModifyDBProxyResponse$DBProxy' => 'The DBProxy object representing the new settings for the proxy.
The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyEndpoint' => [ 'base' => 'The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
This data type is used as a response element in the DescribeDBProxyEndpoints operation.
The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy\'s default VPC.
The data structure representing the details of the DB proxy endpoint that you delete.
', 'ModifyDBProxyEndpointResponse$DBProxyEndpoint' => 'The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyEndpointList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBProxyEndpointsResponse$DBProxyEndpoints' => 'The list of ProxyEndpoint objects returned by the API operation.
The name of the DB proxy endpoint to create.
', 'DeleteDBProxyEndpointRequest$DBProxyEndpointName' => 'The name of the DB proxy endpoint to delete.
', 'DescribeDBProxyEndpointsRequest$DBProxyEndpointName' => 'The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.
', 'ModifyDBProxyEndpointRequest$DBProxyEndpointName' => 'The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
', 'ModifyDBProxyEndpointRequest$NewDBProxyEndpointName' => 'The new identifier for the DBProxyEndpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
The DB proxy endpoint doesn\'t exist.
', 'refs' => [], ], 'DBProxyEndpointQuotaExceededFault' => [ 'base' => 'The DB proxy already has the maximum number of endpoints.
', 'refs' => [], ], 'DBProxyEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'DBProxyEndpoint$Status' => 'The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
', ], ], 'DBProxyList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBProxiesResponse$DBProxies' => 'A return value representing an arbitrary number of DBProxy data structures.
The name of the DB proxy associated with the DB proxy endpoint that you create.
', 'DescribeDBProxyEndpointsRequest$DBProxyName' => 'The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.
', ], ], 'DBProxyNotFoundFault' => [ 'base' => 'The specified proxy name doesn\'t correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyQuotaExceededFault' => [ 'base' => 'Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyStatus' => [ 'base' => NULL, 'refs' => [ 'DBProxy$Status' => 'The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
', 'refs' => [], ], 'DBProxyTargetGroup' => [ 'base' => 'Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.
This data type is used as a response element in the DescribeDBProxyTargetGroups action.
The settings of the modified DBProxyTarget.
The specified target group isn\'t available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBProxyTargetNotFoundFault' => [ 'base' => 'The specified RDS DB instance or Aurora DB cluster isn\'t available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBRecommendation' => [ 'base' => 'The recommendation for your DB instances, DB clusters, and DB parameter groups.
', 'refs' => [ 'DBRecommendationList$member' => NULL, 'DBRecommendationMessage$DBRecommendation' => NULL, ], ], 'DBRecommendationList' => [ 'base' => NULL, 'refs' => [ 'DBRecommendationsMessage$DBRecommendations' => 'A list of recommendations which is returned from DescribeDBRecommendations API request.
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the DescribeDBSecurityGroups action.
A DB security group with the name specified in DBSecurityGroupName already exists.
This data type is used as a response element in the following actions:
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
If the option requires access to a port, then this DB security group allows access to the port.
', ], ], 'DBSecurityGroupMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
A list of DB security groups to authorize on this DB instance. Changing this setting doesn\'t result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB security groups.
A list of DBSecurityGroupMembership name strings used for this option.
', 'RestoreDBInstanceFromS3Message$DBSecurityGroups' => 'A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
', ], ], 'DBSecurityGroupNotFoundFault' => [ 'base' => ' DBSecurityGroupName doesn\'t refer to an existing DB security group.
A DB security group isn\'t allowed for this action.
', 'refs' => [], ], 'DBSecurityGroupQuotaExceededFault' => [ 'base' => 'The request would result in the user exceeding the allowed number of DB security groups.
', 'refs' => [], ], 'DBSecurityGroups' => [ 'base' => NULL, 'refs' => [ 'DBSecurityGroupMessage$DBSecurityGroups' => 'A list of DBSecurityGroup instances.
The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
', 'refs' => [], ], 'DBShardGroupIdentifier' => [ 'base' => NULL, 'refs' => [ 'DBShardGroup$DBShardGroupIdentifier' => 'The name of the DB shard group.
', 'DeleteDBShardGroupMessage$DBShardGroupIdentifier' => 'Teh name of the DB shard group to delete.
', 'DescribeDBShardGroupsMessage$DBShardGroupIdentifier' => 'The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match an existing DB shard group identifier.
The name of the DB shard group to modify.
', 'RebootDBShardGroupMessage$DBShardGroupIdentifier' => 'The name of the DB shard group to reboot.
', ], ], 'DBShardGroupNotFoundFault' => [ 'base' => 'The specified DB shard group name wasn\'t found.
', 'refs' => [], ], 'DBShardGroupsList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBShardGroupsResponse$DBShardGroups' => 'Contains a list of DB shard groups for the user.
', ], ], 'DBSnapshot' => [ 'base' => 'Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier is already used by an existing snapshot.
Contains the name and values of a manual DB snapshot attribute
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.
The list of attributes and values for the manual DB snapshot.
', ], ], 'DBSnapshotAttributesResult' => [ 'base' => 'Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
A list of DBSnapshot instances.
Contains the result of a successful invocation of the DescribeDBSnapshots action.
DBSnapshotIdentifier doesn\'t refer to an existing DB snapshot.
Contains the details of a tenant database in a snapshot of a DB instance.
', 'refs' => [ 'DBSnapshotTenantDatabasesList$member' => NULL, ], ], 'DBSnapshotTenantDatabaseNotFoundFault' => [ 'base' => 'The specified snapshot tenant database wasn\'t found.
', 'refs' => [], ], 'DBSnapshotTenantDatabasesList' => [ 'base' => NULL, 'refs' => [ 'DBSnapshotTenantDatabasesMessage$DBSnapshotTenantDatabases' => 'A list of DB snapshot tenant databases.
', ], ], 'DBSnapshotTenantDatabasesMessage' => [ 'base' => NULL, 'refs' => [], ], 'DBSubnetGroup' => [ 'base' => 'Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
', 'DBSubnetGroups$member' => NULL, 'ModifyDBSubnetGroupResult$DBSubnetGroup' => NULL, ], ], 'DBSubnetGroupAlreadyExistsFault' => [ 'base' => ' DBSubnetGroupName is already used by an existing DB subnet group.
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
', 'refs' => [], ], 'DBSubnetGroupMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
The DBSubnetGroup shouldn\'t be specified while creating read replicas that lie in the same region as the source instance.
', 'refs' => [], ], 'DBSubnetGroupNotFoundFault' => [ 'base' => ' DBSubnetGroupName doesn\'t refer to an existing DB subnet group.
The request would result in the user exceeding the allowed number of DB subnet groups.
', 'refs' => [], ], 'DBSubnetGroups' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroupMessage$DBSubnetGroups' => 'A list of DBSubnetGroup instances.
The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
', 'refs' => [], ], 'DBUpgradeDependencyFailureFault' => [ 'base' => 'The DB upgrade failed because a resource the DB depends on can\'t be modified.
', 'refs' => [], ], 'DataFilter' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$DataFilter' => 'Data filtering options for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift.
Valid for: Integrations with Aurora MySQL source DB clusters only
', 'Integration$DataFilter' => 'Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
', 'ModifyIntegrationMessage$DataFilter' => 'A new data filter for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift.
', ], ], 'DatabaseArn' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$Source' => 'The source database for the blue/green deployment.
Before switchover, the source database is the production database in the blue environment.
', 'BlueGreenDeployment$Target' => 'The target database for the blue/green deployment.
Before switchover, the target database is the clone database in the green environment.
', 'CreateBlueGreenDeploymentRequest$Source' => 'The Amazon Resource Name (ARN) of the source production database.
Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.
', 'SwitchoverDetail$SourceMember' => 'The Amazon Resource Name (ARN) of a resource in the blue environment.
', 'SwitchoverDetail$TargetMember' => 'The Amazon Resource Name (ARN) of a resource in the green environment.
', ], ], 'DeleteBlueGreenDeploymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBlueGreenDeploymentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomDBEngineVersionMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterAutomatedBackupMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterAutomatedBackupResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'DeleteDBClusterParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'DeleteDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'DeleteDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBInstanceAutomatedBackupMessage' => [ 'base' => 'Parameter input for the DeleteDBInstanceAutomatedBackup operation.
Parameter input for DescribeDBInstanceAutomatedBackups.
', 'refs' => [], ], 'DescribeDBInstancesMessage' => [ 'base' => '', 'refs' => [], ], 'DescribeDBLogFilesDetails' => [ 'base' => 'This data type is used as a response element to DescribeDBLogFiles.
The DB log files returned.
', ], ], 'DescribeDBLogFilesMessage' => [ 'base' => '', 'refs' => [], ], 'DescribeDBLogFilesResponse' => [ 'base' => 'The response from a call to DescribeDBLogFiles.
An optional description of your CEV.
', 'ModifyCustomDBEngineVersionMessage$Description' => 'An optional description of your CEV.
', ], ], 'DisableHttpEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisableHttpEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DocLink' => [ 'base' => 'A link to documentation that provides additional information for a recommendation.
', 'refs' => [ 'DocLinkList$member' => NULL, ], ], 'DocLinkList' => [ 'base' => NULL, 'refs' => [ 'DBRecommendation$Links' => 'A link to documentation that provides additional information about the recommendation.
', ], ], 'DomainMembership' => [ 'base' => 'An Active Directory Domain membership record associated with the DB instance or cluster.
', 'refs' => [ 'DomainMembershipList$member' => NULL, ], ], 'DomainMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DomainMemberships' => 'The Active Directory Domain membership records associated with the DB cluster.
', 'DBInstance$DomainMemberships' => 'The Active Directory Domain membership records associated with the DB instance.
', ], ], 'DomainNotFoundFault' => [ 'base' => ' Domain doesn\'t refer to an existing Active Directory domain.
The minimum value in the range.
', 'DoubleRange$To' => 'The maximum value in the range.
', 'RecurringCharge$RecurringChargeAmount' => 'The amount of the recurring charge.
', 'ReservedDBInstance$FixedPrice' => 'The fixed price charged for this reserved DB instance.
', 'ReservedDBInstance$UsagePrice' => 'The hourly price charged for this reserved DB instance.
', 'ReservedDBInstancesOffering$FixedPrice' => 'The fixed price charged for this offering.
', 'ReservedDBInstancesOffering$UsagePrice' => 'The hourly price charged for this offering.
', 'ScalarReferenceDetails$Value' => 'The value of a scalar reference.
', ], ], 'DoubleOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBShardGroupMessage$MaxACU' => 'The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
', 'DBShardGroup$MaxACU' => 'The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
', 'LimitlessDatabase$MinRequiredACU' => 'The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).
', 'ModifyDBShardGroupMessage$MaxACU' => 'The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
', 'OrderableDBInstanceOption$MinIopsPerGib' => 'Minimum provisioned IOPS per GiB for a DB instance.
', 'OrderableDBInstanceOption$MaxIopsPerGib' => 'Maximum provisioned IOPS per GiB for a DB instance.
', 'OrderableDBInstanceOption$MinStorageThroughputPerIops' => 'Minimum storage throughput to provisioned IOPS ratio for a DB instance.
', 'OrderableDBInstanceOption$MaxStorageThroughputPerIops' => 'Maximum storage throughput to provisioned IOPS ratio for a DB instance.
', 'ServerlessV2ScalingConfiguration$MinCapacity' => 'The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
', 'ServerlessV2ScalingConfiguration$MaxCapacity' => 'The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
', 'ServerlessV2ScalingConfigurationInfo$MinCapacity' => 'The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
', 'ServerlessV2ScalingConfigurationInfo$MaxCapacity' => 'The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
', ], ], 'DoubleRange' => [ 'base' => 'A range of double values.
', 'refs' => [ 'DoubleRangeList$member' => NULL, ], ], 'DoubleRangeList' => [ 'base' => NULL, 'refs' => [ 'ValidStorageOptions$IopsToStorageRatio' => 'The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
', 'ValidStorageOptions$StorageThroughputToIopsRatio' => 'The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.
', ], ], 'DownloadDBLogFilePortionDetails' => [ 'base' => 'This data type is used as a response element to DownloadDBLogFilePortion.
This data type is used as a response element in the following actions:
AuthorizeDBSecurityGroupIngress
DescribeDBSecurityGroups
RevokeDBSecurityGroupIngress
Contains a list of EC2SecurityGroup elements.
The AMI configuration prerequisite has not been met.
', 'refs' => [], ], 'EnableHttpEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'EnableHttpEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'EncryptionContextMap' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$AdditionalEncryptionContext' => 'An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
You can only include this parameter if you specify the KMSKeyId parameter.
The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
', ], ], 'Endpoint' => [ 'base' => 'This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
CreateDBInstance
DescribeDBInstances
DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
The listener connection endpoint for SQL Server Always On.
', ], ], 'EngineDefaults' => [ 'base' => 'Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.
A list of the supported DB engine modes.
', 'OrderableDBInstanceOption$SupportedEngineModes' => 'A list of the supported DB engine modes.
', 'Parameter$SupportedEngineModes' => 'The valid DB engine modes.
', 'UpgradeTarget$SupportedEngineModes' => 'A list of the supported DB engine modes for the target engine version.
', ], ], 'Event' => [ 'base' => 'This data type is used as a response element in the DescribeEvents action.
', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventCategoriesList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$EventCategories' => 'A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.
A list of event categories that trigger notifications for a event notification subscription.
', 'Event$EventCategories' => 'Specifies the category for the event.
', 'EventCategoriesMap$EventCategories' => 'The event categories for the specified source type
', 'EventSubscription$EventCategoriesList' => 'A list of event categories for the RDS event notification subscription.
', 'ModifyEventSubscriptionMessage$EventCategories' => 'A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
Contains the results of a successful invocation of the DescribeEventCategories operation.
', 'refs' => [ 'EventCategoriesMapList$member' => NULL, ], ], 'EventCategoriesMapList' => [ 'base' => NULL, 'refs' => [ 'EventCategoriesMessage$EventCategoriesMapList' => 'A list of EventCategoriesMap data types.
Data returned from the DescribeEventCategories operation.
A list of Event instances.
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
You have reached the maximum number of event subscriptions.
', 'refs' => [], ], 'EventSubscriptionsList' => [ 'base' => NULL, 'refs' => [ 'EventSubscriptionsMessage$EventSubscriptionsList' => 'A list of EventSubscriptions data types.
', ], ], 'EventSubscriptionsMessage' => [ 'base' => 'Data returned by the DescribeEventSubscriptions action.
', 'refs' => [], ], 'EventsMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeEvents action.
The type of source for the export.
', 'ExportTask$SourceType' => 'The type of source for the export.
', ], ], 'ExportTask' => [ 'base' => 'Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks operation.
You can\'t start an export task that\'s already running.
', 'refs' => [], ], 'ExportTaskNotFoundFault' => [ 'base' => 'The export task doesn\'t exist.
', 'refs' => [], ], 'ExportTasksList' => [ 'base' => NULL, 'refs' => [ 'ExportTasksMessage$ExportTasks' => 'Information about an export of a snapshot or cluster to Amazon S3.
', ], ], 'ExportTasksMessage' => [ 'base' => NULL, 'refs' => [], ], 'FailoverDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'FailoverDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'FailoverGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'FailoverGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'FailoverState' => [ 'base' => 'Contains the state of scheduled or in-process operations on a global cluster (Aurora global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Aurora global database.
', 'refs' => [ 'GlobalCluster$FailoverState' => 'A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster\'s primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribeDBShardGroups
DescribePendingMaintenanceActions
A filter that specifies one or more blue/green deployments to describe.
Valid Values:
blue-green-deployment-identifier - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.
blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.
source - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.
target - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.
This parameter isn\'t currently supported.
', 'DescribeDBClusterAutomatedBackupsMessage$Filters' => 'A filter that specifies which resources to return based on status.
Supported filters are the following:
status
retained - Automated backups for deleted clusters and after backup replication is stopped.
db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs.
db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
', 'DescribeDBClusterBacktracksMessage$Filters' => 'A filter that specifies one or more DB clusters to describe. Supported filters include the following:
db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.
db-cluster-backtrack-status - Accepts any of the following backtrack status values:
applying
completed
failed
pending
The results list includes information about only the backtracks identified by these values.
A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.
This parameter isn\'t currently supported.
', 'DescribeDBClusterParametersMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeDBClusterSnapshotsMessage$Filters' => 'A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
snapshot-type - Accepts types of DB cluster snapshots.
engine - Accepts names of database engines.
A filter that specifies one or more DB clusters to describe.
Supported Filters:
clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
available
deprecated
A filter that specifies which resources to return based on status.
Supported filters are the following:
status
active - Automated backups for current instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
retained - Automated backups for deleted instances and after backup replication is stopped.
db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.
dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
', 'DescribeDBInstancesMessage$Filters' => 'A filter that specifies one or more DB instances to describe.
Supported Filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.
dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
This parameter isn\'t currently supported.
', 'DescribeDBParameterGroupsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeDBParametersMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeDBProxiesRequest$Filters' => 'This parameter is not currently supported.
', 'DescribeDBProxyEndpointsRequest$Filters' => 'This parameter is not currently supported.
', 'DescribeDBProxyTargetGroupsRequest$Filters' => 'This parameter is not currently supported.
', 'DescribeDBProxyTargetsRequest$Filters' => 'This parameter is not currently supported.
', 'DescribeDBRecommendationsMessage$Filters' => 'A filter that specifies one or more recommendations to describe.
Supported Filters:
recommendation-id - Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values.
status - Accepts a list of recommendation statuses.
Valid values:
active - The recommendations which are ready for you to apply.
pending - The applied or scheduled recommendations which are in progress.
resolved - The recommendations which are completed.
dismissed - The recommendations that you dismissed.
The results list only includes the recommendations whose status is one of the specified filter values.
severity - Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.
Valid values:
high
medium
low
informational
type-id - Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values.
dbi-resource-id - Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases.
cluster-resource-id - Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters.
pg-arn - Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups.
cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
This parameter isn\'t currently supported.
', 'DescribeDBShardGroupsMessage$Filters' => 'A filter that specifies one or more DB shard groups to describe.
', 'DescribeDBSnapshotTenantDatabasesMessage$Filters' => 'A filter that specifies one or more tenant databases to describe.
Supported filters:
tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.
dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
snapshot-type - Accepts types of DB snapshots.
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
dbi-resource-id - Accepts identifiers of source DB instances.
snapshot-type - Accepts types of DB snapshots.
engine - Accepts names of database engines.
This parameter isn\'t currently supported.
', 'DescribeEngineDefaultClusterParametersMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeEngineDefaultParametersMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeEventCategoriesMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeEventSubscriptionsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeEventsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeExportTasksMessage$Filters' => 'Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.
Supported filters include the following:
export-task-identifier - An identifier for the snapshot or cluster export task.
s3-bucket - The Amazon S3 bucket the data is exported to.
source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
status - The status of the export task. Must be lowercase. Valid statuses are the following:
canceled
canceling
complete
failed
in_progress
starting
A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.
Currently, the only supported filter is region.
If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.
', 'DescribeIntegrationsMessage$Filters' => 'A filter that specifies one or more resources to return.
', 'DescribeOptionGroupOptionsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeOptionGroupsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeOrderableDBInstanceOptionsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribePendingMaintenanceActionsMessage$Filters' => 'A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.
This parameter isn\'t currently supported.
', 'DescribeReservedDBInstancesOfferingsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeSourceRegionsMessage$Filters' => 'This parameter isn\'t currently supported.
', 'DescribeTenantDatabasesMessage$Filters' => 'A filter that specifies one or more database tenants to describe.
Supported filters:
tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
tenant-database-resource-id - Tenant database resource identifiers.
dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.
This parameter isn\'t currently supported.
', ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => 'One or more filter values. Filter values are case-sensitive.
', ], ], 'GlobalCluster' => [ 'base' => 'A data type representing an Aurora global database.
', 'refs' => [ 'CreateGlobalClusterResult$GlobalCluster' => NULL, 'DeleteGlobalClusterResult$GlobalCluster' => NULL, 'FailoverGlobalClusterResult$GlobalCluster' => NULL, 'GlobalClusterList$member' => NULL, 'ModifyGlobalClusterResult$GlobalCluster' => NULL, 'RemoveFromGlobalClusterResult$GlobalCluster' => NULL, 'SwitchoverGlobalClusterResult$GlobalCluster' => NULL, ], ], 'GlobalClusterAlreadyExistsFault' => [ 'base' => 'The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.
The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it\'s the name of the Aurora global database.
Constraints:
Must match the identifier of an existing global database cluster.
The identifier of the global database cluster to switch over. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster (Aurora global database).
The list of global clusters returned by this request.
', ], ], 'GlobalClusterMember' => [ 'base' => 'A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database).
', 'refs' => [ 'GlobalClusterMemberList$member' => NULL, ], ], 'GlobalClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'GlobalCluster$GlobalClusterMembers' => 'The list of primary and secondary clusters within the global database cluster.
', ], ], 'GlobalClusterMemberSynchronizationStatus' => [ 'base' => NULL, 'refs' => [ 'GlobalClusterMember$SynchronizationStatus' => 'The status of synchronization of each Aurora DB cluster in the global cluster.
', ], ], 'GlobalClusterNotFoundFault' => [ 'base' => 'The GlobalClusterIdentifier doesn\'t refer to an existing global database cluster.
The number of global database clusters for this account is already at the maximum allowed.
', 'refs' => [], ], 'GlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'IAMAuthMode' => [ 'base' => NULL, 'refs' => [ 'UserAuthConfig$IAMAuth' => 'A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
This data type is used as a response element in the DescribeDBSecurityGroups action.
Contains a list of IPRange elements.
The IAM role requires additional permissions to export to an Amazon S3 bucket.
', 'refs' => [], ], 'IamRoleNotFoundFault' => [ 'base' => 'The IAM role is missing for exporting to an Amazon S3 bucket.
', 'refs' => [], ], 'InstanceQuotaExceededFault' => [ 'base' => 'The request would result in the user exceeding the allowed number of DB instances.
', 'refs' => [], ], 'InsufficientAvailableIPsInSubnetFault' => [ 'base' => 'The requested operation can\'t be performed because there aren\'t enough available IP addresses in the proxy\'s subnets. Add more CIDR blocks to the VPC or remove IP address that aren\'t required from the subnets.
', 'refs' => [], ], 'InsufficientDBClusterCapacityFault' => [ 'base' => 'The DB cluster doesn\'t have enough capacity for the current operation.
', 'refs' => [], ], 'InsufficientDBInstanceCapacityFault' => [ 'base' => 'The specified DB instance class isn\'t available in the specified Availability Zone.
', 'refs' => [], ], 'InsufficientStorageClusterCapacityFault' => [ 'base' => 'There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ConnectionPoolConfigurationInfo$MaxConnectionsPercent' => 'The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
', 'DBClusterAutomatedBackup$AllocatedStorage' => 'For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn\'t fixed, but instead automatically adjusts as needed.
The port number that the automated backup used for connections.
Default: Inherits from the source DB cluster
Valid Values: 1150-65535
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
', 'DBClusterSnapshot$Port' => 'The port that the DB cluster was listening on at the time of the snapshot.
', 'DBClusterSnapshot$PercentProgress' => 'The percentage of the estimated data that has been transferred.
', 'DBInstance$AllocatedStorage' => 'The amount of storage in gibibytes (GiB) allocated for the DB instance.
', 'DBInstance$BackupRetentionPeriod' => 'The number of days for which automatic DB snapshots are retained.
', 'DBInstance$DbInstancePort' => 'The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
', 'DBInstanceAutomatedBackup$AllocatedStorage' => 'The allocated storage size for the the automated backup in gibibytes (GiB).
', 'DBInstanceAutomatedBackup$Port' => 'The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
', 'DBProxyTarget$Port' => 'The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
', 'DBSnapshot$AllocatedStorage' => 'Specifies the allocated storage size in gibibytes (GiB).
', 'DBSnapshot$Port' => 'Specifies the port that the database engine was listening on at the time of the snapshot.
', 'DBSnapshot$PercentProgress' => 'The percentage of the estimated data that has been transferred.
', 'DownloadDBLogFilePortionMessage$NumberOfLines' => 'The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
If NumberOfLines is specified and Marker isn\'t specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
Specifies the port that the database engine is listening on.
', 'ExportTask$PercentProgress' => 'The progress of the snapshot or cluster export task as a percentage.
', 'ExportTask$TotalExtractedDataInGB' => 'The total amount of data exported, in gigabytes.
', 'PerformanceInsightsMetricDimensionGroup$Limit' => 'The maximum number of items to fetch for this dimension group.
', 'Range$From' => 'The minimum value in the range.
', 'Range$To' => 'The maximum value in the range.
', 'ReservedDBInstance$Duration' => 'The duration of the reservation in seconds.
', 'ReservedDBInstance$DBInstanceCount' => 'The number of reserved DB instances.
', 'ReservedDBInstancesOffering$Duration' => 'The duration of the offering in seconds.
', ], ], 'IntegerOptional' => [ 'base' => NULL, 'refs' => [ 'ClusterPendingModifiedValues$BackupRetentionPeriod' => 'The number of days for which automatic DB snapshots are retained.
', 'ClusterPendingModifiedValues$AllocatedStorage' => 'The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn\'t fixed, but instead automatically adjusts as needed.
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
', 'ConnectionPoolConfiguration$MaxConnectionsPercent' => 'The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints:
Must be between 1 and 100.
A value that controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn\'t specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.
Constraints:
Must be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions. For an unlimited wait time, specify 0.
Default: 120
Constraints:
Must be between 0 and 3600.
The number of days for which automated backups are retained.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
The port number on which the instances in the DB cluster accept connections.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: 1150-65535
Default:
RDS for MySQL and Aurora MySQL - 3306
RDS for PostgreSQL and Aurora PostgreSQL - 5432
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
This setting is required to create a Multi-AZ DB cluster.
', 'CreateDBClusterMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS issues an error.
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
This setting doesn\'t apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Provisioned IOPS storage (io1, io2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3):
Enterprise and Standard editions: Must be an integer from 20 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1, io2):
Enterprise and Standard editions: Must be an integer from 100 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 20 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
This setting doesn\'t apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can\'t be set to 0 if the DB instance is a source to read replicas.
Can\'t be set to 0 for an RDS Custom for Oracle DB instance.
The port number on which the database accepts connections.
This setting doesn\'t apply to Aurora DB instances. The port number is managed by the cluster.
Valid Values: 1150-65535
Default:
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can\'t be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.
This setting doesn\'t apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Constraints:
For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
The number of days to retain Performance Insights data.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS returns an error.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (Storage is managed by the DB cluster.)
RDS Custom
The storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$Port' => 'The port number that the DB instance uses for connections.
Valid Values: 1150-65535
Default: Inherits the value from the source DB instance.
', 'CreateDBInstanceReadReplicaMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
', 'CreateDBInstanceReadReplicaMessage$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
The number of days to retain Performance Insights data.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS returns an error.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
', 'CreateDBInstanceReadReplicaMessage$StorageThroughput' => 'Specifies the storage throughput value for the read replica.
This setting doesn\'t apply to RDS Custom or Amazon Aurora DB instances.
', 'CreateDBInstanceReadReplicaMessage$AllocatedStorage' => 'The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
', 'CreateDBShardGroupMessage$ComputeRedundancy' => 'Specifies whether to create standby instances for the DB shard group. Valid values are the following:
0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.
1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.
2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn\'t fixed, but instead automatically adjusts as needed.
The number of days for which automatic DB snapshots are retained.
', 'DBCluster$Port' => 'The port that the database engine is listening on.
', 'DBCluster$Capacity' => 'The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
', 'DBCluster$Iops' => 'The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$PerformanceInsightsRetentionPeriod' => 'The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterAutomatedBackup$BackupRetentionPeriod' => 'The retention period for the automated backups.
', 'DBClusterAutomatedBackup$Iops' => 'The IOPS (I/O operations per second) value for the automated backup.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterAutomatedBackup$StorageThroughput' => 'The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterCapacityInfo$PendingCapacity' => 'A value that specifies the capacity that the DB cluster scales to next.
', 'DBClusterCapacityInfo$CurrentCapacity' => 'The current capacity of the DB cluster.
', 'DBClusterCapacityInfo$SecondsBeforeTimeout' => 'The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
', 'DBClusterSnapshot$StorageThroughput' => 'The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBInstance$Iops' => 'The Provisioned IOPS (I/O operations per second) value for the DB instance.
', 'DBInstance$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
', 'DBInstance$PromotionTier' => 'The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
', 'DBInstance$PerformanceInsightsRetentionPeriod' => 'The number of days to retain Performance Insights data.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
', 'DBInstance$StorageThroughput' => 'The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
The IOPS (I/O operations per second) value for the automated backup.
', 'DBInstanceAutomatedBackup$BackupRetentionPeriod' => 'The retention period for the automated backups.
', 'DBInstanceAutomatedBackup$StorageThroughput' => 'The storage throughput for the automated backup.
', 'DBShardGroup$ComputeRedundancy' => 'Specifies whether to create standby instances for the DB shard group. Valid values are the following:
0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.
1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.
2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
', 'DBSnapshot$StorageThroughput' => 'Specifies the storage throughput for the DB snapshot.
', 'DescribeCertificatesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterAutomatedBackupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterEndpointsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterParameterGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClusterSnapshotsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBClustersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100
', 'DescribeDBEngineVersionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBInstanceAutomatedBackupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBLogFilesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
', 'DescribeDBParameterGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBRecommendationsMessage$MaxRecords' => 'The maximum number of recommendations to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBSnapshotTenantDatabasesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBSubnetGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeEngineDefaultClusterParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeEngineDefaultParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeEventSubscriptionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeEventsMessage$Duration' => 'The number of minutes to retrieve events for.
Default: 60
', 'DescribeEventsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeGlobalClustersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeIntegrationsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeOptionGroupOptionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeOptionGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeOrderableDBInstanceOptionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 1000.
', 'DescribePendingMaintenanceActionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeReservedDBInstancesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeReservedDBInstancesOfferingsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeSourceRegionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeTenantDatabasesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
', 'ModifyDBClusterMessage$BackupRetentionPeriod' => 'The number of days for which automated backups are retained. Specify a minimum value of 1.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
', 'ModifyDBClusterMessage$AllocatedStorage' => 'The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS issues an error.
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see CreateDBInstance.
Constraints:
When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3, io1, or io2 storage type), you must also specify the Iops parameter. You can use the current value for Iops.
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
This setting doesn\'t apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35.
Can\'t be set to 0 if the DB instance is a source to read replicas.
Can\'t be set to 0 for an RDS Custom for Oracle DB instance.
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn\'t result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints:
For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
When you increase the Provisioned IOPS, you must also specify the AllocatedStorage parameter. You can use the current value for AllocatedStorage.
Default: Uses existing setting
', 'ModifyDBInstanceMessage$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can\'t be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
The number of days to retain Performance Insights data.
This setting doesn\'t apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn\'t valid, such as 94, Amazon RDS returns an error.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$ResumeFullAutomationModeMinutes' => 'The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 1,440.
The storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'ModifyDBProxyRequest$IdleClientTimeout' => 'The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
', 'Option$Port' => 'If required, the port configured for this option to use.
', 'OptionConfiguration$Port' => 'The optional port for the option.
', 'OptionGroupOption$DefaultPort' => 'If the option requires a port, specifies the default port for the option.
', 'OrderableDBInstanceOption$MinStorageSize' => 'Minimum storage size for a DB instance.
', 'OrderableDBInstanceOption$MaxStorageSize' => 'Maximum storage size for a DB instance.
', 'OrderableDBInstanceOption$MinIopsPerDbInstance' => 'Minimum total provisioned IOPS for a DB instance.
', 'OrderableDBInstanceOption$MaxIopsPerDbInstance' => 'Maximum total provisioned IOPS for a DB instance.
', 'OrderableDBInstanceOption$MinStorageThroughputPerDbInstance' => 'Minimum storage throughput for a DB instance.
', 'OrderableDBInstanceOption$MaxStorageThroughputPerDbInstance' => 'Maximum storage throughput for a DB instance.
', 'PendingModifiedValues$AllocatedStorage' => 'The allocated storage size for the DB instance specified in gibibytes (GiB).
', 'PendingModifiedValues$Port' => 'The port for the DB instance.
', 'PendingModifiedValues$BackupRetentionPeriod' => 'The number of days for which automated backups are retained.
', 'PendingModifiedValues$Iops' => 'The Provisioned IOPS value for the DB instance.
', 'PendingModifiedValues$StorageThroughput' => 'The storage throughput of the DB instance.
', 'PromoteReadReplicaMessage$BackupRetentionPeriod' => 'The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can\'t be set to 0 if the DB instance is a source to read replicas.
The number of instances to reserve.
Default: 1
The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn\'t a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
', 'RestoreDBClusterFromS3Message$BackupRetentionPeriod' => 'The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$Port' => 'The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535.
Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$Iops' => 'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
', 'RestoreDBInstanceFromDBSnapshotMessage$Port' => 'The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn\'t specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
', 'RestoreDBInstanceFromDBSnapshotMessage$StorageThroughput' => 'Specifies the storage throughput value for the DB instance.
This setting doesn\'t apply to RDS Custom or Amazon Aurora.
', 'RestoreDBInstanceFromDBSnapshotMessage$AllocatedStorage' => 'The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$MonitoringInterval' => 'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn\'t a valid value, RDS issues an error.
', 'RestoreDBInstanceFromS3Message$MaxAllocatedStorage' => 'The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$StorageThroughput' => 'Specifies the storage throughput value for the DB instance.
This setting doesn\'t apply to RDS Custom or Amazon Aurora.
', 'RestoreDBInstanceToPointInTimeMessage$Port' => 'The port number on which the database accepts connections.
Default: The same port as the original DB instance.
Constraints:
The value must be 1150-65535.
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
This setting doesn\'t apply to SQL Server.
Constraints:
Must be an integer greater than 1000.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$StorageThroughput' => 'The storage throughput value for the DB instance.
This setting doesn\'t apply to RDS Custom or Amazon Aurora.
', 'RestoreDBInstanceToPointInTimeMessage$AllocatedStorage' => 'The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
', 'ScalingConfiguration$MaxCapacity' => 'The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
', 'ScalingConfiguration$SecondsUntilAutoPause' => 'The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
', 'ScalingConfiguration$SecondsBeforeTimeout' => 'The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
', 'ScalingConfigurationInfo$MinCapacity' => 'The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it\'s idle (it has no connections).
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
The retention period for the replicated automated backups.
', ], ], 'Integration' => [ 'base' => 'A zero-ETL integration with Amazon Redshift.
', 'refs' => [ 'IntegrationList$member' => NULL, ], ], 'IntegrationAlreadyExistsFault' => [ 'base' => 'The integration you are trying to create already exists.
', 'refs' => [], ], 'IntegrationArn' => [ 'base' => NULL, 'refs' => [ 'Integration$IntegrationArn' => 'The ARN of the integration.
', ], ], 'IntegrationConflictOperationFault' => [ 'base' => 'A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
', 'refs' => [], ], 'IntegrationDescription' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$Description' => 'A description of the integration.
', 'Integration$Description' => 'A description of the integration.
', 'ModifyIntegrationMessage$Description' => 'A new description for the integration.
', ], ], 'IntegrationError' => [ 'base' => 'An error associated with a zero-ETL integration with Amazon Redshift.
', 'refs' => [ 'IntegrationErrorList$member' => NULL, ], ], 'IntegrationErrorList' => [ 'base' => NULL, 'refs' => [ 'Integration$Errors' => 'Any errors associated with the integration.
', ], ], 'IntegrationIdentifier' => [ 'base' => NULL, 'refs' => [ 'DeleteIntegrationMessage$IntegrationIdentifier' => 'The unique identifier of the integration.
', 'DescribeIntegrationsMessage$IntegrationIdentifier' => 'The unique identifier of the integration.
', 'ModifyIntegrationMessage$IntegrationIdentifier' => 'The unique identifier of the integration to modify.
', ], ], 'IntegrationList' => [ 'base' => NULL, 'refs' => [ 'DescribeIntegrationsResponse$Integrations' => 'A list of integrations.
', ], ], 'IntegrationName' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$IntegrationName' => 'The name of the integration.
', 'Integration$IntegrationName' => 'The name of the integration.
', 'ModifyIntegrationMessage$IntegrationName' => 'A new name for the integration.
', ], ], 'IntegrationNotFoundFault' => [ 'base' => 'The specified integration could not be found.
', 'refs' => [], ], 'IntegrationQuotaExceededFault' => [ 'base' => 'You can\'t crate any more zero-ETL integrations because the quota has been reached.
', 'refs' => [], ], 'IntegrationStatus' => [ 'base' => NULL, 'refs' => [ 'Integration$Status' => 'The current status of the integration.
', ], ], 'InvalidBlueGreenDeploymentStateFault' => [ 'base' => 'The blue/green deployment can\'t be switched over or deleted because there is an invalid configuration in the green environment.
', 'refs' => [], ], 'InvalidCustomDBEngineVersionStateFault' => [ 'base' => 'You can\'t delete the CEV.
', 'refs' => [], ], 'InvalidDBClusterAutomatedBackupStateFault' => [ 'base' => 'The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.
', 'refs' => [], ], 'InvalidDBClusterCapacityFault' => [ 'base' => ' Capacity isn\'t a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.
The requested operation can\'t be performed on the endpoint while the endpoint is in this state.
', 'refs' => [], ], 'InvalidDBClusterSnapshotStateFault' => [ 'base' => 'The supplied value isn\'t a valid DB cluster snapshot state.
', 'refs' => [], ], 'InvalidDBClusterStateFault' => [ 'base' => 'The requested operation can\'t be performed while the cluster is in this state.
', 'refs' => [], ], 'InvalidDBInstanceAutomatedBackupStateFault' => [ 'base' => 'The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.
', 'refs' => [], ], 'InvalidDBInstanceStateFault' => [ 'base' => 'The DB instance isn\'t in a valid state.
', 'refs' => [], ], 'InvalidDBParameterGroupStateFault' => [ 'base' => 'The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can\'t delete it when the parameter group is in this state.
', 'refs' => [], ], 'InvalidDBProxyEndpointStateFault' => [ 'base' => 'You can\'t perform this operation while the DB proxy endpoint is in a particular state.
', 'refs' => [], ], 'InvalidDBProxyStateFault' => [ 'base' => 'The requested operation can\'t be performed while the proxy is in this state.
', 'refs' => [], ], 'InvalidDBSecurityGroupStateFault' => [ 'base' => 'The state of the DB security group doesn\'t allow deletion.
', 'refs' => [], ], 'InvalidDBShardGroupStateFault' => [ 'base' => 'The DB shard group must be in the available state.
', 'refs' => [], ], 'InvalidDBSnapshotStateFault' => [ 'base' => 'The state of the DB snapshot doesn\'t allow deletion.
', 'refs' => [], ], 'InvalidDBSubnetGroupFault' => [ 'base' => 'The DBSubnetGroup doesn\'t belong to the same VPC as that of an existing cross-region read replica of the same source instance.
', 'refs' => [], ], 'InvalidDBSubnetGroupStateFault' => [ 'base' => 'The DB subnet group cannot be deleted because it\'s in use.
', 'refs' => [], ], 'InvalidDBSubnetStateFault' => [ 'base' => 'The DB subnet isn\'t in the available state.
', 'refs' => [], ], 'InvalidEventSubscriptionStateFault' => [ 'base' => 'This error can occur if someone else is modifying a subscription. You should retry the action.
', 'refs' => [], ], 'InvalidExportOnlyFault' => [ 'base' => 'The export is invalid for exporting to an Amazon S3 bucket.
', 'refs' => [], ], 'InvalidExportSourceStateFault' => [ 'base' => 'The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
', 'refs' => [], ], 'InvalidExportTaskStateFault' => [ 'base' => 'You can\'t cancel an export task that has completed.
', 'refs' => [], ], 'InvalidGlobalClusterStateFault' => [ 'base' => 'The global cluster is in an invalid state and can\'t perform the requested operation.
', 'refs' => [], ], 'InvalidIntegrationStateFault' => [ 'base' => 'The integration is in an invalid state and can\'t perform the requested operation.
', 'refs' => [], ], 'InvalidMaxAcuFault' => [ 'base' => 'The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).
', 'refs' => [], ], 'InvalidOptionGroupStateFault' => [ 'base' => 'The option group isn\'t in the available state.
', 'refs' => [], ], 'InvalidResourceStateFault' => [ 'base' => 'The operation can\'t be performed because another operation is in progress.
', 'refs' => [], ], 'InvalidRestoreFault' => [ 'base' => 'Cannot restore from VPC backup to non-VPC DB instance.
', 'refs' => [], ], 'InvalidS3BucketFault' => [ 'base' => 'The specified Amazon S3 bucket name can\'t be found or Amazon RDS isn\'t authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
', 'refs' => [], ], 'InvalidSubnet' => [ 'base' => 'The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
', 'refs' => [], ], 'InvalidVPCNetworkStateFault' => [ 'base' => 'The DB subnet group doesn\'t cover all Availability Zones after it\'s created because of users\' change.
', 'refs' => [], ], 'IssueDetails' => [ 'base' => 'The details of an issue with your DB instances, DB clusters, and DB parameter groups.
', 'refs' => [ 'DBRecommendation$IssueDetails' => 'Details of the issue that caused the recommendation.
', 'RecommendedAction$IssueDetails' => 'The details of the issue.
', ], ], 'KMSKeyNotAccessibleFault' => [ 'base' => 'An error occurred accessing an Amazon Web Services KMS key.
', 'refs' => [], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'RemoveTagsFromResourceMessage$TagKeys' => 'The tag key (name) of the tag to be removed.
', ], ], 'KmsKeyIdOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateCustomDBEngineVersionMessage$KMSKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don\'t already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
', ], ], 'LimitlessDatabase' => [ 'base' => 'Contains details for Aurora Limitless Database.
', 'refs' => [ 'DBCluster$LimitlessDatabase' => 'The details for Aurora Limitless Database.
', ], ], 'LimitlessDatabaseStatus' => [ 'base' => NULL, 'refs' => [ 'LimitlessDatabase$Status' => 'The status of Aurora Limitless Database.
', ], ], 'ListTagsForResourceMessage' => [ 'base' => '', 'refs' => [], ], 'LocalWriteForwardingStatus' => [ 'base' => NULL, 'refs' => [ 'DBCluster$LocalWriteForwardingStatus' => 'Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
', ], ], 'LogTypeList' => [ 'base' => NULL, 'refs' => [ 'CloudwatchLogsExportConfiguration$EnableLogTypes' => 'The list of log types to enable.
', 'CloudwatchLogsExportConfiguration$DisableLogTypes' => 'The list of log types to disable.
', 'CreateDBClusterMessage$EnableCloudwatchLogsExports' => 'The list of log types that need to be enabled for exporting to CloudWatch Logs.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
', 'CreateDBInstanceMessage$EnableCloudwatchLogsExports' => 'The list of log types to enable for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
RDS Custom
The following values are valid for each DB engine:
RDS for Db2 - diag.log | notify.log
RDS for MariaDB - audit | error | general | slowquery
RDS for Microsoft SQL Server - agent | error
RDS for MySQL - audit | error | general | slowquery
RDS for Oracle - alert | audit | listener | trace | oemagent
RDS for PostgreSQL - postgresql | upgrade
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'DBCluster$EnabledCloudwatchLogsExports' => 'A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
', 'DBEngineVersion$ExportableLogTypes' => 'The types of logs that the database engine has available for export to CloudWatch Logs.
', 'DBInstance$EnabledCloudwatchLogsExports' => 'A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
', 'PendingCloudwatchLogsExports$LogTypesToEnable' => 'Log types that are in the process of being deactivated. After they are deactivated, these log types aren\'t exported to CloudWatch Logs.
', 'PendingCloudwatchLogsExports$LogTypesToDisable' => 'Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
', 'RestoreDBClusterFromS3Message$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
', 'RestoreDBClusterFromSnapshotMessage$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBInstanceFromDBSnapshotMessage$EnableCloudwatchLogsExports' => 'The list of logs for the restored DB instance to export to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromS3Message$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$EnableCloudwatchLogsExports' => 'The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AccountQuota$Used' => 'The amount currently used toward the quota maximum.
', 'AccountQuota$Max' => 'The maximum allowed value for the quota.
', 'DescribeDBLogFilesDetails$LastWritten' => 'A POSIX timestamp when the last log entry was written.
', 'DescribeDBLogFilesDetails$Size' => 'The size, in bytes, of the log file for the specified DB instance.
', 'DescribeDBLogFilesMessage$FileLastWritten' => 'Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
', 'DescribeDBLogFilesMessage$FileSize' => 'Filters the available log files for files larger than the specified size.
', ], ], 'LongOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$BacktrackWindow' => 'The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
The number of change records stored for Backtrack.
', 'ModifyDBClusterMessage$BacktrackWindow' => 'The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$BacktrackWindow' => 'The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
', ], ], 'Marker' => [ 'base' => NULL, 'refs' => [ 'DescribeIntegrationsMessage$Marker' => 'An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A pagination token that can be used in a later DescribeIntegrations request.
Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
', 'refs' => [ 'DBCluster$MasterUserSecret' => 'The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
', 'DBInstance$MasterUserSecret' => 'The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
', ], ], 'MaxDBShardGroupLimitReached' => [ 'base' => 'The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.
', 'refs' => [], ], 'MaxRecords' => [ 'base' => NULL, 'refs' => [ 'DescribeBlueGreenDeploymentsRequest$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints:
Must be a minimum of 20.
Can\'t exceed 100.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBProxyEndpointsRequest$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBProxyTargetGroupsRequest$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBProxyTargetsRequest$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
', 'DescribeDBShardGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100
', 'DescribeExportTasksMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
', ], ], 'Metric' => [ 'base' => 'The representation of a metric.
', 'refs' => [ 'MetricList$member' => NULL, ], ], 'MetricList' => [ 'base' => NULL, 'refs' => [ 'PerformanceIssueDetails$Metrics' => 'The metrics that are relevant to the performance issue.
', ], ], 'MetricQuery' => [ 'base' => 'The query to retrieve metric data points.
', 'refs' => [ 'Metric$MetricQuery' => 'The query to retrieve metric data points.
', ], ], 'MetricReference' => [ 'base' => 'The reference (threshold) for a metric.
', 'refs' => [ 'MetricReferenceList$member' => NULL, ], ], 'MetricReferenceList' => [ 'base' => NULL, 'refs' => [ 'Metric$References' => 'A list of metric references (thresholds).
', ], ], 'MinimumEngineVersionPerAllowedValue' => [ 'base' => 'The minimum DB engine version required for each corresponding allowed value for an option setting.
', 'refs' => [ 'MinimumEngineVersionPerAllowedValueList$member' => NULL, ], ], 'MinimumEngineVersionPerAllowedValueList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOptionSetting$MinimumEngineVersionPerAllowedValue' => 'The minimum DB engine version required for the corresponding allowed value for this option setting.
', ], ], 'ModifyActivityStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyActivityStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCertificatesMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCertificatesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCurrentDBClusterCapacityMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCustomDBEngineVersionMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBClusterParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBInstanceMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBProxyEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyTargetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBProxyTargetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBRecommendationMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBShardGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotAttributeMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSubnetGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyEventSubscriptionMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyIntegrationMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyOptionGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ModifyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyTenantDatabaseMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyTenantDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'NetworkTypeNotSupported' => [ 'base' => 'The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.
The details of an option.
', 'refs' => [ 'OptionsList$member' => NULL, ], ], 'OptionConfiguration' => [ 'base' => 'A list of all available options
', 'refs' => [ 'OptionConfigurationList$member' => NULL, ], ], 'OptionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ModifyOptionGroupMessage$OptionsToInclude' => 'Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
', ], ], 'OptionGroup' => [ 'base' => '', 'refs' => [ 'CopyOptionGroupResult$OptionGroup' => NULL, 'CreateOptionGroupResult$OptionGroup' => NULL, 'ModifyOptionGroupResult$OptionGroup' => NULL, 'OptionGroupsList$member' => NULL, ], ], 'OptionGroupAlreadyExistsFault' => [ 'base' => 'The option group you are trying to create already exists.
', 'refs' => [], ], 'OptionGroupMembership' => [ 'base' => 'Provides information on the option groups the DB instance is a member of.
', 'refs' => [ 'OptionGroupMembershipList$member' => NULL, ], ], 'OptionGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$OptionGroupMemberships' => 'The list of option group memberships for this DB instance.
', ], ], 'OptionGroupNotFoundFault' => [ 'base' => 'The specified option group could not be found.
', 'refs' => [], ], 'OptionGroupOption' => [ 'base' => 'Available option.
', 'refs' => [ 'OptionGroupOptionsList$member' => NULL, ], ], 'OptionGroupOptionSetting' => [ 'base' => 'Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
', 'refs' => [ 'OptionGroupOptionSettingsList$member' => NULL, ], ], 'OptionGroupOptionSettingsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionGroupOptionSettings' => 'The option settings that are available (and the default value) for each option in an option group.
', ], ], 'OptionGroupOptionVersionsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionGroupOptionVersions' => 'The versions that are available for the option.
', ], ], 'OptionGroupOptionsList' => [ 'base' => 'List of available option group options.
', 'refs' => [ 'OptionGroupOptionsMessage$OptionGroupOptions' => NULL, ], ], 'OptionGroupOptionsMessage' => [ 'base' => '', 'refs' => [], ], 'OptionGroupQuotaExceededFault' => [ 'base' => 'The quota of 20 option groups was exceeded for this Amazon Web Services account.
', 'refs' => [], ], 'OptionGroups' => [ 'base' => 'List of option groups.
', 'refs' => [], ], 'OptionGroupsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroups$OptionGroupsList' => 'List of option groups.
', ], ], 'OptionNamesList' => [ 'base' => NULL, 'refs' => [ 'ModifyOptionGroupMessage$OptionsToRemove' => 'Options in this list are removed from the option group.
', ], ], 'OptionSetting' => [ 'base' => 'Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
', 'refs' => [ 'OptionSettingConfigurationList$member' => NULL, 'OptionSettingsList$member' => NULL, ], ], 'OptionSettingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'Option$OptionSettings' => 'The option settings for this option.
', ], ], 'OptionSettingsList' => [ 'base' => NULL, 'refs' => [ 'OptionConfiguration$OptionSettings' => 'The option settings to include in an option group.
', ], ], 'OptionVersion' => [ 'base' => 'The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.
The options that conflict with this option.
', ], ], 'OptionsDependedOn' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionsDependedOn' => 'The options that are prerequisites for this option.
', ], ], 'OptionsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroup$Options' => 'Indicates what options are available in the option group.
', ], ], 'OrderableDBInstanceOption' => [ 'base' => 'Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
A data type that represents an Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'refs' => [ 'Subnet$SubnetOutpost' => 'If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', ], ], 'Parameter' => [ 'base' => 'This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
Provides a list of parameters for the DB cluster parameter group.
', 'DBParameterGroupDetails$Parameters' => 'A list of Parameter values.
Contains a list of engine default parameters.
', 'ModifyDBClusterParameterGroupMessage$Parameters' => 'A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.
When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.
You can\'t use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.
For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
', 'ResetDBClusterParameterGroupMessage$Parameters' => 'A list of parameter names in the DB cluster parameter group to reset to the default values. You can\'t use this parameter if the ResetAllParameters parameter is enabled.
To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
MariaDB
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
', 'refs' => [ 'ClusterPendingModifiedValues$PendingCloudwatchLogsExports' => NULL, 'PendingModifiedValues$PendingCloudwatchLogsExports' => NULL, ], ], 'PendingMaintenanceAction' => [ 'base' => 'Provides information about a pending maintenance action for a resource.
', 'refs' => [ 'PendingMaintenanceActionDetails$member' => NULL, ], ], 'PendingMaintenanceActionDetails' => [ 'base' => NULL, 'refs' => [ 'ResourcePendingMaintenanceActions$PendingMaintenanceActionDetails' => 'A list that provides details about the pending maintenance actions for the resource.
', ], ], 'PendingMaintenanceActions' => [ 'base' => NULL, 'refs' => [ 'PendingMaintenanceActionsMessage$PendingMaintenanceActions' => 'A list of the pending maintenance actions for the resource.
', ], ], 'PendingMaintenanceActionsMessage' => [ 'base' => 'Data returned from the DescribePendingMaintenanceActions action.
', 'refs' => [], ], 'PendingModifiedValues' => [ 'base' => 'This data type is used as a response element in the ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
', ], ], 'PerformanceInsightsMetricDimensionGroup' => [ 'base' => 'A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions:
db.sql.id - The hash of a running SQL statement, generated by Performance Insights.
db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.
db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.
db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
', ], ], 'PerformanceInsightsMetricQuery' => [ 'base' => 'A single Performance Insights metric query to process. You must provide the metric to the query. If other parameters aren\'t specified, Performance Insights returns all data points for the specified metric. Optionally, you can request the data points to be aggregated by dimension group (GroupBy) and return only those data points that match your criteria (Filter).
Constraints:
Must be a valid Performance Insights query.
The Performance Insights query that you can use to retrieve Performance Insights metric data points.
', ], ], 'PerformanceIssueDetails' => [ 'base' => 'Details of the performance issue.
', 'refs' => [ 'IssueDetails$PerformanceIssueDetails' => 'A detailed description of the issue when the recommendation category is performance.
SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
', 'refs' => [ 'ProcessorFeatureList$member' => NULL, ], ], 'ProcessorFeatureList' => [ 'base' => NULL, 'refs' => [ 'CreateDBInstanceMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to RDS Custom DB instances.
', 'DBInstance$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
', 'DBSnapshot$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
', 'ModifyDBInstanceMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to RDS Custom DB instances.
', 'PendingModifiedValues$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
', 'RestoreDBInstanceFromDBSnapshotMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromS3Message$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
', 'RestoreDBInstanceToPointInTimeMessage$ProcessorFeatures' => 'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn\'t apply to RDS Custom.
', ], ], 'PromoteReadReplicaDBClusterMessage' => [ 'base' => '', 'refs' => [], ], 'PromoteReadReplicaDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'PromoteReadReplicaMessage' => [ 'base' => '', 'refs' => [], ], 'PromoteReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'ProvisionedIopsNotAvailableInAZFault' => [ 'base' => 'Provisioned IOPS not available in the specified Availability Zone.
', 'refs' => [], ], 'PurchaseReservedDBInstancesOfferingMessage' => [ 'base' => '', 'refs' => [], ], 'PurchaseReservedDBInstancesOfferingResult' => [ 'base' => NULL, 'refs' => [], ], 'Range' => [ 'base' => 'A range of integer values.
', 'refs' => [ 'RangeList$member' => NULL, ], ], 'RangeList' => [ 'base' => NULL, 'refs' => [ 'ValidStorageOptions$StorageSize' => 'The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.
', 'ValidStorageOptions$ProvisionedIops' => 'The valid range of provisioned IOPS. For example, 1000-256,000.
', 'ValidStorageOptions$ProvisionedStorageThroughput' => 'The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).
', ], ], 'RdsCustomClusterConfiguration' => [ 'base' => 'Reserved for future use.
', 'refs' => [ 'ClusterPendingModifiedValues$RdsCustomClusterConfiguration' => 'Reserved for future use.
', 'CreateDBClusterMessage$RdsCustomClusterConfiguration' => 'Reserved for future use.
', 'DBCluster$RdsCustomClusterConfiguration' => 'Reserved for future use.
', 'RestoreDBClusterFromSnapshotMessage$RdsCustomClusterConfiguration' => 'Reserved for future use.
', 'RestoreDBClusterToPointInTimeMessage$RdsCustomClusterConfiguration' => 'Reserved for future use.
', ], ], 'ReadReplicaDBClusterIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$ReadReplicaDBClusterIdentifiers' => 'The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn\'t contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
The identifiers of the read replicas associated with this DB instance.
', ], ], 'ReadReplicaIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$ReadReplicaIdentifiers' => 'Contains one or more identifiers of the read replicas associated with this DB cluster.
', ], ], 'ReadersArnList' => [ 'base' => NULL, 'refs' => [ 'GlobalClusterMember$Readers' => 'The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.
', ], ], 'RebootDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RebootDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'RebootDBInstanceMessage' => [ 'base' => '', 'refs' => [], ], 'RebootDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'RebootDBShardGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'RecommendedAction' => [ 'base' => 'The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.
', 'refs' => [ 'RecommendedActionList$member' => NULL, ], ], 'RecommendedActionList' => [ 'base' => NULL, 'refs' => [ 'DBRecommendation$RecommendedActions' => 'A list of recommended actions.
', ], ], 'RecommendedActionParameter' => [ 'base' => 'A single parameter to use with the RecommendedAction API operation to apply the action.
The parameters for the API operation.
', ], ], 'RecommendedActionUpdate' => [ 'base' => 'The recommended status to update for the specified recommendation action ID.
', 'refs' => [ 'RecommendedActionUpdateList$member' => NULL, ], ], 'RecommendedActionUpdateList' => [ 'base' => NULL, 'refs' => [ 'ModifyDBRecommendationMessage$RecommendedActionUpdates' => 'The list of recommended action status to update. You can update multiple recommended actions at one time.
', ], ], 'RecurringCharge' => [ 'base' => 'This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
The recurring price charged to run this reserved DB instance.
', 'ReservedDBInstancesOffering$RecurringCharges' => 'The recurring price charged to run this reserved DB instance.
', ], ], 'ReferenceDetails' => [ 'base' => 'The reference details of a metric.
', 'refs' => [ 'MetricReference$ReferenceDetails' => 'The details of a performance issue.
', ], ], 'RegisterDBProxyTargetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterDBProxyTargetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'RemoveFromGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveFromGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRoleFromDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRoleFromDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'base' => '', 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveTagsFromResourceMessage' => [ 'base' => '', 'refs' => [], ], 'ReplicaMode' => [ 'base' => NULL, 'refs' => [ 'CreateDBInstanceReadReplicaMessage$ReplicaMode' => 'The open mode of the replica database: mounted or read-only.
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn\'t use Active Data Guard to transmit information to the mounted replica. Because it doesn\'t accept user connections, a mounted replica can\'t serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
For RDS Custom, you must specify this parameter and set it to mounted. The value won\'t be set by default. After replica creation, you can manage the open mode manually.
The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn\'t use Active Data Guard to transmit information to the mounted replica. Because it doesn\'t accept user connections, a mounted replica can\'t serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'RdsCustomClusterConfiguration$ReplicaMode' => 'Reserved for future use.
', ], ], 'ReservedDBInstance' => [ 'base' => 'This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
User already has a reservation with the given identifier.
', 'refs' => [], ], 'ReservedDBInstanceList' => [ 'base' => NULL, 'refs' => [ 'ReservedDBInstanceMessage$ReservedDBInstances' => 'A list of reserved DB instances.
', ], ], 'ReservedDBInstanceMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeReservedDBInstances action.
The specified reserved DB Instance not found.
', 'refs' => [], ], 'ReservedDBInstanceQuotaExceededFault' => [ 'base' => 'Request would exceed the user\'s DB Instance quota.
', 'refs' => [], ], 'ReservedDBInstancesOffering' => [ 'base' => 'This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
A list of reserved DB instance offerings.
', ], ], 'ReservedDBInstancesOfferingMessage' => [ 'base' => 'Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
Specified offering does not exist.
', 'refs' => [], ], 'ResetDBClusterParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ResetDBParameterGroupMessage' => [ 'base' => '', 'refs' => [], ], 'ResourceNotFoundFault' => [ 'base' => 'The specified resource ID was not found.
', 'refs' => [], ], 'ResourcePendingMaintenanceActions' => [ 'base' => 'Describes the pending maintenance actions for a resource.
', 'refs' => [ 'ApplyPendingMaintenanceActionResult$ResourcePendingMaintenanceActions' => NULL, 'PendingMaintenanceActions$member' => NULL, ], ], 'RestoreDBClusterFromS3Message' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterFromS3Result' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'RestoreDBClusterFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'base' => '', 'refs' => [], ], 'RestoreDBClusterToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotMessage' => [ 'base' => '', 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Message' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Result' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceToPointInTimeMessage' => [ 'base' => '', 'refs' => [], ], 'RestoreDBInstanceToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreWindow' => [ 'base' => 'Earliest and latest time an instance can be restored to:
', 'refs' => [ 'DBClusterAutomatedBackup$RestoreWindow' => NULL, 'DBInstanceAutomatedBackup$RestoreWindow' => 'The earliest and latest time a DB instance can be restored to.
', ], ], 'RevokeDBSecurityGroupIngressMessage' => [ 'base' => '', 'refs' => [], ], 'RevokeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'SNSInvalidTopicFault' => [ 'base' => 'SNS has responded that there is a problem with the SNS topic specified.
', 'refs' => [], ], 'SNSNoAuthorizationFault' => [ 'base' => 'You do not have permission to publish to the SNS topic ARN.
', 'refs' => [], ], 'SNSTopicArnNotFoundFault' => [ 'base' => 'The SNS topic ARN does not exist.
', 'refs' => [], ], 'ScalarReferenceDetails' => [ 'base' => 'The metric reference details when the reference is a scalar.
', 'refs' => [ 'ReferenceDetails$ScalarReferenceDetails' => 'The metric reference details when the reference is a scalar.
', ], ], 'ScalingConfiguration' => [ 'base' => 'Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
', 'refs' => [ 'CreateDBClusterMessage$ScalingConfiguration' => 'For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$ScalingConfiguration' => 'The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$ScalingConfiguration' => 'For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$ScalingConfiguration' => 'For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
', ], ], 'ScalingConfigurationInfo' => [ 'base' => 'The scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
', 'refs' => [ 'DBCluster$ScalingConfigurationInfo' => NULL, ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'CreateTenantDatabaseMessage$MasterUserPassword' => 'The password for the master user in your tenant database.
Constraints:
Must be 8 to 30 characters.
Can include any printable ASCII character except forward slash (/), double quote ("), at symbol (@), ampersand (&), or single quote (\').
The new password for the master user of the specified tenant database in your DB instance.
Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
Constraints:
Can include any printable ASCII character except /, " (double quote), @, & (ampersand), and \' (single quote).
Length constraints:
Must contain between 8 and 30 characters.
The master password for the tenant database.
', ], ], 'ServerlessV2ScalingConfiguration' => [ 'base' => 'Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
', 'refs' => [ 'CreateDBClusterMessage$ServerlessV2ScalingConfiguration' => NULL, 'ModifyDBClusterMessage$ServerlessV2ScalingConfiguration' => NULL, 'RestoreDBClusterFromS3Message$ServerlessV2ScalingConfiguration' => NULL, 'RestoreDBClusterFromSnapshotMessage$ServerlessV2ScalingConfiguration' => NULL, 'RestoreDBClusterToPointInTimeMessage$ServerlessV2ScalingConfiguration' => NULL, ], ], 'ServerlessV2ScalingConfigurationInfo' => [ 'base' => 'The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
', 'refs' => [ 'DBCluster$ServerlessV2ScalingConfiguration' => NULL, ], ], 'SharedSnapshotQuotaExceededFault' => [ 'base' => 'You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
', 'refs' => [], ], 'SnapshotQuotaExceededFault' => [ 'base' => 'The request would result in the user exceeding the allowed number of DB snapshots.
', 'refs' => [], ], 'SourceArn' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationMessage$SourceArn' => 'The Amazon Resource Name (ARN) of the database to use as the source for replication.
', 'Integration$SourceArn' => 'The Amazon Resource Name (ARN) of the database used as the source for replication.
', ], ], 'SourceClusterNotSupportedFault' => [ 'base' => 'The source DB cluster isn\'t supported for a blue/green deployment.
', 'refs' => [], ], 'SourceDatabaseNotSupportedFault' => [ 'base' => 'The source DB instance isn\'t supported for a blue/green deployment.
', 'refs' => [], ], 'SourceIdsList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$SourceIds' => 'The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can\'t end with a hyphen or contain two consecutive hyphens.
Constraints:
If SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
A list of source IDs for the RDS event notification subscription.
', ], ], 'SourceNotFoundFault' => [ 'base' => 'The requested source could not be found.
', 'refs' => [], ], 'SourceRegion' => [ 'base' => 'Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.
A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.
Contains the result of a successful invocation of the DescribeSourceRegions action.
The event source to retrieve events for. If no value is specified, all events are returned.
', 'Event$SourceType' => 'Specifies the source type for this event.
', ], ], 'StartActivityStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartActivityStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceAutomatedBackupsReplicationMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceAutomatedBackupsReplicationResult' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StartExportTaskMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopActivityStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopActivityStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceAutomatedBackupsReplicationMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceAutomatedBackupsReplicationResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StorageQuotaExceededFault' => [ 'base' => 'The request would result in the user exceeding the allowed amount of storage available across all DB instances.
', 'refs' => [], ], 'StorageTypeNotAvailableFault' => [ 'base' => 'The aurora-iopt1 storage type isn\'t available, because you modified the DB cluster to use this storage type less than one month ago.
The specified StorageType can\'t be associated with the DB instance.
The name of the Amazon RDS quota for this Amazon Web Services account.
', 'ActivityStreamModeList$member' => NULL, 'AddRoleToDBClusterMessage$DBClusterIdentifier' => 'The name of the DB cluster to associate the IAM role with.
', 'AddRoleToDBClusterMessage$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
', 'AddRoleToDBInstanceMessage$DBInstanceIdentifier' => 'The name of the DB instance to associate the IAM role with.
', 'AddRoleToDBInstanceMessage$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
', 'AddSourceIdentifierToSubscriptionMessage$SubscriptionName' => 'The name of the RDS event notification subscription you want to add a source identifier to.
', 'AddSourceIdentifierToSubscriptionMessage$SourceIdentifier' => 'The identifier of the event source to be added.
Constraints:
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', 'ApplyPendingMaintenanceActionMessage$ResourceIdentifier' => 'The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', 'ApplyPendingMaintenanceActionMessage$ApplyAction' => 'The pending maintenance action to apply to this resource.
Valid Values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can\'t be undone.
Valid Values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
The name of the DB security group to add authorization to.
', 'AuthorizeDBSecurityGroupIngressMessage$CIDRIP' => 'The IP range to authorize.
', 'AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName' => 'Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn\'t an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The name of the Availability Zone.
', 'AvailabilityZones$member' => NULL, 'AvailableProcessorFeature$Name' => 'The name of the processor feature. Valid names are coreCount and threadsPerCore.
The default value for the processor feature of the DB instance class.
', 'AvailableProcessorFeature$AllowedValues' => 'The allowed values for the processor feature of the DB instance class.
', 'BacktrackDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The identifier of the snapshot or cluster export task to cancel.
', 'Certificate$CertificateIdentifier' => 'The unique key that identifies a certificate.
', 'Certificate$CertificateType' => 'The type of the certificate.
', 'Certificate$Thumbprint' => 'The thumbprint of the certificate.
', 'Certificate$CertificateArn' => 'The Amazon Resource Name (ARN) for the certificate.
', 'CertificateDetails$CAIdentifier' => 'The CA identifier of the CA certificate used for the DB instance\'s server certificate.
', 'CertificateMessage$DefaultCertificateForNewLaunches' => 'The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the ModifyCertificates operation.
An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The name of the character set.
', 'CharacterSet$CharacterSetDescription' => 'The description of the character set.
', 'ClusterPendingModifiedValues$DBClusterIdentifier' => 'The DBClusterIdentifier value for the DB cluster.
', 'ClusterPendingModifiedValues$MasterUserPassword' => 'The master credentials for the DB cluster.
', 'ClusterPendingModifiedValues$EngineVersion' => 'The database engine version.
', 'ClusterPendingModifiedValues$StorageType' => 'The storage type for the DB cluster.
', 'ConnectionPoolConfiguration$InitQuery' => 'One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
Default: no initialization query
', 'ConnectionPoolConfigurationInfo$InitQuery' => 'One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
The key of ContextAttribute.
The value of ContextAttribute.
The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.
Constraints:
Must specify a valid DB cluster parameter group.
The identifier for the copied DB cluster parameter group.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-cluster-param-group1
A description for the copied DB cluster parameter group.
', 'CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier' => 'The identifier of the DB cluster snapshot to copy. This parameter isn\'t case-sensitive.
You can\'t copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
Constraints:
Must specify a valid system snapshot in the "available" state.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
Example: my-cluster-snapshot1
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn\'t case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you don\'t specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don\'t specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It\'s ignored in other Amazon Web Services Regions.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Constraints:
Must specify a valid DB parameter group.
The identifier for the copied DB parameter group.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-db-parameter-group
A description for the copied DB parameter group.
', 'CopyDBSnapshotMessage$SourceDBSnapshotIdentifier' => 'The identifier for the source DB snapshot.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
Constraints:
Must specify a valid system snapshot in the "available" state.
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
The identifier for the copy of the snapshot.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-db-snapshot
The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don\'t specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
', 'CopyDBSnapshotMessage$PreSignedUrl' => 'When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It\'s ignored in other Amazon Web Services Regions.
You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don\'t specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
The name of an option group to associate with the copy of the snapshot.
Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.
', 'CopyDBSnapshotMessage$TargetCustomAvailabilityZone' => 'The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example: rds-caz-aiqhTgQv.
The identifier for the source option group.
Constraints:
Must specify a valid option group.
The identifier for the copied option group.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-option-group
The description for the copied option group.
', 'CreateDBClusterEndpointMessage$DBClusterIdentifier' => 'The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
', 'CreateDBClusterEndpointMessage$DBClusterEndpointIdentifier' => 'The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
', 'CreateDBClusterEndpointMessage$EndpointType' => 'The type of the endpoint, one of: READER, WRITER, ANY.
The name of the character set (CharacterSet) to associate the DB cluster with.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$DatabaseName' => 'The name for your database of up to 64 alphanumeric characters. If you don\'t provide a name, Amazon RDS doesn\'t create a database in the DB cluster you are creating.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$DBClusterIdentifier' => 'The identifier for this DB cluster. This parameter is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with this DB cluster. If you don\'t specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the name of an existing DB subnet group.
Must not be default.
Example: mydbsubnetgroup
The database engine to use for this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
aurora-mysql
aurora-postgresql
mysql
postgres
neptune - For information about using Amazon Neptune, see the Amazon Neptune User Guide .
The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
For information about a specific engine, see the following topics:
Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide.
RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$MasterUsername' => 'The name of the master user for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can\'t be specified if ManageMasterUserPassword is turned on.
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can\'t be modified.
', 'CreateDBClusterMessage$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn\'t specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn\'t specified, then Amazon RDS uses your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$PreSignedUrl' => 'When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.
The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$EngineMode' => 'The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.
For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$GlobalClusterIdentifier' => 'The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$Domain' => 'The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
For more information, see Kerberos authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
', 'CreateDBClusterMessage$DBClusterInstanceClass' => 'The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$StorageType' => 'The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned in the response. The storage type isn\'t returned when you set it to aurora.
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don\'t specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'CreateDBClusterMessage$NetworkType' => 'The network type of the DB cluster.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
Reserved for future use.
', 'CreateDBClusterMessage$MasterUserSecretKmsKeyId' => 'The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterMessage$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB cluster\'s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
', 'CreateDBClusterMessage$EngineLifecycleSupport' => 'The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB cluster parameter group.
Constraints:
Must not match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora-mysql5.7, aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql14
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres13
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mysql
postgres
The description for the DB cluster parameter group.
', 'CreateDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => 'The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1-snapshot1
The identifier of the DB cluster to create a snapshot for. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
Example: my-cluster1
The meaning of this parameter differs according to the database engine you use.
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn\'t specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
Must contain 1 to 64 alphanumeric characters.
Can\'t be a word reserved by the database engine.
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn\'t specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.
Constraints:
It must contain 1 to 63 alphanumeric characters.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
Can\'t be a word reserved by the database engine.
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don\'t specify a value, the default value is ORCL for non-CDBs and RDSCDB for CDBs.
Default: ORCL
Constraints:
Must contain 1 to 8 alphanumeric characters.
Must contain a letter.
Can\'t be a word reserved by the database engine.
Not applicable. Must be null.
The name of the database to create when the DB instance is created. If this parameter isn\'t specified, no database is created in the DB instance. In some cases, we recommend that you don\'t add a database name. For more information, see Additional considerations in the Amazon RDS User Guide.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can\'t be a word reserved by the specified database engine.
The name of the database to create when the DB instance is created. If this parameter isn\'t specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can\'t be a word reserved by the specified database engine.
The name of the database to create when the DB instance is created. If this parameter isn\'t specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can\'t be a word reserved by the specified database engine.
The Oracle System ID (SID) of the created DB instance. If you don\'t specify a value, the default value is ORCL. You can\'t specify the string null, or any other reserved word, for DBName.
Default: ORCL
Constraints:
Can\'t be longer than 8 characters.
The name of the database to create when the DB instance is created. If this parameter isn\'t specified, a database named postgres is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can\'t be a word reserved by the specified database engine.
Not applicable. Must be null.
The identifier for this DB instance. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
The database engine to use for this DB instance.
Not every database engine is available in every Amazon Web Services Region.
Valid Values:
aurora-mysql (for Aurora MySQL DB instances)
aurora-postgresql (for Aurora PostgreSQL DB instances)
custom-oracle-ee (for RDS Custom for Oracle DB instances)
custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
custom-oracle-se2 (for RDS Custom for Oracle DB instances)
custom-oracle-se2-cdb (for RDS Custom for Oracle DB instances)
custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The name for the master user.
This setting doesn\'t apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.
This setting is required for RDS DB instances.
Constraints:
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The password for the master user.
This setting doesn\'t apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.
Constraints:
Can\'t be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can\'t include the "&" (ampersand) or the "\'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don\'t specify one.
Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.
Constraints:
The AvailabilityZone parameter can\'t be specified if the DB instance is a Multi-AZ deployment.
The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
Example: us-east-1d
A DB subnet group to associate with this DB instance.
Constraints:
Must match the name of an existing DB subnet group.
Must not be default.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The name of the DB parameter group to associate with this DB instance. If you don\'t specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
This setting doesn\'t apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The version number of the database engine to use.
This setting doesn\'t apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster.
For a list of valid engine versions, use the DescribeDBEngineVersions operation.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.
For information, see Db2 on Amazon RDS versions in the Amazon RDS User Guide.
For information, see MariaDB on Amazon RDS versions in the Amazon RDS User Guide.
For information, see Microsoft SQL Server versions on Amazon RDS in the Amazon RDS User Guide.
For information, see MySQL on Amazon RDS versions in the Amazon RDS User Guide.
For information, see Oracle Database Engine release notes in the Amazon RDS User Guide.
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
The license model information for this DB instance.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
The option group to associate the DB instance with.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group. Also, that option group can\'t be removed from a DB instance after it is associated with a DB instance.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'CreateDBInstanceMessage$CharacterSetName' => 'For supported engines, the character set (CharacterSet) to associate the DB instance with.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora - The character set is managed by the DB cluster. For more information, see CreateDBCluster.
RDS Custom - However, if you need to change the character set, you can change it on the database itself.
The name of the NCHAR character set for the Oracle DB instance.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$DBClusterIdentifier' => 'The identifier of the DB cluster that this DB instance will belong to.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$StorageType' => 'The storage type to associate with the DB instance.
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
This setting doesn\'t apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
', 'CreateDBInstanceMessage$TdeCredentialPassword' => 'The password for the given ARN from the key store in order to access the device.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
This setting doesn\'t apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn\'t use the default key when this parameter is empty. You must explicitly specify a key.
The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (The domain is managed by the DB cluster.)
RDS Custom
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (The domain is managed by the DB cluster.)
RDS Custom
The time zone of the DB instance. The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server.
', 'CreateDBInstanceMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don\'t specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceMessage$CustomIamInstanceProfile' => 'The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
This setting is required for RDS Custom.
Constraints:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
', 'CreateDBInstanceMessage$BackupTarget' => 'The location for storing automated backups and manual snapshots.
Valid Values:
outposts (Amazon Web Services Outposts)
region (Amazon Web Services Region)
Default: region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'CreateDBInstanceMessage$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values: IPV4 | DUAL
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
', 'CreateDBInstanceMessage$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'CreateDBInstanceMessage$DBSystemId' => 'The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don\'t specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
', 'CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier' => 'The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance.
Can\'t be specified if the SourceDBClusterIdentifier parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn\'t apply to SQL Server or RDS Custom, which don\'t support cross-Region replicas.
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits the value from the source DB instance.
', 'CreateDBInstanceReadReplicaMessage$AvailabilityZone' => 'The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.
Example: us-east-1d
The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.
For SQL Server, you must use the option group associated with the source.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$DBParameterGroupName' => 'The name of the DB parameter group to associate with this DB instance.
If you don\'t specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of the source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas and for Oracle DB instances. It isn\'t supported for MySQL DB instances for same Region read replicas or for RDS Custom.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn\'t created in a VPC.
Constraints:
If supplied, must match the name of an existing DB subnet group.
The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:
Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
Not specify a DB subnet group. All these read replicas are created outside of any VPC.
Example: mydbsubnetgroup
The storage type to associate with the read replica.
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1 if the Iops parameter is specified. Otherwise, gp2.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don\'t specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can\'t create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.
This setting doesn\'t apply to RDS Custom, which uses the same KMS key as the primary replica.
', 'CreateDBInstanceReadReplicaMessage$PreSignedUrl' => 'When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It\'s ignored in other Amazon Web Services Regions.
This setting applies only when replicating from a source DB instance. Source DB clusters aren\'t supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don\'t specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
SourceRegion isn\'t supported for SQL Server, because Amazon RDS for SQL Server doesn\'t support cross-Region read replicas.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$Domain' => 'The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$DomainFqdn' => 'The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom DB instances.
', 'CreateDBInstanceReadReplicaMessage$NetworkType' => 'The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'CreateDBInstanceReadReplicaMessage$SourceDBClusterIdentifier' => 'The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
Must be the identifier of an existing Multi-AZ DB cluster.
Can\'t be specified if the SourceDBInstanceIdentifier parameter is also specified.
The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn\'t supported.
The CA certificate identifier to use for the read replica\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'CreateDBParameterGroupMessage$DBParameterGroupName' => 'The name of the DB parameter group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
db2-ae
db2-se
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The description for the DB parameter group.
', 'CreateDBProxyRequest$DBProxyName' => 'The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
', 'CreateDBProxyRequest$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
', 'CreateDBSecurityGroupMessage$DBSecurityGroupName' => 'The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Must not be "Default"
Example: mysecuritygroup
The description for the DB security group.
', 'CreateDBShardGroupMessage$DBShardGroupIdentifier' => 'The name of the DB shard group.
', 'CreateDBShardGroupMessage$DBClusterIdentifier' => 'The name of the primary DB cluster for the DB shard group.
', 'CreateDBSnapshotMessage$DBSnapshotIdentifier' => 'The identifier for the DB snapshot.
Constraints:
Can\'t be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
Must match the identifier of an existing DBInstance.
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
Must not be default.
First character must be a letter.
Example: mydbsubnetgroup
The description for the DB subnet group.
', 'CreateEventSubscriptionMessage$SubscriptionName' => 'The name of the subscription.
Constraints: The name must be less than 255 characters.
', 'CreateEventSubscriptionMessage$SnsTopicArn' => 'The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.
RDS doesn\'t support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn\'t specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
', 'CreateGlobalClusterMessage$SourceDBClusterIdentifier' => 'The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
If you provide a value for this parameter, don\'t specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:
DatabaseName
Engine
EngineVersion
StorageEncrypted
The database engine to use for this global database cluster.
Valid Values: aurora-mysql | aurora-postgresql
Constraints:
Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.
The engine version to use for this global database cluster.
Constraints:
Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.
The life cycle type for this global database cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.
This setting only applies to Aurora PostgreSQL-based global databases.
You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name for your database of up to 64 alphanumeric characters. If you don\'t specify a name, Amazon Aurora doesn\'t create a database in the global database cluster.
Constraints:
Can\'t be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don\'t specify an encryption key, RDS uses a default Amazon Web Services owned key.
', 'CreateOptionGroupMessage$OptionGroupName' => 'Specifies the name of the option group to be created.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: myoptiongroup
The name of the engine to associate this option group with.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Specifies the major version of the engine that this option group should be associated with.
', 'CreateOptionGroupMessage$OptionGroupDescription' => 'The description of the option group.
', 'CreateTenantDatabaseMessage$DBInstanceIdentifier' => 'The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn\'t case-sensitive.
', 'CreateTenantDatabaseMessage$TenantDBName' => 'The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as DBName in CreateDBInstance.
The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive.
Constraints:
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The character set for your tenant database. If you don\'t specify a value, the character set name defaults to AL32UTF8.
The NCHAR value for the tenant database.
A value that indicates the ID of the AMI.
', 'CustomDBEngineVersionAMI$Status' => 'A value that indicates the status of a custom engine version (CEV).
', 'DBCluster$CharacterSetName' => 'If present, specifies the name of the character set that this cluster is associated with.
', 'DBCluster$DatabaseName' => 'The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
', 'DBCluster$DBClusterIdentifier' => 'The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
', 'DBCluster$DBClusterParameterGroup' => 'The name of the DB cluster parameter group for the DB cluster.
', 'DBCluster$DBSubnetGroup' => 'Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
', 'DBCluster$Status' => 'The current state of this DB cluster.
', 'DBCluster$PercentProgress' => 'The progress of the operation as a percentage.
', 'DBCluster$Endpoint' => 'The connection endpoint for the primary instance of the DB cluster.
', 'DBCluster$ReaderEndpoint' => 'The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
', 'DBCluster$Engine' => 'The database engine used for this DB cluster.
', 'DBCluster$EngineVersion' => 'The version of the database engine.
', 'DBCluster$MasterUsername' => 'The master username for the DB cluster.
', 'DBCluster$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
', 'DBCluster$ReplicationSourceIdentifier' => 'The identifier of the source DB cluster if this DB cluster is a read replica.
', 'DBCluster$HostedZoneId' => 'The ID that Amazon Route 53 assigns when you create a hosted zone.
', 'DBCluster$KmsKeyId' => 'If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBCluster$DbClusterResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
', 'DBCluster$DBClusterArn' => 'The Amazon Resource Name (ARN) for the DB cluster.
', 'DBCluster$CloneGroupId' => 'The ID of the clone group with which the DB cluster is associated.
', 'DBCluster$EngineMode' => 'The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
', 'DBCluster$ActivityStreamKmsKeyId' => 'The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBCluster$ActivityStreamKinesisStreamName' => 'The name of the Amazon Kinesis data stream used for the database activity stream.
', 'DBCluster$DBClusterInstanceClass' => 'The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$StorageType' => 'The storage type associated with the DB cluster.
', 'DBCluster$MonitoringRoleArn' => 'The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBCluster$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
Reserved for future use.
', 'DBCluster$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'DBCluster$EngineLifecycleSupport' => 'The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
', 'DBClusterAutomatedBackup$Engine' => 'The name of the database engine for this automated backup.
', 'DBClusterAutomatedBackup$VpcId' => 'The VPC ID associated with the DB cluster.
', 'DBClusterAutomatedBackup$DBClusterAutomatedBackupsArn' => 'The Amazon Resource Name (ARN) for the automated backups.
', 'DBClusterAutomatedBackup$DBClusterIdentifier' => 'The identifier for the source DB cluster, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBClusterAutomatedBackup$MasterUsername' => 'The master user name of the automated backup.
', 'DBClusterAutomatedBackup$DbClusterResourceId' => 'The resource ID for the source DB cluster, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBClusterAutomatedBackup$Region' => 'The Amazon Web Services Region associated with the automated backup.
', 'DBClusterAutomatedBackup$LicenseModel' => 'The license model information for this DB cluster automated backup.
', 'DBClusterAutomatedBackup$Status' => 'A list of status information for an automated backup:
retained - Automated backups for deleted clusters.
The version of the database engine for the automated backup.
', 'DBClusterAutomatedBackup$DBClusterArn' => 'The Amazon Resource Name (ARN) for the source DB cluster.
', 'DBClusterAutomatedBackup$EngineMode' => 'The engine mode of the database engine for the automated backup.
', 'DBClusterAutomatedBackup$KmsKeyId' => 'The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBClusterAutomatedBackup$StorageType' => 'The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
', 'DBClusterAutomatedBackup$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'DBClusterAutomatedBackupMessage$Marker' => 'The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
', 'DBClusterBacktrack$BacktrackIdentifier' => 'Contains the backtrack identifier.
', 'DBClusterBacktrack$Status' => 'The status of the backtrack. This property returns one of the following values:
applying - The backtrack is currently being applied to or rolled back from the DB cluster.
completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
pending - The backtrack is currently pending application to or rollback from the DB cluster.
A pagination token that can be used in a later DescribeDBClusterBacktracks request.
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
', 'DBClusterCapacityInfo$TimeoutAction' => 'The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
', 'DBClusterEndpoint$DBClusterIdentifier' => 'The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
', 'DBClusterEndpoint$DBClusterEndpointResourceIdentifier' => 'A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
', 'DBClusterEndpoint$Endpoint' => 'The DNS address of the endpoint.
', 'DBClusterEndpoint$Status' => 'The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can\'t be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
The type of the endpoint. One of: READER, WRITER, CUSTOM.
The type associated with a custom endpoint. One of: READER, WRITER, ANY.
The Amazon Resource Name (ARN) for the endpoint.
', 'DBClusterEndpointMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the instance identifier for this member of the DB cluster.
', 'DBClusterMember$DBClusterParameterGroupStatus' => 'Specifies the status of the DB cluster parameter group for this member of the DB cluster.
', 'DBClusterMessage$Marker' => 'A pagination token that can be used in a later DescribeDBClusters request.
Specifies the name of the DB cluster option group.
', 'DBClusterOptionGroupStatus$Status' => 'Specifies the status of the DB cluster option group.
', 'DBClusterParameterGroup$DBClusterParameterGroupName' => 'The name of the DB cluster parameter group.
', 'DBClusterParameterGroup$DBParameterGroupFamily' => 'The name of the DB parameter group family that this DB cluster parameter group is compatible with.
', 'DBClusterParameterGroup$Description' => 'Provides the customer-specified description for this DB cluster parameter group.
', 'DBClusterParameterGroup$DBClusterParameterGroupArn' => 'The Amazon Resource Name (ARN) for the DB cluster parameter group.
', 'DBClusterParameterGroupDetails$Marker' => 'An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
', 'DBClusterRole$Status' => 'Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
', 'DBClusterSnapshot$DBClusterSnapshotIdentifier' => 'The identifier for the DB cluster snapshot.
', 'DBClusterSnapshot$DBClusterIdentifier' => 'The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
', 'DBClusterSnapshot$Engine' => 'The name of the database engine for this DB cluster snapshot.
', 'DBClusterSnapshot$EngineMode' => 'The engine mode of the database engine for this DB cluster snapshot.
', 'DBClusterSnapshot$Status' => 'The status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
The VPC ID associated with the DB cluster snapshot.
', 'DBClusterSnapshot$MasterUsername' => 'The master username for this DB cluster snapshot.
', 'DBClusterSnapshot$EngineVersion' => 'The version of the database engine for this DB cluster snapshot.
', 'DBClusterSnapshot$LicenseModel' => 'The license model information for this DB cluster snapshot.
', 'DBClusterSnapshot$SnapshotType' => 'The type of the DB cluster snapshot.
', 'DBClusterSnapshot$KmsKeyId' => 'If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBClusterSnapshot$DBClusterSnapshotArn' => 'The Amazon Resource Name (ARN) for the DB cluster snapshot.
', 'DBClusterSnapshot$SourceDBClusterSnapshotArn' => 'If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
', 'DBClusterSnapshot$DBSystemId' => 'Reserved for future use.
', 'DBClusterSnapshot$StorageType' => 'The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
', 'DBClusterSnapshot$DbClusterResourceId' => 'The resource ID of the DB cluster that this DB cluster snapshot was created from.
', 'DBClusterSnapshotAttribute$AttributeName' => 'The name of the manual DB cluster snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The identifier of the manual DB cluster snapshot that the attributes apply to.
', 'DBClusterSnapshotMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Reserved for future use.
', 'DBClusterStatusInfo$Status' => 'Reserved for future use.
', 'DBClusterStatusInfo$Message' => 'Reserved for future use.
', 'DBEngineVersion$Engine' => 'The name of the database engine.
', 'DBEngineVersion$EngineVersion' => 'The version number of the database engine.
', 'DBEngineVersion$DBParameterGroupFamily' => 'The name of the DB parameter group family for the database engine.
', 'DBEngineVersion$DBEngineDescription' => 'The description of the database engine.
', 'DBEngineVersion$DBEngineVersionDescription' => 'The description of the database engine version.
', 'DBEngineVersion$DBEngineMediaType' => 'A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
', 'DBEngineVersion$Status' => 'The status of the DB engine version, either available or deprecated.
The major engine version of the CEV.
', 'DBEngineVersion$DatabaseInstallationFilesS3BucketName' => 'The name of the Amazon S3 bucket that contains your database installation files.
', 'DBEngineVersion$DatabaseInstallationFilesS3Prefix' => 'The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
', 'DBEngineVersion$DBEngineVersionArn' => 'The ARN of the custom engine version.
', 'DBEngineVersion$KMSKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
', 'DBEngineVersionMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
', 'DBInstance$DBInstanceClass' => 'The name of the compute and memory capacity class of the DB instance.
', 'DBInstance$Engine' => 'The database engine used for this DB instance.
', 'DBInstance$DBInstanceStatus' => 'The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
', 'DBInstance$MasterUsername' => 'The master username for the DB instance.
', 'DBInstance$DBName' => 'The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
', 'DBInstance$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
The name of the Availability Zone where the DB instance is located.
', 'DBInstance$PreferredMaintenanceWindow' => 'The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
', 'DBInstance$EngineVersion' => 'The version of the database engine.
', 'DBInstance$ReadReplicaSourceDBInstanceIdentifier' => 'The identifier of the source DB instance if this DB instance is a read replica.
', 'DBInstance$LicenseModel' => 'The license model information for this DB instance. This setting doesn\'t apply to RDS Custom DB instances.
', 'DBInstance$CharacterSetName' => 'If present, specifies the name of the character set that this instance is associated with.
', 'DBInstance$NcharCharacterSetName' => 'The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
', 'DBInstance$SecondaryAvailabilityZone' => 'If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
', 'DBInstance$StorageType' => 'The storage type associated with the DB instance.
', 'DBInstance$TdeCredentialArn' => 'The ARN from the key store with which the instance is associated for TDE encryption.
', 'DBInstance$DBClusterIdentifier' => 'If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
', 'DBInstance$KmsKeyId' => 'If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBInstance$DbiResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
', 'DBInstance$CACertificateIdentifier' => 'The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'DBInstance$EnhancedMonitoringResourceArn' => 'The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
', 'DBInstance$MonitoringRoleArn' => 'The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
', 'DBInstance$DBInstanceArn' => 'The Amazon Resource Name (ARN) for the DB instance.
', 'DBInstance$Timezone' => 'The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBInstance$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'DBInstance$ActivityStreamKmsKeyId' => 'The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBInstance$ActivityStreamKinesisStreamName' => 'The name of the Amazon Kinesis data stream used for the database activity stream.
', 'DBInstance$CustomIamInstanceProfile' => 'The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
', 'DBInstance$BackupTarget' => 'The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
', 'DBInstance$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values: IPV4 | DUAL
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
', 'DBInstance$ReadReplicaSourceDBClusterIdentifier' => 'The identifier of the source DB cluster if this DB instance is a read replica.
', 'DBInstance$PercentProgress' => 'The progress of the storage optimization operation as a percentage.
', 'DBInstance$EngineLifecycleSupport' => 'The life cycle type for the DB instance.
For more information, see CreateDBInstance.
', 'DBInstanceAutomatedBackup$DBInstanceArn' => 'The Amazon Resource Name (ARN) for the automated backups.
', 'DBInstanceAutomatedBackup$DbiResourceId' => 'The resource ID for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBInstanceAutomatedBackup$Region' => 'The Amazon Web Services Region associated with the automated backup.
', 'DBInstanceAutomatedBackup$DBInstanceIdentifier' => 'The identifier for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBInstanceAutomatedBackup$Status' => 'A list of status information for an automated backup:
active - Automated backups for current instances.
retained - Automated backups for deleted instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
', 'DBInstanceAutomatedBackup$VpcId' => 'The VPC ID associated with the DB instance.
', 'DBInstanceAutomatedBackup$MasterUsername' => 'The master user name of an automated backup.
', 'DBInstanceAutomatedBackup$Engine' => 'The name of the database engine for this automated backup.
', 'DBInstanceAutomatedBackup$EngineVersion' => 'The version of the database engine for the automated backup.
', 'DBInstanceAutomatedBackup$LicenseModel' => 'The license model information for the automated backup.
', 'DBInstanceAutomatedBackup$OptionGroupName' => 'The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
', 'DBInstanceAutomatedBackup$TdeCredentialArn' => 'The ARN from the key store with which the automated backup is associated for TDE encryption.
', 'DBInstanceAutomatedBackup$StorageType' => 'The storage type associated with the automated backup.
', 'DBInstanceAutomatedBackup$KmsKeyId' => 'The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBInstanceAutomatedBackup$Timezone' => 'The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
The Amazon Resource Name (ARN) for the replicated automated backups.
', 'DBInstanceAutomatedBackup$BackupTarget' => 'The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
', 'DBInstanceAutomatedBackup$AwsBackupRecoveryPointArn' => 'The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
', 'DBInstanceAutomatedBackupMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the replicated automated backups.
', 'DBInstanceMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
', 'DBInstanceRole$FeatureName' => 'The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
This value is currently "read replication."
', 'DBInstanceStatusInfo$Status' => 'The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
', 'DBInstanceStatusInfo$Message' => 'Details of the error if there is an error for the instance. If the instance isn\'t in an error state, this value is blank.
', 'DBParameterGroup$DBParameterGroupName' => 'The name of the DB parameter group.
', 'DBParameterGroup$DBParameterGroupFamily' => 'The name of the DB parameter group family that this DB parameter group is compatible with.
', 'DBParameterGroup$Description' => 'Provides the customer-specified description for this DB parameter group.
', 'DBParameterGroup$DBParameterGroupArn' => 'The Amazon Resource Name (ARN) for the DB parameter group.
', 'DBParameterGroupDetails$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group.
', 'DBParameterGroupStatus$DBParameterGroupName' => 'The name of the DB parameter group.
', 'DBParameterGroupStatus$ParameterApplyStatus' => 'The status of parameter updates.
', 'DBParameterGroupsMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'DBProxy$DBProxyArn' => 'The Amazon Resource Name (ARN) for the proxy.
', 'DBProxy$EngineFamily' => 'The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.
Provides the VPC ID of the DB proxy.
', 'DBProxy$RoleArn' => 'The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
', 'DBProxy$Endpoint' => 'The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
', 'DBProxyEndpoint$DBProxyEndpointName' => 'The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
', 'DBProxyEndpoint$DBProxyEndpointArn' => 'The Amazon Resource Name (ARN) for the DB proxy endpoint.
', 'DBProxyEndpoint$DBProxyName' => 'The identifier for the DB proxy that is associated with this DB proxy endpoint.
', 'DBProxyEndpoint$VpcId' => 'Provides the VPC ID of the DB proxy endpoint.
', 'DBProxyEndpoint$Endpoint' => 'The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
', 'DBProxyTarget$TargetArn' => 'The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
', 'DBProxyTarget$Endpoint' => 'The writer endpoint for the RDS DB instance or Aurora DB cluster.
', 'DBProxyTarget$TrackedClusterId' => 'The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
', 'DBProxyTarget$RdsResourceId' => 'The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
', 'DBProxyTargetGroup$DBProxyName' => 'The identifier for the RDS proxy associated with this target group.
', 'DBProxyTargetGroup$TargetGroupName' => 'The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.
', 'DBProxyTargetGroup$TargetGroupArn' => 'The Amazon Resource Name (ARN) representing the target group.
', 'DBProxyTargetGroup$Status' => 'The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.
The unique identifier of the recommendation.
', 'DBRecommendation$TypeId' => 'A value that indicates the type of recommendation. This value determines how the description is rendered.
', 'DBRecommendation$Severity' => 'The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation.
Valid values:
high
medium
low
informational
The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.
', 'DBRecommendation$Status' => 'The current status of the recommendation.
Valid values:
active - The recommendations which are ready for you to apply.
pending - The applied or scheduled recommendations which are in progress.
resolved - The recommendations which are completed.
dismissed - The recommendations that you dismissed.
A short description of the issue identified for this recommendation. The description might contain markdown.
', 'DBRecommendation$Recommendation' => 'A short description of the recommendation to resolve an issue. The description might contain markdown.
', 'DBRecommendation$Description' => 'A detailed description of the recommendation. The description might contain markdown.
', 'DBRecommendation$Reason' => 'The reason why this recommendation was created. The information might contain markdown.
', 'DBRecommendation$Category' => 'The category of the recommendation.
Valid values:
performance efficiency
security
reliability
cost optimization
operational excellence
sustainability
The Amazon Web Services service that generated the recommendations.
', 'DBRecommendation$TypeDetection' => 'A short description of the recommendation type. The description might contain markdown.
', 'DBRecommendation$TypeRecommendation' => 'A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.
', 'DBRecommendation$Impact' => 'A short description that explains the possible impact of an issue.
', 'DBRecommendation$AdditionalInfo' => 'Additional information about the recommendation. The information might contain markdown.
', 'DBRecommendationsMessage$Marker' => 'An optional pagination token provided by a previous DBRecommendationsMessage request. This token can be used later in a DescribeDBRecomendations request.
Provides the Amazon Web Services ID of the owner of a specific DB security group.
', 'DBSecurityGroup$DBSecurityGroupName' => 'Specifies the name of the DB security group.
', 'DBSecurityGroup$DBSecurityGroupDescription' => 'Provides the description of the DB security group.
', 'DBSecurityGroup$VpcId' => 'Provides the VpcId of the DB security group.
', 'DBSecurityGroup$DBSecurityGroupArn' => 'The Amazon Resource Name (ARN) for the DB security group.
', 'DBSecurityGroupMembership$DBSecurityGroupName' => 'The name of the DB security group.
', 'DBSecurityGroupMembership$Status' => 'The status of the DB security group.
', 'DBSecurityGroupMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
', 'DBShardGroup$DBClusterIdentifier' => 'The name of the primary DB cluster for the DB shard group.
', 'DBShardGroup$Status' => 'The status of the DB shard group.
', 'DBShardGroup$Endpoint' => 'The connection endpoint for the DB shard group.
', 'DBSnapshot$DBSnapshotIdentifier' => 'Specifies the identifier for the DB snapshot.
', 'DBSnapshot$DBInstanceIdentifier' => 'Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
', 'DBSnapshot$Engine' => 'Specifies the name of the database engine.
', 'DBSnapshot$Status' => 'Specifies the status of this DB snapshot.
', 'DBSnapshot$AvailabilityZone' => 'Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
', 'DBSnapshot$VpcId' => 'Provides the VPC ID associated with the DB snapshot.
', 'DBSnapshot$MasterUsername' => 'Provides the master username for the DB snapshot.
', 'DBSnapshot$EngineVersion' => 'Specifies the version of the database engine.
', 'DBSnapshot$LicenseModel' => 'License model information for the restored DB instance.
', 'DBSnapshot$SnapshotType' => 'Provides the type of the DB snapshot.
', 'DBSnapshot$OptionGroupName' => 'Provides the option group name for the DB snapshot.
', 'DBSnapshot$SourceRegion' => 'The Amazon Web Services Region that the DB snapshot was created in or copied from.
', 'DBSnapshot$SourceDBSnapshotIdentifier' => 'The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
', 'DBSnapshot$StorageType' => 'Specifies the storage type associated with DB snapshot.
', 'DBSnapshot$TdeCredentialArn' => 'The ARN from the key store with which to associate the instance for TDE encryption.
', 'DBSnapshot$KmsKeyId' => 'If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'DBSnapshot$DBSnapshotArn' => 'The Amazon Resource Name (ARN) for the DB snapshot.
', 'DBSnapshot$Timezone' => 'The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
The identifier for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DBSnapshot$SnapshotTarget' => 'Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
', 'DBSnapshot$DBSystemId' => 'The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
', 'DBSnapshotAttribute$AttributeName' => 'The name of the manual DB snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
The identifier of the manual DB snapshot that the attributes apply to.
', 'DBSnapshotMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the snapshot of the DB instance.
', 'DBSnapshotTenantDatabase$DBInstanceIdentifier' => 'The ID for the DB instance that contains the tenant databases.
', 'DBSnapshotTenantDatabase$DbiResourceId' => 'The resource identifier of the source CDB instance. This identifier can\'t be changed and is unique to an Amazon Web Services Region.
', 'DBSnapshotTenantDatabase$EngineName' => 'The name of the database engine.
', 'DBSnapshotTenantDatabase$SnapshotType' => 'The type of DB snapshot.
', 'DBSnapshotTenantDatabase$TenantDBName' => 'The name of the tenant database.
', 'DBSnapshotTenantDatabase$MasterUsername' => 'The master username of the tenant database.
', 'DBSnapshotTenantDatabase$TenantDatabaseResourceId' => 'The resource ID of the tenant database.
', 'DBSnapshotTenantDatabase$CharacterSetName' => 'The name of the character set of a tenant database.
', 'DBSnapshotTenantDatabase$DBSnapshotTenantDatabaseARN' => 'The Amazon Resource Name (ARN) for the snapshot tenant database.
', 'DBSnapshotTenantDatabase$NcharCharacterSetName' => 'The NCHAR character set name of the tenant database.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB subnet group.
', 'DBSubnetGroup$DBSubnetGroupDescription' => 'Provides the description of the DB subnet group.
', 'DBSubnetGroup$VpcId' => 'Provides the VpcId of the DB subnet group.
', 'DBSubnetGroup$SubnetGroupStatus' => 'Provides the status of the DB subnet group.
', 'DBSubnetGroup$DBSubnetGroupArn' => 'The Amazon Resource Name (ARN) for the DB subnet group.
', 'DBSubnetGroupMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the source DB cluster, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DeleteDBClusterEndpointMessage$DBClusterEndpointIdentifier' => 'The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
', 'DeleteDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier for the DB cluster to be deleted. This parameter isn\'t case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.
Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You can\'t delete a default DB cluster parameter group.
Can\'t be associated with any DB clusters.
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
The identifier for the source DB instance, which can\'t be changed and which is unique to an Amazon Web Services Region.
', 'DeleteDBInstanceAutomatedBackupMessage$DBInstanceAutomatedBackupsArn' => 'The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn\'t apply to RDS Custom.
', 'DeleteDBInstanceMessage$DBInstanceIdentifier' => 'The DB instance identifier for the DB instance to be deleted. This parameter isn\'t case-sensitive.
Constraints:
Must match the name of an existing DB instance.
The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn\'t apply to RDS Custom.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Can\'t be specified when deleting a read replica.
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You can\'t delete a default DB parameter group
Can\'t be associated with any DB instances
The name of the DB proxy to delete.
', 'DeleteDBSecurityGroupMessage$DBSecurityGroupName' => 'The name of the DB security group to delete.
You can\'t delete the default DB security group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Must not be "Default"
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
The name of the database subnet group to delete.
You can\'t delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The name of the RDS event notification subscription you want to delete.
', 'DeleteGlobalClusterMessage$GlobalClusterIdentifier' => 'The cluster identifier of the global database cluster being deleted.
', 'DeleteOptionGroupMessage$OptionGroupName' => 'The name of the option group to be deleted.
You can\'t delete default option groups.
The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.
', 'DeleteTenantDatabaseMessage$TenantDBName' => 'The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive.
', 'DeleteTenantDatabaseMessage$FinalDBSnapshotIdentifier' => 'The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
The identifier of the DBProxyTargetGroup.
An optional pagination token provided by a previous DescribeBlueGreenDeployments request. If you specify this parameter, the response only includes records beyond the marker, up to the value specified by MaxRecords.
A pagination token that can be used in a later DescribeBlueGreenDeployments request.
The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn\'t case-sensitive.
Constraints:
Must match an existing CertificateIdentifier.
An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The resource ID of the DB cluster that is the source of the automated backup. This parameter isn\'t case-sensitive.
', 'DescribeDBClusterAutomatedBackupsMessage$DBClusterIdentifier' => '(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster\'s automated backup. This parameter isn\'t case-sensitive.
', 'DescribeDBClusterAutomatedBackupsMessage$Marker' => 'The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
If specified, this value is the backtrack identifier of the backtrack to be described.
Constraints:
Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see Universally unique identifier.
Example: 123e4567-e89b-12d3-a456-426655440000
An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
', 'DescribeDBClusterEndpointsMessage$DBClusterEndpointIdentifier' => 'The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
', 'DescribeDBClusterEndpointsMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A specific source to return parameters for.
Valid Values:
customer
engine
service
An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the DB cluster snapshot to describe the attributes for.
', 'DescribeDBClusterSnapshotsMessage$DBClusterIdentifier' => 'The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can\'t be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
A specific DB cluster snapshot identifier to describe. This parameter can\'t be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
public - Return all DB cluster snapshots that have been marked as public.
If you don\'t specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A specific DB cluster resource ID to describe.
', 'DescribeDBClustersMessage$DBClusterIdentifier' => 'The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match an existing DB cluster identifier.
An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The database engine to return version details for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
A specific database engine version to return details for.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DB parameter group family.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The resource ID of the DB instance that is the source of the automated backup. This parameter isn\'t case-sensitive.
', 'DescribeDBInstanceAutomatedBackupsMessage$DBInstanceIdentifier' => '(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance\'s automated backup. This parameter isn\'t case-sensitive.
', 'DescribeDBInstanceAutomatedBackupsMessage$Marker' => 'The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn\'t apply to RDS Custom.
', 'DescribeDBInstancesMessage$DBInstanceIdentifier' => 'The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DB instance.
An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the log file for the specified DB instance.
', 'DescribeDBLogFilesMessage$DBInstanceIdentifier' => 'The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Must match the identifier of an existing DBInstance.
Filters the available log files for log file names that contain the specified string.
', 'DescribeDBLogFilesMessage$Marker' => 'The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
', 'DescribeDBLogFilesResponse$Marker' => 'A pagination token that can be used in a later DescribeDBLogFiles request.
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
', 'DescribeDBProxiesRequest$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier of the DBProxy associated with the target group.
The identifier of the DBProxyTargetGroup to describe.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier of the DBProxyTarget to describe.
The identifier of the DBProxyTargetGroup to describe.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The language that you choose to return the list of recommendations.
Valid values:
en
en_UK
de
es
fr
id
it
ja
ko
pt_BR
zh_TW
zh_CN
An optional pagination token provided by a previous DescribeDBRecommendations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB security group to return details for.
', 'DescribeDBSecurityGroupsMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous DescribeDBShardGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A pagination token that can be used in a later DescribeDBClusters request.
The identifier for the DB snapshot to describe the attributes for.
', 'DescribeDBSnapshotTenantDatabasesMessage$DBInstanceIdentifier' => 'The ID of the DB instance used to create the DB snapshots. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.
Constraints:
If you specify this parameter, the value must match the ID of an existing DB snapshot.
If you specify an automatic snapshot, you must also specify SnapshotType.
The type of DB snapshots to be returned. You can specify one of the following values:
automated – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual – All DB snapshots that have been taken by my Amazon Web Services account.
shared – All manual DB snapshots that have been shared to my Amazon Web Services account.
public – All DB snapshots that have been marked as public.
awsbackup – All DB snapshots managed by the Amazon Web Services Backup service.
An optional pagination token provided by a previous DescribeDBSnapshotTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A specific DB resource identifier to describe.
', 'DescribeDBSnapshotsMessage$DBInstanceIdentifier' => 'The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The awsbackup type does not apply to Aurora.
If you don\'t specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.
An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A specific DB resource ID to describe.
', 'DescribeDBSubnetGroupsMessage$DBSubnetGroupName' => 'The name of the DB subnet group to return details for.
', 'DescribeDBSubnetGroupsMessage$Marker' => 'An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB cluster parameter group family to return engine parameter information for.
', 'DescribeEngineDefaultClusterParametersMessage$Marker' => 'An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group family.
Valid Values:
aurora-mysql5.7
aurora-mysql8.0
aurora-postgresql10
aurora-postgresql11
aurora-postgresql12
aurora-postgresql13
aurora-postgresql14
custom-oracle-ee-19
custom-oracle-ee-cdb-19
db2-ae
db2-se
mariadb10.2
mariadb10.3
mariadb10.4
mariadb10.5
mariadb10.6
mysql5.7
mysql8.0
oracle-ee-19
oracle-ee-cdb-19
oracle-ee-cdb-21
oracle-se2-19
oracle-se2-cdb-19
oracle-se2-cdb-21
postgres10
postgres11
postgres12
postgres13
postgres14
sqlserver-ee-11.0
sqlserver-ee-12.0
sqlserver-ee-13.0
sqlserver-ee-14.0
sqlserver-ee-15.0
sqlserver-ex-11.0
sqlserver-ex-12.0
sqlserver-ex-13.0
sqlserver-ex-14.0
sqlserver-ex-15.0
sqlserver-se-11.0
sqlserver-se-12.0
sqlserver-se-13.0
sqlserver-se-14.0
sqlserver-se-15.0
sqlserver-web-11.0
sqlserver-web-12.0
sqlserver-web-13.0
sqlserver-web-14.0
sqlserver-web-15.0
An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The name of the RDS event notification subscription you want to describe.
', 'DescribeEventSubscriptionsMessage$Marker' => 'An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
Can\'t end with a hyphen or contain two consecutive hyphens.
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier of the snapshot or cluster export task to be described.
', 'DescribeExportTasksMessage$SourceArn' => 'The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
', 'DescribeExportTasksMessage$Marker' => 'An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn\'t case-sensitive.
Constraints:
If supplied, must match an existing DBClusterIdentifier.
An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the engine to describe options for.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
If specified, filters the results to include only options for the specified major engine version.
', 'DescribeOptionGroupOptionsMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option group to describe. Can\'t be supplied together with EngineName or MajorEngineVersion.
', 'DescribeOptionGroupsMessage$Marker' => 'An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A filter to only include option groups associated with this database engine.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
', 'DescribeOrderableDBInstanceOptionsMessage$Engine' => 'The name of the database engine to describe DB instance options for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
A filter to include only the available options for the specified engine version.
', 'DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass' => 'A filter to include only the available options for the specified DB instance class.
', 'DescribeOrderableDBInstanceOptionsMessage$LicenseModel' => 'A filter to include only the available options for the specified license model.
RDS Custom supports only the BYOL licensing model.
', 'DescribeOrderableDBInstanceOptionsMessage$AvailabilityZoneGroup' => 'The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.
Omit this parameter to show the available options in the specified Amazon Web Services Region.
This setting doesn\'t apply to RDS Custom DB instances.
', 'DescribeOrderableDBInstanceOptionsMessage$Marker' => 'An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The ARN of a resource to return pending maintenance actions for.
', 'DescribePendingMaintenanceActionsMessage$Marker' => 'An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
', 'DescribeReservedDBInstancesMessage$ReservedDBInstancesOfferingId' => 'The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
', 'DescribeReservedDBInstancesMessage$DBInstanceClass' => 'The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
', 'DescribeReservedDBInstancesMessage$Duration' => 'The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
', 'DescribeReservedDBInstancesMessage$OfferingType' => 'The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
', 'DescribeReservedDBInstancesOfferingsMessage$Duration' => 'Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
The results show offerings that partially match the filter value.
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The source Amazon Web Services Region name. For example, us-east-1.
Constraints:
Must specify a valid Amazon Web Services Region name.
An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn\'t case-sensitive.
', 'DescribeTenantDatabasesMessage$TenantDBName' => 'The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.
', 'DescribeTenantDatabasesMessage$Marker' => 'An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The customer identifier or the ARN of your DB instance.
', 'DisableHttpEndpointRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the DB cluster.
', 'DisableHttpEndpointResponse$ResourceArn' => 'The ARN of the DB cluster.
', 'DocLink$Text' => 'The text with the link to documentation for the recommendation.
', 'DocLink$Url' => 'The URL for the documentation for the recommendation.
', 'DomainMembership$Domain' => 'The identifier of the Active Directory Domain.
', 'DomainMembership$Status' => 'The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
The fully qualified domain name (FQDN) of the Active Directory Domain.
', 'DomainMembership$IAMRoleName' => 'The name of the IAM role used when making API calls to the Directory Service.
', 'DomainMembership$OU' => 'The Active Directory organizational unit for the DB instance or cluster.
', 'DomainMembership$AuthSecretArn' => 'The ARN for the Secrets Manager secret with the credentials for the user that\'s a member of the domain.
', 'DownloadDBLogFilePortionDetails$LogFileData' => 'Entries from the specified log file.
', 'DownloadDBLogFilePortionDetails$Marker' => 'A pagination token that can be used in a later DownloadDBLogFilePortion request.
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Must match the identifier of an existing DBInstance.
The name of the log file to be downloaded.
', 'DownloadDBLogFilePortionMessage$Marker' => 'The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
', 'EC2SecurityGroup$Status' => 'Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
', 'EC2SecurityGroup$EC2SecurityGroupName' => 'Specifies the name of the EC2 security group.
', 'EC2SecurityGroup$EC2SecurityGroupId' => 'Specifies the id of the EC2 security group.
', 'EC2SecurityGroup$EC2SecurityGroupOwnerId' => 'Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
The Amazon Resource Name (ARN) of the DB cluster.
', 'EnableHttpEndpointResponse$ResourceArn' => 'The ARN of the DB cluster.
', 'EncryptionContextMap$key' => NULL, 'EncryptionContextMap$value' => NULL, 'Endpoint$Address' => 'Specifies the DNS address of the DB instance.
', 'Endpoint$HostedZoneId' => 'Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
', 'EngineDefaults$DBParameterGroupFamily' => 'Specifies the name of the DB parameter group family that the engine default parameters apply to.
', 'EngineDefaults$Marker' => 'An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Provides the identifier for the source of the event.
', 'Event$Message' => 'Provides the text of this event.
', 'Event$SourceArn' => 'The Amazon Resource Name (ARN) for the event.
', 'EventCategoriesList$member' => NULL, 'EventCategoriesMap$SourceType' => 'The source type that the returned categories belong to
', 'EventSubscription$CustomerAwsId' => 'The Amazon Web Services customer account associated with the RDS event notification subscription.
', 'EventSubscription$CustSubscriptionId' => 'The RDS event notification subscription Id.
', 'EventSubscription$SnsTopicArn' => 'The topic ARN of the RDS event notification subscription.
', 'EventSubscription$Status' => 'The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
', 'EventSubscription$SubscriptionCreationTime' => 'The time the RDS event notification subscription was created.
', 'EventSubscription$SourceType' => 'The source type for the RDS event notification subscription.
', 'EventSubscription$EventSubscriptionArn' => 'The Amazon Resource Name (ARN) for the event subscription.
', 'EventSubscriptionsMessage$Marker' => 'An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A unique identifier for the snapshot or cluster export task. This ID isn\'t an identifier for the Amazon S3 bucket where the data is exported.
', 'ExportTask$SourceArn' => 'The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
', 'ExportTask$S3Bucket' => 'The Amazon S3 bucket where the snapshot or cluster is exported to.
', 'ExportTask$S3Prefix' => 'The Amazon S3 bucket prefix that is the file name and path of the exported data.
', 'ExportTask$IamRoleArn' => 'The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
', 'ExportTask$KmsKeyId' => 'The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it\'s exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
', 'ExportTask$Status' => 'The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
The reason the export failed, if it failed.
', 'ExportTask$WarningMessage' => 'A warning about the snapshot or cluster export task.
', 'ExportTasksMessage$Marker' => 'A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.
The identifier of the DB cluster to force a failover for. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.
This setting isn\'t supported for RDS for MySQL Multi-AZ DB clusters.
', 'FailoverState$FromDbClusterArn' => 'The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
', 'FailoverState$ToDbClusterArn' => 'The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
', 'FeatureNameList$member' => NULL, 'Filter$Name' => 'The name of the filter. Filter names are case-sensitive.
', 'FilterValueList$member' => NULL, 'GlobalCluster$GlobalClusterIdentifier' => 'Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
', 'GlobalCluster$GlobalClusterResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
', 'GlobalCluster$GlobalClusterArn' => 'The Amazon Resource Name (ARN) for the global database cluster.
', 'GlobalCluster$Status' => 'Specifies the current state of this global database cluster.
', 'GlobalCluster$Engine' => 'The Aurora database engine used by the global database cluster.
', 'GlobalCluster$EngineVersion' => 'Indicates the database engine version.
', 'GlobalCluster$EngineLifecycleSupport' => 'The life cycle type for the global cluster.
For more information, see CreateGlobalCluster.
', 'GlobalCluster$DatabaseName' => 'The default database name within the new global database cluster.
', 'GlobalClusterMember$DBClusterArn' => 'The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
', 'GlobalClustersMessage$Marker' => 'An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
', 'IPRange$CIDRIP' => 'The IP range.
', 'Integration$KMSKeyId' => 'The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
', 'IntegrationError$ErrorCode' => 'The error code associated with the integration.
', 'IntegrationError$ErrorMessage' => 'A message explaining the error.
', 'KeyList$member' => NULL, 'ListTagsForResourceMessage$ResourceName' => 'The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
', 'LogTypeList$member' => NULL, 'MasterUserSecret$SecretArn' => 'The Amazon Resource Name (ARN) of the secret.
', 'MasterUserSecret$SecretStatus' => 'The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can\'t be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.
When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
', 'Metric$Name' => 'The name of a metric.
', 'Metric$StatisticsDetails' => 'The details of different statistics for a metric. The description might contain markdown.
', 'MetricReference$Name' => 'The name of the metric reference.
', 'MinimumEngineVersionPerAllowedValue$AllowedValue' => 'The allowed value for an option setting.
', 'MinimumEngineVersionPerAllowedValue$MinimumEngineVersion' => 'The minimum DB engine version required for the allowed value.
', 'ModifyActivityStreamRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example, arn:aws:rds:us-east-1:12345667890:db:my-orcl-db.
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
', 'ModifyActivityStreamResponse$KinesisStreamName' => 'The name of the Amazon Kinesis data stream to be used for the database activity stream.
', 'ModifyCertificatesMessage$CertificateIdentifier' => 'The new default certificate identifier to override the current one with.
To determine the valid values, use the describe-certificates CLI command or the DescribeCertificates API operation.
The DB cluster identifier for the cluster being modified. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn\'t found in the timeout period.
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
', 'ModifyDBClusterEndpointMessage$EndpointType' => 'The type of the endpoint. One of: READER, WRITER, ANY.
The DB cluster identifier for the cluster being modified. This parameter isn\'t case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$MasterUserPassword' => 'The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can\'t be specified if ManageMasterUserPassword is turned on.
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can\'t be modified.
', 'ModifyDBClusterMessage$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
If the cluster that you\'re modifying has one or more read replicas, all replicas must be running an engine version that\'s the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$DBInstanceParameterGroupName' => 'The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn\'t rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$DBClusterInstanceClass' => 'The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$StorageType' => 'The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don\'t specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
', 'ModifyDBClusterMessage$NetworkType' => 'The network type of the DB cluster.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn\'t manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can\'t change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBClusterMessage$EngineMode' => 'The DB engine mode of the DB cluster, either provisioned or serverless.
The DB engine mode can be modified only from serverless to provisioned.
For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
', 'ModifyDBClusterMessage$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB cluster\'s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
', 'ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName' => 'The name of the DB cluster parameter group to modify.
', 'ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier' => 'The identifier for the DB cluster snapshot to modify the attributes for.
', 'ModifyDBClusterSnapshotAttributeMessage$AttributeName' => 'The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.
The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify ApplyImmediately in your request.
Default: Uses existing setting
Constraints:
If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn\'t in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
Example: mydbsubnetgroup
The new password for the master user.
Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Amazon RDS API operations never return the password, so this operation provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.)
RDS Custom
Default: Uses existing setting
Constraints:
Can\'t be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can\'t include the "&" (ampersand) or the "\'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn\'t result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn\'t rebooted automatically, and the parameter changes aren\'t applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn\'t apply to RDS Custom DB instances.
Default: Uses existing setting
Constraints:
Must be in the same DB parameter group family as the DB instance.
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
This setting doesn\'t apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, which might result in an outage. Changing this parameter doesn\'t result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter causes a reboot of the DB instance. If you change this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
If the instance that you\'re modifying is acting as a read replica, the engine version that you specify must be the same or higher than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.
Constraints:
If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
The license model for the DB instance.
This setting doesn\'t apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
The option group to associate the DB instance with.
Changing this parameter doesn\'t result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren\'t interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance after it is associated with a DB instance.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$NewDBInstanceIdentifier' => 'The new identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable ApplyImmediately. This value is stored as a lowercase string.
This setting doesn\'t apply to RDS Custom DB instances.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The storage type to associate with the DB instance.
If you specify io1, io2, or gp3 you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$TdeCredentialPassword' => 'The password for the given ARN from the key store in order to access the device.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'ModifyDBInstanceMessage$Domain' => 'The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$DomainFqdn' => 'The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don\'t specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn\'t apply to RDS Custom DB instances.
', 'ModifyDBInstanceMessage$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values: IPV4 | DUAL
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn\'t manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can\'t change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
', 'ModifyDBInstanceMessage$Engine' => 'The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can\'t convert a CDB to a non-CDB.
You can\'t convert a replica database.
You can\'t convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can\'t convert the existing custom parameter or option group when it has options or parameters that are permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To avoid reverting to the default, specify a new parameter group with --db-parameter-group-name and a new option group with --option-group-name.
The name of the DB parameter group.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
The identifier for the DBProxy to modify.
The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
', 'ModifyDBProxyTargetGroupRequest$TargetGroupName' => 'The name of the target group to modify.
', 'ModifyDBProxyTargetGroupRequest$DBProxyName' => 'The name of the proxy.
', 'ModifyDBProxyTargetGroupRequest$NewName' => 'The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.
The identifier of the recommendation to update.
', 'ModifyDBRecommendationMessage$Locale' => 'The language of the modified recommendation.
', 'ModifyDBRecommendationMessage$Status' => 'The recommendation status to update.
Valid values:
active
dismissed
The identifier for the DB snapshot to modify the attributes for.
', 'ModifyDBSnapshotAttributeMessage$AttributeName' => 'The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
The identifier of the DB snapshot to modify.
', 'ModifyDBSnapshotMessage$EngineVersion' => 'The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.
Oracle
19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots)
19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots)
12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.
', 'ModifyDBSnapshotMessage$OptionGroupName' => 'The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.
', 'ModifyDBSubnetGroupMessage$DBSubnetGroupName' => 'The name for the DB subnet group. This value is stored as a lowercase string. You can\'t modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The description for the DB subnet group.
', 'ModifyEventSubscriptionMessage$SubscriptionName' => 'The name of the RDS event notification subscription.
', 'ModifyEventSubscriptionMessage$SnsTopicArn' => 'The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
', 'ModifyEventSubscriptionMessage$SourceType' => 'The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn\'t specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
The cluster identifier for the global cluster to modify. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster.
The new cluster identifier for the global database cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
The version number of the database engine to which you want to upgrade.
To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query \'*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]\'
To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query \'*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]\'
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance
', 'ModifyTenantDatabaseMessage$DBInstanceIdentifier' => 'The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DB instance.
The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.
Constraints:
Must match the identifier of an existing tenant database.
The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.
Constraints:
Can\'t be the string null or any other reserved word.
Can\'t be longer than 8 characters.
The name of the option.
', 'Option$OptionDescription' => 'The description of the option.
', 'Option$OptionVersion' => 'The version of the option.
', 'OptionConfiguration$OptionName' => 'The configuration of options to include in a group.
', 'OptionConfiguration$OptionVersion' => 'The version for the option.
', 'OptionGroup$OptionGroupName' => 'Specifies the name of the option group.
', 'OptionGroup$OptionGroupDescription' => 'Provides a description of the option group.
', 'OptionGroup$EngineName' => 'Indicates the name of the engine that this option group can be applied to.
', 'OptionGroup$MajorEngineVersion' => 'Indicates the major engine version associated with this option group.
', 'OptionGroup$VpcId' => 'If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
Specifies the Amazon Resource Name (ARN) for the option group.
', 'OptionGroup$SourceOptionGroup' => 'Specifies the name of the option group from which this option group is copied.
', 'OptionGroup$SourceAccountId' => 'Specifies the Amazon Web Services account ID for the option group from which this option group is copied.
', 'OptionGroupMembership$OptionGroupName' => 'The name of the option group that the instance belongs to.
', 'OptionGroupMembership$Status' => 'The status of the DB instance\'s option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.
The name of the option.
', 'OptionGroupOption$Description' => 'The description of the option.
', 'OptionGroupOption$EngineName' => 'The name of the engine that this option can be applied to.
', 'OptionGroupOption$MajorEngineVersion' => 'Indicates the major engine version that the option is available for.
', 'OptionGroupOption$MinimumRequiredMinorEngineVersion' => 'The minimum required engine version for the option to be applied.
', 'OptionGroupOptionSetting$SettingName' => 'The name of the option group option.
', 'OptionGroupOptionSetting$SettingDescription' => 'The description of the option group option.
', 'OptionGroupOptionSetting$DefaultValue' => 'The default value for the option group option.
', 'OptionGroupOptionSetting$ApplyType' => 'The DB engine specific parameter type for the option group option.
', 'OptionGroupOptionSetting$AllowedValues' => 'Indicates the acceptable values for the option group option.
', 'OptionGroupOptionsMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option that has settings that you can set.
', 'OptionSetting$Value' => 'The current value of the option setting.
', 'OptionSetting$DefaultValue' => 'The default value of the option setting.
', 'OptionSetting$Description' => 'The description of the option setting.
', 'OptionSetting$ApplyType' => 'The DB engine specific parameter type.
', 'OptionSetting$DataType' => 'The data type of the option setting.
', 'OptionSetting$AllowedValues' => 'The allowed values of the option setting.
', 'OptionVersion$Version' => 'The version of the option.
', 'OptionsConflictsWith$member' => NULL, 'OptionsDependedOn$member' => NULL, 'OrderableDBInstanceOption$Engine' => 'The engine type of a DB instance.
', 'OrderableDBInstanceOption$EngineVersion' => 'The engine version of a DB instance.
', 'OrderableDBInstanceOption$DBInstanceClass' => 'The DB instance class for a DB instance.
', 'OrderableDBInstanceOption$LicenseModel' => 'The license model for a DB instance.
', 'OrderableDBInstanceOption$AvailabilityZoneGroup' => 'The Availability Zone group for a DB instance.
', 'OrderableDBInstanceOption$StorageType' => 'The storage type for a DB instance.
', 'OrderableDBInstanceOptionsMessage$Marker' => 'An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the Outpost.
', 'Parameter$ParameterName' => 'The name of the parameter.
', 'Parameter$ParameterValue' => 'The value of the parameter.
', 'Parameter$Description' => 'Provides a description of the parameter.
', 'Parameter$Source' => 'The source of the parameter value.
', 'Parameter$ApplyType' => 'Specifies the engine specific parameters type.
', 'Parameter$DataType' => 'Specifies the valid data type for the parameter.
', 'Parameter$AllowedValues' => 'Specifies the valid range of values for the parameter.
', 'Parameter$MinimumEngineVersion' => 'The earliest engine version to which the parameter can apply.
', 'PendingMaintenanceAction$Action' => 'The type of pending maintenance action that is available for the resource.
For more information about maintenance actions, see Maintaining a DB instance.
Valid Values: system-update | db-upgrade | hardware-maintenance | ca-certificate-rotation
Indicates the type of opt-in request that has been received for the resource.
', 'PendingMaintenanceAction$Description' => 'A description providing more detail about the maintenance action.
', 'PendingMaintenanceActionsMessage$Marker' => 'An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
The name of the compute and memory capacity class for the DB instance.
', 'PendingModifiedValues$MasterUserPassword' => 'The master credentials for the DB instance.
', 'PendingModifiedValues$EngineVersion' => 'The database engine version.
', 'PendingModifiedValues$LicenseModel' => 'The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
The database identifier for the DB instance.
', 'PendingModifiedValues$StorageType' => 'The storage type of the DB instance.
', 'PendingModifiedValues$CACertificateIdentifier' => 'The identifier of the CA certificate for the DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'PendingModifiedValues$DBSubnetGroupName' => 'The DB subnet group for the DB instance.
', 'PendingModifiedValues$Engine' => 'The database engine of the DB instance.
', 'PerformanceInsightsMetricDimensionGroup$Group' => 'The available dimension groups for Performance Insights metric type.
', 'PerformanceInsightsMetricQuery$Metric' => 'The name of a Performance Insights metric to be measured.
Valid Values:
db.load.avg - A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg - The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
The analysis of the performance issue. The information might contain markdown.
', 'ProcessorFeature$Name' => 'The name of the processor feature. Valid names are coreCount and threadsPerCore.
The value of a processor feature name.
', 'PromoteReadReplicaDBClusterMessage$DBClusterIdentifier' => 'The identifier of the DB cluster read replica to promote. This parameter isn\'t case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster read replica.
Example: my-cluster-replica1
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing read replica DB instance.
Example: mydbinstance
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
', 'PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId' => 'Customer-specified identifier to track this reservation.
Example: myreservationID
', 'RdsCustomClusterConfiguration$InterconnectSubnetId' => 'Reserved for future use.
', 'RdsCustomClusterConfiguration$TransitGatewayMulticastDomainId' => 'Reserved for future use.
', 'ReadReplicaDBClusterIdentifierList$member' => NULL, 'ReadReplicaDBInstanceIdentifierList$member' => NULL, 'ReadReplicaIdentifierList$member' => NULL, 'ReadersArnList$member' => NULL, 'RebootDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBCluster.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
The unique identifier of the recommended action.
', 'RecommendedAction$Title' => 'A short description to summarize the action. The description might contain markdown.
', 'RecommendedAction$Description' => 'A detailed description of the action. The description might contain markdown.
', 'RecommendedAction$Operation' => 'An API operation for the action.
', 'RecommendedAction$Status' => 'The status of the action.
ready
applied
scheduled
resolved
The key of the parameter to use with the RecommendedAction API operation.
The value of the parameter to use with the RecommendedAction API operation.
A unique identifier of the updated recommendation action.
', 'RecommendedActionUpdate$Status' => 'The status of the updated recommendation action.
applied
scheduled
The frequency of the recurring charge.
', 'RegisterDBProxyTargetsRequest$DBProxyName' => 'The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
The identifier of the DBProxyTargetGroup.
The cluster identifier to detach from the Aurora global database cluster.
', 'RemoveFromGlobalClusterMessage$DbClusterIdentifier' => 'The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.
', 'RemoveRoleFromDBClusterMessage$DBClusterIdentifier' => 'The name of the DB cluster to disassociate the IAM role from.
', 'RemoveRoleFromDBClusterMessage$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
', 'RemoveRoleFromDBInstanceMessage$DBInstanceIdentifier' => 'The name of the DB instance to disassociate the IAM role from.
', 'RemoveRoleFromDBInstanceMessage$RoleArn' => 'The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example, arn:aws:iam::123456789012:role/AccessRole.
The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
The name of the RDS event notification subscription you want to remove a source identifier from.
', 'RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier' => 'The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
', 'RemoveTagsFromResourceMessage$ResourceName' => 'The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
', 'ReservedDBInstance$ReservedDBInstanceId' => 'The unique identifier for the reservation.
', 'ReservedDBInstance$ReservedDBInstancesOfferingId' => 'The offering identifier.
', 'ReservedDBInstance$DBInstanceClass' => 'The DB instance class for the reserved DB instance.
', 'ReservedDBInstance$CurrencyCode' => 'The currency code for the reserved DB instance.
', 'ReservedDBInstance$ProductDescription' => 'The description of the reserved DB instance.
', 'ReservedDBInstance$OfferingType' => 'The offering type of this reserved DB instance.
', 'ReservedDBInstance$State' => 'The state of the reserved DB instance.
', 'ReservedDBInstance$ReservedDBInstanceArn' => 'The Amazon Resource Name (ARN) for the reserved DB instance.
', 'ReservedDBInstance$LeaseId' => 'The unique identifier for the lease associated with the reserved DB instance.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The offering identifier.
', 'ReservedDBInstancesOffering$DBInstanceClass' => 'The DB instance class for the reserved DB instance.
', 'ReservedDBInstancesOffering$CurrencyCode' => 'The currency code for the reserved DB instance offering.
', 'ReservedDBInstancesOffering$ProductDescription' => 'The database engine used by the offering.
', 'ReservedDBInstancesOffering$OfferingType' => 'The offering type.
', 'ReservedDBInstancesOfferingMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB cluster parameter group to reset.
', 'ResetDBParameterGroupMessage$DBParameterGroupName' => 'The name of the DB parameter group.
Constraints:
Must match the name of an existing DBParameterGroup.
The ARN of the resource that has pending maintenance actions.
', 'RestoreDBClusterFromS3Message$CharacterSetName' => 'A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
', 'RestoreDBClusterFromS3Message$DatabaseName' => 'The database name for the restored DB cluster.
', 'RestoreDBClusterFromS3Message$DBClusterIdentifier' => 'The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn\'t case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The name of the database engine to be used for this DB cluster.
Valid Values: aurora-mysql (for Aurora MySQL)
The version number of the database engine to use.
To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints:
Must contain from 8 to 41 characters.
Can\'t be specified if ManageMasterUserPassword is turned on.
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can\'t be removed from an option group. An option group can\'t be removed from a DB cluster once it is associated with a DB cluster.
', 'RestoreDBClusterFromS3Message$PreferredBackupWindow' => 'The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
', 'RestoreDBClusterFromS3Message$KmsKeyId' => 'The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid Values: mysql
The version of the database that the backup files were created from.
MySQL versions 5.7 and 8.0 are supported.
Example: 5.7.40, 8.0.28
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
', 'RestoreDBClusterFromS3Message$S3Prefix' => 'The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
', 'RestoreDBClusterFromS3Message$S3IngestionRoleArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
', 'RestoreDBClusterFromS3Message$Domain' => 'Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
', 'RestoreDBClusterFromS3Message$DomainIAMRoleName' => 'Specify the name of the IAM role to be used when making API calls to the Directory Service.
', 'RestoreDBClusterFromS3Message$NetworkType' => 'The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
', 'RestoreDBClusterFromS3Message$MasterUserSecretKmsKeyId' => 'The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
', 'RestoreDBClusterFromS3Message$StorageType' => 'Specifies the storage type to be associated with the DB cluster.
Valid Values: aurora, aurora-iopt1
Default: aurora
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromS3Message$EngineLifecycleSupport' => 'The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn\'t case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier' => 'The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$Engine' => 'The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$EngineVersion' => 'The version of the database engine to use for the new DB cluster. If you don\'t specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName' => 'The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$DatabaseName' => 'The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$OptionGroupName' => 'The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can\'t be modified.
', 'RestoreDBClusterFromSnapshotMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When you don\'t specify a value for the KmsKeyId parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn\'t encrypted, then the restored DB cluster isn\'t encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$EngineMode' => 'The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$DBClusterParameterGroupName' => 'The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$Domain' => 'The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$DomainIAMRoleName' => 'The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$DBClusterInstanceClass' => 'The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$StorageType' => 'Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterFromSnapshotMessage$NetworkType' => 'The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterFromSnapshotMessage$EngineLifecycleSupport' => 'The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can\'t end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$RestoreType' => 'The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
If you don\'t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier' => 'The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$DBSubnetGroupName' => 'The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$OptionGroupName' => 'The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can\'t be modified.
', 'RestoreDBClusterToPointInTimeMessage$KmsKeyId' => 'The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you don\'t specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn\'t encrypted, then the restored DB cluster isn\'t encrypted.
If DBClusterIdentifier refers to a DB cluster that isn\'t encrypted, then the restore request is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$DBClusterParameterGroupName' => 'The name of the custom DB cluster parameter group to associate with this DB cluster.
If the DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$Domain' => 'The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$DomainIAMRoleName' => 'The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$EngineMode' => 'The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$DBClusterInstanceClass' => 'The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$StorageType' => 'Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$NetworkType' => 'The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
', 'RestoreDBClusterToPointInTimeMessage$SourceDbClusterResourceId' => 'The resource ID of the source DB cluster from which to restore.
', 'RestoreDBClusterToPointInTimeMessage$EngineLifecycleSupport' => 'The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB instance to create from the DB snapshot. This parameter isn\'t case-sensitive.
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DB snapshot.
Can\'t be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn\'t specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
', 'RestoreDBInstanceFromDBSnapshotMessage$AvailabilityZone' => 'The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The name of the DB subnet group to use for the new instance.
Constraints:
If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
License model information for the restored DB instance.
This setting doesn\'t apply to RDS Custom.
Default: Same as source.
Valid Values: license-included | bring-your-own-license | general-public-license
The name of the database for the restored DB instance.
This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn\'t apply to the other engines or to RDS Custom DB instances.
', 'RestoreDBInstanceFromDBSnapshotMessage$Engine' => 'The database engine to use for the new instance.
This setting doesn\'t apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance after it is associated with a DB instance.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$StorageType' => 'Specifies the storage type to be associated with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialPassword' => 'The password for the given ARN from the key store in order to access the device.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$Domain' => 'The Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$DomainFqdn' => 'The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
Can\'t be longer than 64 characters.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to RDS Custom DB instances.
', 'RestoreDBInstanceFromDBSnapshotMessage$DBParameterGroupName' => 'The name of the DB parameter group to associate with this DB instance.
If you don\'t specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.
This setting doesn\'t apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DB parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
', 'RestoreDBInstanceFromDBSnapshotMessage$BackupTarget' => 'Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromDBSnapshotMessage$NetworkType' => 'The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromDBSnapshotMessage$DBClusterSnapshotIdentifier' => 'The identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can\'t be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn\'t specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can\'t be the identifier of an Aurora DB cluster snapshot.
The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'RestoreDBInstanceFromDBSnapshotMessage$EngineLifecycleSupport' => 'The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn\'t supported on the db.t2.micro DB instance class.
', 'RestoreDBInstanceFromS3Message$Engine' => 'The name of the database engine to be used for this instance.
Valid Values: mysql
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can\'t be a reserved word for the chosen database engine.
The password for the master user.
Constraints:
Can\'t be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can\'t include the "&" (ampersand) or the "\'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can\'t be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
The license model for this DB instance. Use general-public-license.
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
', 'RestoreDBInstanceFromS3Message$StorageType' => 'Specifies the storage type to be associated with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The name of the engine of your source database.
Valid Values: mysql
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
The name of your Amazon S3 bucket that contains your database backup file.
', 'RestoreDBInstanceFromS3Message$S3Prefix' => 'The prefix of your Amazon S3 bucket.
', 'RestoreDBInstanceFromS3Message$S3IngestionRoleArn' => 'An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
', 'RestoreDBInstanceFromS3Message$PerformanceInsightsKMSKeyId' => 'The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'RestoreDBInstanceFromS3Message$MasterUserSecretKmsKeyId' => 'The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don\'t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can\'t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
', 'RestoreDBInstanceFromS3Message$CACertificateIdentifier' => 'The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'RestoreDBInstanceFromS3Message$EngineLifecycleSupport' => 'The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
The name of the new DB instance to create.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DB instance class as the original DB instance.
', 'RestoreDBInstanceToPointInTimeMessage$AvailabilityZone' => 'The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraints:
You can\'t specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints:
If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
The license model information for the restored DB instance.
This setting doesn\'t apply to RDS Custom.
Valid Values: license-included | bring-your-own-license | general-public-license
Default: Same as the source.
', 'RestoreDBInstanceToPointInTimeMessage$DBName' => 'The database name for the restored DB instance.
This parameter doesn\'t apply to the following DB instances:
RDS Custom
RDS for Db2
RDS for MariaDB
RDS for MySQL
The database engine to use for the new instance.
This setting doesn\'t apply to RDS Custom.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Default: The same as source
Constraints:
Must be compatible with the engine of the source.
The name of the option group to use for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance after it is associated with a DB instance
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$StorageType' => 'The storage type to associate with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
Constraints:
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$TdeCredentialPassword' => 'The password for the given ARN from the key store in order to access the device.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$Domain' => 'The Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn\'t apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$DomainIAMRoleName' => 'The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn\'t apply to RDS Custom DB instances.
', 'RestoreDBInstanceToPointInTimeMessage$DomainFqdn' => 'The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can\'t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can\'t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
Can\'t be longer than 64 characters.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
This setting doesn\'t apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DB parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can\'t end with a hyphen or contain two consecutive hyphens.
The resource ID of the source DB instance from which to restore.
', 'RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceAutomatedBackupsArn' => 'The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn\'t apply to RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$CustomIamInstanceProfile' => 'The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
', 'RestoreDBInstanceToPointInTimeMessage$BackupTarget' => 'The location for storing automated backups and manual snapshots for the restored DB instance.
Valid Values:
outposts (Amazon Web Services Outposts)
region (Amazon Web Services Region)
Default: region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$NetworkType' => 'The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values:
IPV4
DUAL
The CA certificate identifier to use for the DB instance\'s server certificate.
This setting doesn\'t apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$EngineLifecycleSupport' => 'The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB security group to revoke ingress from.
', 'RevokeDBSecurityGroupIngressMessage$CIDRIP' => 'The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can\'t be provided.
The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn\'t an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn\'t found in the timeout period.
If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
', 'ScalingConfigurationInfo$TimeoutAction' => 'The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn\'t found in the timeout period.
The name of the source Amazon Web Services Region.
', 'SourceRegion$Endpoint' => 'The endpoint for the source Amazon Web Services Region endpoint.
', 'SourceRegion$Status' => 'The status of the source Amazon Web Services Region.
', 'SourceRegionMessage$Marker' => 'An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'StartActivityStreamResponse$KmsKeyId' => 'The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
', 'StartActivityStreamResponse$KinesisStreamName' => 'The name of the Amazon Kinesis data stream to be used for the database activity stream.
', 'StartDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
', 'StartDBInstanceAutomatedBackupsReplicationMessage$SourceDBInstanceArn' => 'The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It\'s ignored in other Amazon Web Services Regions.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
The user-supplied instance identifier.
', 'StartExportTaskMessage$ExportTaskIdentifier' => 'A unique identifier for the export task. This ID isn\'t an identifier for the Amazon S3 bucket where the data is to be exported.
', 'StartExportTaskMessage$SourceArn' => 'The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
', 'StartExportTaskMessage$S3BucketName' => 'The name of the Amazon S3 bucket to export the snapshot or cluster data to.
', 'StartExportTaskMessage$IamRoleArn' => 'The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
s3:PutObject*
s3:GetObject*
s3:ListBucket
s3:DeleteObject*
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
arn:aws:s3:::your-s3-bucket
arn:aws:s3:::your-s3-bucket/*
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:Encrypt
kms:Decrypt
kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext
kms:ReEncryptFrom
kms:ReEncryptTo
kms:CreateGrant
kms:DescribeKey
kms:RetireGrant
The Amazon S3 bucket prefix to use as the file name and path of the exported data.
', 'StopActivityStreamRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
', 'StopActivityStreamResponse$KinesisStreamName' => 'The name of the Amazon Kinesis data stream used for the database activity stream.
', 'StopDBClusterMessage$DBClusterIdentifier' => 'The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
', 'StopDBInstanceAutomatedBackupsReplicationMessage$SourceDBInstanceArn' => 'The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automate backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
The user-supplied instance identifier.
', 'StopDBInstanceMessage$DBSnapshotIdentifier' => 'The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
', 'StringList$member' => NULL, 'Subnet$SubnetIdentifier' => 'The identifier of the subnet.
', 'Subnet$SubnetStatus' => 'The status of the subnet.
', 'SubnetIdentifierList$member' => NULL, 'SwitchoverReadReplicaMessage$DBInstanceIdentifier' => 'The DB instance identifier of the current standby database. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing Oracle read replica DB instance.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can\'t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can\'t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$").
A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.
The ID of the DB instance that contains the tenant database.
', 'TenantDatabase$TenantDBName' => 'The database name of the tenant database.
', 'TenantDatabase$Status' => 'The status of the tenant database.
', 'TenantDatabase$MasterUsername' => 'The master username of the tenant database.
', 'TenantDatabase$DbiResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the DB instance.
', 'TenantDatabase$TenantDatabaseResourceId' => 'The Amazon Web Services Region-unique, immutable identifier for the tenant database.
', 'TenantDatabase$TenantDatabaseARN' => 'The Amazon Resource Name (ARN) for the tenant database.
', 'TenantDatabase$CharacterSetName' => 'The character set of the tenant database.
', 'TenantDatabase$NcharCharacterSetName' => 'The NCHAR character set name of the tenant database.
The name of the tenant database.
', 'TenantDatabasesMessage$Marker' => 'An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the time zone.
', 'UpgradeTarget$Engine' => 'The name of the upgrade target database engine.
', 'UpgradeTarget$EngineVersion' => 'The version number of the upgrade target database engine.
', 'UpgradeTarget$Description' => 'The version of the database engine that a DB instance can be upgraded to.
', 'UserAuthConfig$Description' => 'A user-specified description about the authentication used by a proxy to log in as a specific database user.
', 'UserAuthConfig$UserName' => 'The name of the database user to which the proxy connects.
', 'UserAuthConfig$SecretArn' => 'The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
', 'UserAuthConfigInfo$Description' => 'A user-specified description about the authentication used by a proxy to log in as a specific database user.
', 'UserAuthConfigInfo$UserName' => 'The name of the database user to which the proxy connects.
', 'UserAuthConfigInfo$SecretArn' => 'The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
', 'ValidStorageOptions$StorageType' => 'The valid storage types for your DB instance. For example: gp2, gp3, io1, io2.
', 'VpcSecurityGroupIdList$member' => NULL, 'VpcSecurityGroupMembership$VpcSecurityGroupId' => 'The name of the VPC security group.
', 'VpcSecurityGroupMembership$Status' => 'The membership status of the VPC security group.
Currently, the only valid status is active.
The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn\'t specified, no prefix is assumed.
The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
', 'CreateCustomDBEngineVersionMessage$SourceCustomDbEngineVersionIdentifier' => 'The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can\'t specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.
Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.
Default: no session pinning filters
', 'ConnectionPoolConfigurationInfo$SessionPinningFilters' => 'Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
List of DB instance identifiers that are part of the custom endpoint group.
', 'CreateDBClusterEndpointMessage$ExcludedMembers' => 'List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.
', 'CreateDBInstanceMessage$DomainDnsIps' => 'The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
', 'CreateDBProxyEndpointRequest$VpcSecurityGroupIds' => 'The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
', 'CreateDBProxyRequest$VpcSubnetIds' => 'One or more VPC subnet IDs to associate with the new proxy.
', 'CreateDBProxyRequest$VpcSecurityGroupIds' => 'One or more VPC security group IDs to associate with the new proxy.
', 'DBCluster$CustomEndpoints' => 'The custom endpoints associated with the DB cluster.
', 'DBClusterEndpoint$StaticMembers' => 'List of DB instance identifiers that are part of the custom endpoint group.
', 'DBClusterEndpoint$ExcludedMembers' => 'List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
', 'DBProxy$VpcSecurityGroupIds' => 'Provides a list of VPC security groups that the proxy belongs to.
', 'DBProxy$VpcSubnetIds' => 'The EC2 subnet IDs for the proxy.
', 'DBProxyEndpoint$VpcSecurityGroupIds' => 'Provides a list of VPC security groups that the DB proxy endpoint belongs to.
', 'DBProxyEndpoint$VpcSubnetIds' => 'The EC2 subnet IDs for the DB proxy endpoint.
', 'DBSubnetGroup$SupportedNetworkTypes' => 'The network type of the DB subnet group.
Valid values:
IPV4
DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'DeregisterDBProxyTargetsRequest$DBInstanceIdentifiers' => 'One or more DB instance identifiers.
', 'DeregisterDBProxyTargetsRequest$DBClusterIdentifiers' => 'One or more DB cluster identifiers.
', 'DomainMembership$DnsIps' => 'The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
', 'ExportTask$ExportOnly' => 'The data exported from the snapshot or cluster.
Valid Values:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
List of DB instance identifiers that are part of the custom endpoint group.
', 'ModifyDBClusterEndpointMessage$ExcludedMembers' => 'List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
', 'ModifyDBInstanceMessage$DomainDnsIps' => 'The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.
', 'ModifyDBProxyRequest$SecurityGroups' => 'The new list of security groups for the DBProxy.
The network types supported by the DB instance (IPV4 or DUAL).
A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
', 'PerformanceInsightsMetricDimensionGroup$Dimensions' => 'A list of specific dimensions from a dimension group. If this list isn\'t included, then all of the dimensions in the group were requested, or are present in the response.
', 'RecommendedAction$ApplyModes' => 'The methods to apply the recommended action.
Valid values:
manual - The action requires you to resolve the recommendation manually.
immediately - The action is applied immediately.
next-maintainance-window - The action is applied during the next scheduled maintainance.
One or more DB instance identifiers.
', 'RegisterDBProxyTargetsRequest$DBClusterIdentifiers' => 'One or more DB cluster identifiers.
', 'RestoreDBInstanceFromDBSnapshotMessage$DomainDnsIps' => 'The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn\'t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The data to be exported from the snapshot or cluster. If this parameter isn\'t provided, all of the data is exported.
Valid Values:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
This data type is used as a response element for the DescribeDBSubnetGroups operation.
The DB subnet is already in use in the Availability Zone.
', 'refs' => [], ], 'SubnetIdentifierList' => [ 'base' => NULL, 'refs' => [ 'CreateDBSubnetGroupMessage$SubnetIds' => 'The EC2 Subnet IDs for the DB subnet group.
', 'ModifyDBSubnetGroupMessage$SubnetIds' => 'The EC2 subnet IDs for the DB subnet group.
', ], ], 'SubnetList' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroup$Subnets' => 'Contains a list of Subnet elements.
The supplied subscription name already exists.
', 'refs' => [], ], 'SubscriptionCategoryNotFoundFault' => [ 'base' => 'The supplied category does not exist.
', 'refs' => [], ], 'SubscriptionNotFoundFault' => [ 'base' => 'The subscription name does not exist.
', 'refs' => [], ], 'SupportedCharacterSetsList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedCharacterSets' => 'A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
Contains the details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
', 'refs' => [ 'SwitchoverDetailList$member' => NULL, ], ], 'SwitchoverDetailList' => [ 'base' => NULL, 'refs' => [ 'BlueGreenDeployment$SwitchoverDetails' => 'The details about each source and target resource in the blue/green deployment.
', ], ], 'SwitchoverDetailStatus' => [ 'base' => NULL, 'refs' => [ 'SwitchoverDetail$Status' => 'The switchover status of a resource in a blue/green deployment.
Values:
PROVISIONING - The resource is being prepared to switch over.
AVAILABLE - The resource is ready to switch over.
SWITCHOVER_IN_PROGRESS - The resource is being switched over.
SWITCHOVER_COMPLETED - The resource has been switched over.
SWITCHOVER_FAILED - The resource attempted to switch over but failed.
MISSING_SOURCE - The source resource has been deleted.
MISSING_TARGET - The target resource has been deleted.
The amount of time, in seconds, for the switchover to complete.
Default: 300
If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.
', ], ], 'TStamp' => [ 'base' => NULL, 'refs' => [ 'BacktrackDBClusterMessage$BacktrackTo' => 'The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.
If the specified time isn\'t a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.
Constraints:
Must contain a valid ISO 8601 timestamp.
Can\'t contain a timestamp set in the future.
Example: 2017-07-08T18:00Z
The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).
', 'BlueGreenDeployment$DeleteTime' => 'The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).
', 'Certificate$ValidFrom' => 'The starting date from which the certificate is valid.
', 'Certificate$ValidTill' => 'The final date that the certificate continues to be valid.
', 'Certificate$CustomerOverrideValidTill' => 'If there is an override for the default certificate identifier, when the override expires.
', 'CertificateDetails$ValidTill' => 'The expiration date of the DB instance’s server certificate.
', 'DBCluster$AutomaticRestartTime' => 'The time when a stopped DB cluster is restarted automatically.
', 'DBCluster$EarliestRestorableTime' => 'The earliest time to which a database can be restored with point-in-time restore.
', 'DBCluster$LatestRestorableTime' => 'The latest time to which a database can be restored with point-in-time restore.
', 'DBCluster$ClusterCreateTime' => 'The time when the DB cluster was created, in Universal Coordinated Time (UTC).
', 'DBCluster$EarliestBacktrackTime' => 'The earliest time to which a DB cluster can be backtracked.
', 'DBCluster$IOOptimizedNextAllowedModificationTime' => 'The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
This setting is only for Aurora DB clusters.
', 'DBClusterAutomatedBackup$ClusterCreateTime' => 'The time when the DB cluster was created, in Universal Coordinated Time (UTC).
', 'DBClusterBacktrack$BacktrackTo' => 'The timestamp of the time to which the DB cluster was backtracked.
', 'DBClusterBacktrack$BacktrackedFrom' => 'The timestamp of the time from which the DB cluster was backtracked.
', 'DBClusterBacktrack$BacktrackRequestCreationTime' => 'The timestamp of the time at which the backtrack was requested.
', 'DBClusterSnapshot$SnapshotCreateTime' => 'The time when the snapshot was taken, in Universal Coordinated Time (UTC).
', 'DBClusterSnapshot$ClusterCreateTime' => 'The time when the DB cluster was created, in Universal Coordinated Time (UTC).
', 'DBEngineVersion$CreateTime' => 'The creation time of the DB engine version.
', 'DBInstance$AutomaticRestartTime' => 'The time when a stopped DB instance is restarted automatically.
', 'DBInstance$InstanceCreateTime' => 'The date and time when the DB instance was created.
', 'DBInstance$LatestRestorableTime' => 'The latest time to which a database in this DB instance can be restored with point-in-time restore.
', 'DBInstance$ResumeFullAutomationModeTime' => 'The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
', 'DBInstanceAutomatedBackup$InstanceCreateTime' => 'The date and time when the DB instance was created.
', 'DBProxy$CreatedDate' => 'The date and time when the proxy was first created.
', 'DBProxy$UpdatedDate' => 'The date and time when the proxy was last updated.
', 'DBProxyEndpoint$CreatedDate' => 'The date and time when the DB proxy endpoint was first created.
', 'DBProxyTargetGroup$CreatedDate' => 'The date and time when the target group was first created.
', 'DBProxyTargetGroup$UpdatedDate' => 'The date and time when the target group was last updated.
', 'DBRecommendation$CreatedTime' => 'The time when the recommendation was created. For example, 2023-09-28T01:13:53.931000+00:00.
The time when the recommendation was last updated.
', 'DBSnapshot$SnapshotCreateTime' => 'Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
', 'DBSnapshot$InstanceCreateTime' => 'Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
', 'DBSnapshot$OriginalSnapshotCreateTime' => 'Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn\'t change when the snapshot is copied.
', 'DBSnapshot$SnapshotDatabaseTime' => 'The timestamp of the most recent transaction applied to the database that you\'re backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
', 'DBSnapshotTenantDatabase$TenantDatabaseCreateTime' => 'The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If you copy the snapshot, the creation time changes.
', 'DescribeDBRecommendationsMessage$LastUpdatedAfter' => 'A filter to include only the recommendations that were updated after this specified time.
', 'DescribeDBRecommendationsMessage$LastUpdatedBefore' => 'A filter to include only the recommendations that were updated before this specified time.
', 'DescribeEventsMessage$StartTime' => 'The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
', 'DescribeEventsMessage$EndTime' => 'The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
', 'Event$Date' => 'Specifies the date and time of the event.
', 'ExportTask$SnapshotTime' => 'The time when the snapshot was created.
', 'ExportTask$TaskStartTime' => 'The time when the snapshot or cluster export task started.
', 'ExportTask$TaskEndTime' => 'The time when the snapshot or cluster export task ended.
', 'Integration$CreateTime' => 'The time when the integration was created, in Universal Coordinated Time (UTC).
', 'OptionGroup$CopyTimestamp' => 'Indicates when the option group was copied.
', 'PendingMaintenanceAction$AutoAppliedAfterDate' => 'The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.
', 'PendingMaintenanceAction$ForcedApplyDate' => 'The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
', 'PendingMaintenanceAction$CurrentApplyDate' => 'The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
', 'PerformanceIssueDetails$StartTime' => 'The time when the performance issue started.
', 'PerformanceIssueDetails$EndTime' => 'The time when the performance issue stopped.
', 'ReservedDBInstance$StartTime' => 'The time the reservation started.
', 'RestoreDBClusterToPointInTimeMessage$RestoreToTime' => 'The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter isn\'t provided
Can\'t be specified if the UseLatestRestorableTime parameter is enabled
Can\'t be specified if the RestoreType parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBInstanceToPointInTimeMessage$RestoreTime' => 'The date and time to restore from.
Constraints:
Must be a time in Universal Coordinated Time (UTC) format.
Must be before the latest restorable time for the DB instance.
Can\'t be specified if the UseLatestRestorableTime parameter is enabled.
Example: 2009-09-07T23:45:00Z
The earliest time you can restore an instance to.
', 'RestoreWindow$LatestTime' => 'The latest time you can restore an instance to.
', 'TenantDatabase$TenantDatabaseCreateTime' => 'The creation time of the tenant database.
', ], ], 'Tag' => [ 'base' => 'Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => 'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'refs' => [ 'AddTagsToResourceMessage$Tags' => 'The tags to be assigned to the Amazon RDS resource.
', 'BlueGreenDeployment$TagList' => NULL, 'CopyDBClusterParameterGroupMessage$Tags' => NULL, 'CopyDBClusterSnapshotMessage$Tags' => NULL, 'CopyDBParameterGroupMessage$Tags' => NULL, 'CopyDBSnapshotMessage$Tags' => NULL, 'CopyOptionGroupMessage$Tags' => NULL, 'CreateBlueGreenDeploymentRequest$Tags' => 'Tags to assign to the blue/green deployment.
', 'CreateCustomDBEngineVersionMessage$Tags' => NULL, 'CreateDBClusterEndpointMessage$Tags' => 'The tags to be assigned to the Amazon RDS resource.
', 'CreateDBClusterMessage$Tags' => 'Tags to assign to the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBClusterParameterGroupMessage$Tags' => 'Tags to assign to the DB cluster parameter group.
', 'CreateDBClusterSnapshotMessage$Tags' => 'The tags to be assigned to the DB cluster snapshot.
', 'CreateDBInstanceMessage$Tags' => 'Tags to assign to the DB instance.
', 'CreateDBInstanceReadReplicaMessage$Tags' => NULL, 'CreateDBParameterGroupMessage$Tags' => 'Tags to assign to the DB parameter group.
', 'CreateDBProxyEndpointRequest$Tags' => NULL, 'CreateDBProxyRequest$Tags' => 'An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
', 'CreateDBSecurityGroupMessage$Tags' => 'Tags to assign to the DB security group.
', 'CreateDBSnapshotMessage$Tags' => NULL, 'CreateDBSubnetGroupMessage$Tags' => 'Tags to assign to the DB subnet group.
', 'CreateEventSubscriptionMessage$Tags' => NULL, 'CreateIntegrationMessage$Tags' => NULL, 'CreateOptionGroupMessage$Tags' => 'Tags to assign to the option group.
', 'CreateTenantDatabaseMessage$Tags' => NULL, 'DBCluster$TagList' => NULL, 'DBClusterSnapshot$TagList' => NULL, 'DBEngineVersion$TagList' => NULL, 'DBInstance$TagList' => NULL, 'DBSnapshot$TagList' => NULL, 'DBSnapshotTenantDatabase$TagList' => NULL, 'Integration$Tags' => NULL, 'PurchaseReservedDBInstancesOfferingMessage$Tags' => NULL, 'RestoreDBClusterFromS3Message$Tags' => NULL, 'RestoreDBClusterFromSnapshotMessage$Tags' => 'The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$Tags' => NULL, 'RestoreDBInstanceFromDBSnapshotMessage$Tags' => NULL, 'RestoreDBInstanceFromS3Message$Tags' => 'A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
', 'RestoreDBInstanceToPointInTimeMessage$Tags' => NULL, 'TagListMessage$TagList' => 'List of tags returned by the ListTagsForResource operation.
The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.
', ], ], 'TargetDBInstanceClass' => [ 'base' => NULL, 'refs' => [ 'CreateBlueGreenDeploymentRequest$TargetDBInstanceClass' => 'Specify the DB instance class for the databases in the green environment.
This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you\'re creating a blue/green deployment from an Aurora DB cluster, don\'t specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.
', ], ], 'TargetDBParameterGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateBlueGreenDeploymentRequest$TargetDBParameterGroupName' => 'The DB parameter group associated with the DB instance in the green environment.
To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.
', ], ], 'TargetEngineVersion' => [ 'base' => NULL, 'refs' => [ 'CreateBlueGreenDeploymentRequest$TargetEngineVersion' => 'The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
', ], ], 'TargetGroupList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBProxyTargetGroupsResponse$TargetGroups' => 'An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.
Information about the connection health of an RDS Proxy target.
', 'refs' => [ 'DBProxyTarget$TargetHealth' => 'Information about the connection health of the RDS Proxy target.
', ], ], 'TargetHealthReason' => [ 'base' => NULL, 'refs' => [ 'TargetHealth$Reason' => 'The reason for the current health State of the RDS Proxy target.
An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
One or more DBProxyTarget objects that are created when you register targets with a target group.
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
', ], ], 'TargetState' => [ 'base' => NULL, 'refs' => [ 'TargetHealth$State' => 'The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering > unavailable > available > unavailable > available
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
', ], ], 'TenantDatabase' => [ 'base' => 'A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases action.
You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
', 'refs' => [], ], 'TenantDatabaseNotFoundFault' => [ 'base' => 'The specified tenant database wasn\'t found in the DB instance.
', 'refs' => [], ], 'TenantDatabasePendingModifiedValues' => [ 'base' => 'A response element in the ModifyTenantDatabase operation that describes changes that will be applied. Specific changes are identified by subelements.
Information about pending changes for a tenant database.
', ], ], 'TenantDatabaseQuotaExceededFault' => [ 'base' => 'You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
', 'refs' => [], ], 'TenantDatabasesList' => [ 'base' => NULL, 'refs' => [ 'TenantDatabasesMessage$TenantDatabases' => 'An array of the tenant databases requested by the DescribeTenantDatabases operation.
A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.
The specified DB engine version isn\'t supported for Aurora Limitless Database.
', 'refs' => [], ], 'UpgradeTarget' => [ 'base' => 'The version of the database engine that a DB instance can be upgraded to.
', 'refs' => [ 'ValidUpgradeTargetList$member' => NULL, ], ], 'UserAuthConfig' => [ 'base' => 'Specifies the details of authentication used by a proxy to log in as a specific database user.
', 'refs' => [ 'UserAuthConfigList$member' => NULL, ], ], 'UserAuthConfigInfo' => [ 'base' => 'Returns the details of authentication used by a proxy to log in as a specific database user.
', 'refs' => [ 'UserAuthConfigInfoList$member' => NULL, ], ], 'UserAuthConfigInfoList' => [ 'base' => NULL, 'refs' => [ 'DBProxy$Auth' => 'One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
', ], ], 'UserAuthConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateDBProxyRequest$Auth' => 'The authorization mechanism that the proxy uses.
', 'ModifyDBProxyRequest$Auth' => 'The new authentication settings for the DBProxy.
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.
Valid storage options for your DB instance.
', ], ], 'ValidUpgradeTargetList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$ValidUpgradeTarget' => 'A list of engine versions that this database engine version can be upgraded to.
', ], ], 'VpcSecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'CreateDBInstanceMessage$VpcSecurityGroupIds' => 'A list of Amazon EC2 VPC security groups to associate with this DB instance.
This setting doesn\'t apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group\'s VPC.
', 'CreateDBInstanceReadReplicaMessage$VpcSecurityGroupIds' => 'A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn\'t apply to RDS Custom DB instances.
Default: The default EC2 VPC security group for the DB subnet group\'s VPC.
', 'ModifyDBClusterMessage$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
', 'ModifyDBInstanceMessage$VpcSecurityGroupIds' => 'A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn\'t apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
A list of VpcSecurityGroupMembership name strings used for this option.
', 'RestoreDBClusterFromS3Message$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with the restored DB cluster.
', 'RestoreDBClusterFromSnapshotMessage$VpcSecurityGroupIds' => 'A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBClusterToPointInTimeMessage$VpcSecurityGroupIds' => 'A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
', 'RestoreDBInstanceFromDBSnapshotMessage$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group\'s VPC.
', 'RestoreDBInstanceFromS3Message$VpcSecurityGroupIds' => 'A list of VPC security groups to associate with this DB instance.
', 'RestoreDBInstanceToPointInTimeMessage$VpcSecurityGroupIds' => 'A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group\'s VPC.
', ], ], 'VpcSecurityGroupMembership' => [ 'base' => 'This data type is used as a response element for queries on VPC security group membership.
', 'refs' => [ 'VpcSecurityGroupMembershipList$member' => NULL, ], ], 'VpcSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$VpcSecurityGroups' => 'The list of VPC security groups that the DB cluster belongs to.
', 'DBInstance$VpcSecurityGroups' => 'The list of Amazon EC2 VPC security groups that the DB instance belongs to.
', 'Option$VpcSecurityGroupMemberships' => 'If the option requires access to a port, then this VPC security group allows access to the port.
', ], ], 'WriteForwardingStatus' => [ 'base' => NULL, 'refs' => [ 'DBCluster$GlobalWriteForwardingStatus' => 'The status of write forwarding for a secondary cluster in an Aurora global database.
', 'GlobalClusterMember$GlobalWriteForwardingStatus' => 'The status of write forwarding for a secondary cluster in the global cluster.
', ], ], ],]; diff --git a/src/data/secretsmanager/2017-10-17/docs-2.json b/src/data/secretsmanager/2017-10-17/docs-2.json index 5b79963223..72d1f8f341 100644 --- a/src/data/secretsmanager/2017-10-17/docs-2.json +++ b/src/data/secretsmanager/2017-10-17/docs-2.json @@ -71,7 +71,7 @@ "ListSecretsRequest$IncludePlannedDeletion": "Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.
", "PutResourcePolicyRequest$BlockPublicPolicy": "Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked.
Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:
Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)
Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)
To review permissions to your secrets, see Determine who has permissions to your secrets.
Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.
", - "RotateSecretRequest$RotateImmediately": "Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.
For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.
By default, Secrets Manager rotates the secret immediately.
", + "RotateSecretRequest$RotateImmediately": "Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.
For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.
By default, Secrets Manager rotates the secret immediately.
", "ValidateResourcePolicyResponse$PolicyValidationPassed": "True if your policy passes validation, otherwise false.
" } }, @@ -593,7 +593,7 @@ "RotationEnabledType": { "base": null, "refs": { - "DescribeSecretResponse$RotationEnabled": "Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
", + "DescribeSecretResponse$RotationEnabled": "Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
", "SecretListEntry$RotationEnabled": "Indicates whether automatic, scheduled rotation is enabled for this secret.
" } }, @@ -668,7 +668,7 @@ "DeleteSecretRequest$SecretId": "The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", "DescribeSecretRequest$SecretId": "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", "GetResourcePolicyRequest$SecretId": "The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", - "GetSecretValueRequest$SecretId": "The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", + "GetSecretValueRequest$SecretId": "The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", "ListSecretVersionIdsRequest$SecretId": "The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", "PutResourcePolicyRequest$SecretId": "The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", "PutSecretValueRequest$SecretId": "The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
If the secret doesn't already exist, use CreateSecret instead.
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", "UpdateSecretRequest$SecretId": "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", "UpdateSecretVersionStageRequest$SecretId": "The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
", - "ValidateResourcePolicyRequest$SecretId": "The ARN or name of the secret with the resource-based policy you want to validate.
" + "ValidateResourcePolicyRequest$SecretId": "This field is reserved for internal use.
" } }, "SecretListEntry": { diff --git a/src/data/secretsmanager/2017-10-17/docs-2.json.php b/src/data/secretsmanager/2017-10-17/docs-2.json.php index 7037d061c6..82ab594e21 100644 --- a/src/data/secretsmanager/2017-10-17/docs-2.json.php +++ b/src/data/secretsmanager/2017-10-17/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
For a list of endpoints, see Amazon Web Services Secrets Manager endpoints.
Support and Feedback for Amazon Web Services Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.
Logging API Requests
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that\'s collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
', 'operations' => [ 'BatchGetSecretValue' => 'Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.
To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response.
Secrets Manager generates CloudTrail GetSecretValue log entries for each secret you request when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:BatchGetSecretValue, and you must have secretsmanager:GetSecretValue for each secret. If you use filters, you must also have secretsmanager:ListSecrets. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for the keys. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To determine which version has a specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works.
To turn on automatic rotation again, call RotateSecret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn\'t encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
For secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services.
For information about creating a secret in the console, see Create a secret.
To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the JSON you store in the SecretString matches the JSON structure of a database secret.
If you don\'t specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn\'t already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can\'t use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CreateSecret. If you include tags in the secret, you also need secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.
Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
You can\'t delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately.
You can\'t directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background.
To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DescribeSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: !\\"#$%&\'()*+,-./:;<=>?@[\\\\]^_`{|}~
Secrets Manager generates a CloudTrail log entry when you call this action.
Required permissions: secretsmanager:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:GetResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.
To retrieve the values for a group of secrets, call BatchGetSecretValue.
We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications.
To retrieve the previous version of a secret, use VersionStage and specify AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:GetSecretValue. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for that key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.
To list the secrets in the account, use ListSecrets.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.
To list the versions of a secret, use ListSecretVersionIds.
To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListSecrets. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to a secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value.
We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages. If you don\'t include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it. If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken that matches an existing version\'s VersionId, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can\'t modify an existing version; you can only create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutSecretValue. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Replicates the secret to a new Regions. See Multi-Region secrets.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ReplicateSecretToRegions. If the primary secret is encrypted with a KMS key other than aws/secretsmanager, you also need kms:Decrypt permission to the key. To encrypt the replicated secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Encrypt to the key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RestoreSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Configures and starts the asynchronous process of rotating the secret. For information about rotation, see Rotate secrets in the Secrets Manager User Guide. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don\'t include the configuration parameters, the operation starts a rotation with the values already stored in the secret.
When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. For more information, see Permissions for rotation.
Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
You must call this operation from the Region in which you want to promote the replica to a primary secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:StopReplicationToReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret\'s metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Removes specific tags from a secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UntagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.
We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new version. Then it attaches the label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If you call this operation with a ClientRequestToken that matches an existing version\'s VersionId, the operation results in an error. You can\'t modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also have kms:GenerateDataKey, kms:Encrypt, and kms:Decrypt permissions on the key. If you change the KMS key and you don\'t have kms:Encrypt permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information, see Secret encryption and decryption.
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including it in this call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is considered to be \'deprecated\' and can be deleted by Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecretVersionStage. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets.
The API performs three checks when validating the policy:
Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ValidateResourcePolicy and secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.
', ], ], 'APIErrorType' => [ 'base' => 'The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue.
', 'refs' => [ 'APIErrorListType$member' => NULL, ], ], 'AddReplicaRegionListType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$AddReplicaRegions' => 'A list of Regions and KMS keys to replicate secrets.
', 'ReplicateSecretToRegionsRequest$AddReplicaRegions' => 'A list of Regions in which to replicate the secret.
', ], ], 'AutomaticallyRotateAfterDaysType' => [ 'base' => NULL, 'refs' => [ 'RotationRulesType$AutomaticallyAfterDays' => 'The number of days between rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated. If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation date based on the previous rotation. Manually updating the secret value by calling PutSecretValue or UpdateSecret is considered a valid rotation.
In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.
Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren\'t overwritten.
', 'DeleteSecretRequest$ForceDeleteWithoutRecovery' => 'Specifies whether to delete the secret without any recovery window. You can\'t use both this parameter and RecoveryWindowInDays in the same call. If you don\'t use either, then by default Secrets Manager uses a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
If you forcibly delete an already deleted or nonexistent secret, the operation does not return ResourceNotFoundException.
Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
Specifies whether to include versions of secrets that don\'t have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager. By default, versions without staging labels aren\'t included.
', 'ListSecretsRequest$IncludePlannedDeletion' => 'Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren\'t included.
', 'PutResourcePolicyRequest$BlockPublicPolicy' => 'Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren\'t blocked.
Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:
Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)
Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)
To review permissions to your secrets, see Determine who has permissions to your secrets.
Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren\'t overwritten.
', 'RotateSecretRequest$RotateImmediately' => 'Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.
For secrets that use a Lambda rotation function to rotate, if you don\'t immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.
By default, Secrets Manager rotates the secret immediately.
', 'ValidateResourcePolicyResponse$PolicyValidationPassed' => 'True if your policy passes validation, otherwise false.
', ], ], 'CancelRotateSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelRotateSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'ClientRequestTokenType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$ClientRequestToken' => 'If you include SecretString or SecretBinary, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken value isn\'t already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString and SecretBinary values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version\'s SecretString and SecretBinary values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId of the new version.
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken value isn\'t already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version\'s SecretString or SecretBinary values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can\'t modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId of the new version.
A unique identifier for the new version of the secret. You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn\'t attempt to create a secret version twice.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
', 'UpdateSecretRequest$ClientRequestToken' => 'If you include SecretString or SecretBinary, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
', ], ], 'CreateSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedDateType' => [ 'base' => NULL, 'refs' => [ 'GetSecretValueResponse$CreatedDate' => 'The date and time that this version of the secret was created. If you don\'t specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
The date the secret was created.
', 'SecretVersionsListEntry$CreatedDate' => 'The date and time this version of the secret was created.
', ], ], 'DecryptionFailure' => [ 'base' => 'Secrets Manager can\'t decrypt the protected secret text using the provided KMS key.
', 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletedDateType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$DeletedDate' => 'The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
', 'SecretListEntry$DeletedDate' => 'The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.
The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays.
The description of the secret.
', 'DescribeSecretResponse$Description' => 'The description of the secret.
', 'SecretListEntry$Description' => 'The user-provided description of the secret.
', 'UpdateSecretRequest$Description' => 'The description of the secret.
', ], ], 'DurationType' => [ 'base' => NULL, 'refs' => [ 'RotationRulesType$Duration' => 'The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don\'t specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.
Secrets Manager can\'t encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
', 'refs' => [], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'APIErrorType$ErrorCode' => 'The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue, for example ResourceNotFoundException,InvalidParameterException, InvalidRequestException, DecryptionFailure, or AccessDeniedException.
A message describing the error.
', 'DecryptionFailure$Message' => NULL, 'EncryptionFailure$Message' => NULL, 'InternalServiceError$Message' => NULL, 'InvalidNextTokenException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'MalformedPolicyDocumentException$Message' => NULL, 'PreconditionNotMetException$Message' => NULL, 'PublicPolicyException$Message' => NULL, 'ResourceExistsException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ValidationErrorsEntry$ErrorMessage' => 'Displays error messages if validation encounters problems during validation of the resource policy.
', ], ], 'ExcludeCharactersType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$ExcludeCharacters' => 'A string of the characters that you don\'t want in the password.
', ], ], 'ExcludeLowercaseType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$ExcludeLowercase' => 'Specifies whether to exclude lowercase letters from the password. If you don\'t include this switch, the password can contain lowercase letters.
', ], ], 'ExcludeNumbersType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$ExcludeNumbers' => 'Specifies whether to exclude numbers from the password. If you don\'t include this switch, the password can contain numbers.
', ], ], 'ExcludePunctuationType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$ExcludePunctuation' => 'Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & \' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~. If you don\'t include this switch, the password can contain punctuation.
Specifies whether to exclude uppercase letters from the password. If you don\'t include this switch, the password can contain uppercase letters.
', ], ], 'Filter' => [ 'base' => 'Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.
', 'refs' => [ 'FiltersListType$member' => NULL, ], ], 'FilterNameStringType' => [ 'base' => NULL, 'refs' => [ 'Filter$Key' => 'The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
owning-service: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
The keyword to filter for.
You can prefix your search value with an exclamation mark (!) in order to perform negation filters.
The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.
The filters to apply to the list of secrets.
', ], ], 'GetRandomPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRandomPasswordResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecretValueRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecretValueResponse' => [ 'base' => NULL, 'refs' => [], ], 'IncludeSpaceType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$IncludeSpace' => 'Specifies whether to include the space character. If you include this switch, the password can contain space characters.
', ], ], 'InternalServiceError' => [ 'base' => 'An error occurred on the server side.
', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => 'The NextToken value is invalid.
The parameter name or value is invalid.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn\'t already have a Lambda function ARN configured and you didn\'t include such an ARN as a parameter in this call.
The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
The KMS keys used to encrypt the secret version.
', ], ], 'KmsKeyIdType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$KmsKeyId' => 'The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don\'t specify this value, then Secrets Manager uses the key aws/secretsmanager. If that key doesn\'t yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can\'t use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted. Secrets created using the console use an KMS key ID.
The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don\'t include this field, Secrets Manager uses aws/secretsmanager.
Can be an ARN, Key ID, or Alias.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If you don\'t have kms:Encrypt permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.
A key alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.
If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn\'t already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.
You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
', 'ReplicationStatusType$LastAccessedDate' => 'The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
', 'SecretListEntry$LastAccessedDate' => 'The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
', 'SecretVersionsListEntry$LastAccessedDate' => 'The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.
', ], ], 'LastChangedDateType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$LastChangedDate' => 'The last date and time that this secret was modified in any way.
', 'SecretListEntry$LastChangedDate' => 'The last date and time that this secret was modified in any way.
', ], ], 'LastRotatedDateType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$LastRotatedDate' => 'The last date and time that Secrets Manager rotated the secret. If the secret isn\'t configured for rotation or rotation has been disabled, Secrets Manager returns null.
', 'SecretListEntry$LastRotatedDate' => 'The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn\'t ever rotated.
', ], ], 'LimitExceededException' => [ 'base' => 'The request failed because it would exceed one of the Secrets Manager quotas.
', 'refs' => [], ], 'ListSecretVersionIdsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecretVersionIdsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecretsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecretsResponse' => [ 'base' => NULL, 'refs' => [], ], 'MalformedPolicyDocumentException' => [ 'base' => 'The resource policy has syntax errors.
', 'refs' => [], ], 'MaxResultsBatchType' => [ 'base' => NULL, 'refs' => [ 'BatchGetSecretValueRequest$MaxResults' => 'The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecretVersionIds again with the value from NextToken.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.
The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
', 'DeleteResourcePolicyResponse$Name' => 'The name of the secret that the resource-based policy was deleted for.
', 'GetResourcePolicyResponse$Name' => 'The name of the secret that the resource-based policy was retrieved for.
', 'PutResourcePolicyResponse$Name' => 'The name of the secret.
', 'ValidationErrorsEntry$CheckName' => 'Checks the name of the policy.
', ], ], 'NextRotationDateType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$NextRotationDate' => 'The next rotation is scheduled to occur on or before this date. If the secret isn\'t configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.
This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.
', 'SecretListEntry$NextRotationDate' => 'The next rotation is scheduled to occur on or before this date. If the secret isn\'t configured for rotation or rotation has been disabled, Secrets Manager returns null.
', ], ], 'NextTokenType' => [ 'base' => NULL, 'refs' => [ 'BatchGetSecretValueRequest$NextToken' => 'A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call BatchGetSecretValue again with this value.
Secrets Manager includes this value if there\'s more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call BatchGetSecretValue again with this value.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds again with this value.
Secrets Manager includes this value if there\'s more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds again with this value.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.
Secrets Manager includes this value if there\'s more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets again with this value.
A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
', 'PutResourcePolicyRequest$ResourcePolicy' => 'A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
', 'ValidateResourcePolicyRequest$ResourcePolicy' => 'A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
', ], ], 'OwningServiceType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$OwningService' => 'The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
', 'SecretListEntry$OwningService' => 'Returns the name of the service that created the secret.
', ], ], 'PasswordLengthType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$PasswordLength' => 'The length of the password. If you don\'t include this parameter, the default length is 32 characters.
', ], ], 'PreconditionNotMetException' => [ 'base' => 'The request failed because you did not complete all the prerequisite steps.
', 'refs' => [], ], 'PublicPolicyException' => [ 'base' => 'The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.
A string with the password.
', ], ], 'RecoveryWindowInDaysType' => [ 'base' => NULL, 'refs' => [ 'DeleteSecretRequest$RecoveryWindowInDays' => 'The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret. You can\'t use both this parameter and ForceDeleteWithoutRecovery in the same call. If you don\'t use either, then by default Secrets Manager uses a 30 day recovery window.
The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
A Region code. For a list of Region codes, see Name and code of Regions.
', 'ReplicationStatusType$Region' => 'The Region where replication occurs.
', 'SecretListEntry$PrimaryRegion' => 'The Region where Secrets Manager originated the secret.
', ], ], 'RemoveRegionsFromReplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRegionsFromReplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'RemoveReplicaRegionListType' => [ 'base' => NULL, 'refs' => [ 'RemoveRegionsFromReplicationRequest$RemoveReplicaRegions' => 'The Regions of the replicas to remove.
', ], ], 'ReplicaRegionType' => [ 'base' => 'A custom type that specifies a Region and the KmsKeyId for a replica secret.
A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the replica.
InSync, which indicates that the replica was created.
A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the replica.
InSync, which indicates that the replica was created.
The status of replicas for this secret after you remove Regions.
', 'ReplicateSecretToRegionsResponse$ReplicationStatus' => 'The status of replication.
', ], ], 'ReplicationStatusType' => [ 'base' => 'A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don\'t include this switch, the password contains at least one of every character type.
', ], ], 'ResourceExistsException' => [ 'base' => 'A resource with the ID you requested already exists.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'Secrets Manager can\'t find the resource that you asked for.
', 'refs' => [], ], 'RestoreSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'RotateSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'RotateSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'RotationEnabledType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$RotationEnabled' => 'Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
', 'SecretListEntry$RotationEnabled' => 'Indicates whether automatic, scheduled rotation is enabled for this secret.
', ], ], 'RotationLambdaARNType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$RotationLambdaARN' => 'The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
', 'RotateSecretRequest$RotationLambdaARN' => 'For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.
For secrets that use managed rotation, omit this field. For more information, see Managed rotation in the Secrets Manager User Guide.
', 'SecretListEntry$RotationLambdaARN' => 'The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .
A structure that defines the rotation configuration for the secret.
', 'refs' => [ 'DescribeSecretResponse$RotationRules' => 'The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
', 'RotateSecretRequest$RotationRules' => 'A structure that defines the rotation configuration for this secret.
', 'SecretListEntry$RotationRules' => 'A structure that defines the rotation configuration for the secret.
', ], ], 'ScheduleExpressionType' => [ 'base' => NULL, 'refs' => [ 'RotationRulesType$ScheduleExpression' => 'A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.
Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.
You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.
The ARN of the secret.
', 'CreateSecretResponse$ARN' => 'The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don\'t get access to the new secret because the ARNs are different.
', 'DeleteResourcePolicyResponse$ARN' => 'The ARN of the secret that the resource-based policy was deleted for.
', 'DeleteSecretResponse$ARN' => 'The ARN of the secret.
', 'DescribeSecretResponse$ARN' => 'The ARN of the secret.
', 'GetResourcePolicyResponse$ARN' => 'The ARN of the secret that the resource-based policy was retrieved for.
', 'GetSecretValueResponse$ARN' => 'The ARN of the secret.
', 'ListSecretVersionIdsResponse$ARN' => 'The ARN of the secret.
', 'PutResourcePolicyResponse$ARN' => 'The ARN of the secret.
', 'PutSecretValueResponse$ARN' => 'The ARN of the secret.
', 'RemoveRegionsFromReplicationResponse$ARN' => 'The ARN of the primary secret.
', 'ReplicateSecretToRegionsResponse$ARN' => 'The ARN of the primary secret.
', 'RestoreSecretResponse$ARN' => 'The ARN of the secret that was restored.
', 'RotateSecretResponse$ARN' => 'The ARN of the secret.
', 'SecretListEntry$ARN' => 'The Amazon Resource Name (ARN) of the secret.
', 'SecretValueEntry$ARN' => 'The Amazon Resource Name (ARN) of the secret.
', 'StopReplicationToReplicaResponse$ARN' => 'The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
', 'UpdateSecretResponse$ARN' => 'The ARN of the secret that was updated.
', 'UpdateSecretVersionStageResponse$ARN' => 'The ARN of the secret that was updated.
', ], ], 'SecretBinaryType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$SecretBinary' => 'The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString or SecretBinary must have a value, but not both.
This parameter is not available in the Secrets Manager console.
', 'GetSecretValueResponse$SecretBinary' => 'The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.
The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary or SecretString, but not both.
You can\'t access this value from the Secrets Manager console.
', 'SecretValueEntry$SecretBinary' => 'The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The parameter represents the binary data as a base64-encoded string.
', 'UpdateSecretRequest$SecretBinary' => 'The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary or SecretString must have a value, but not both.
You can\'t access this parameter in the Secrets Manager console.
', ], ], 'SecretIdListType' => [ 'base' => NULL, 'refs' => [ 'BatchGetSecretValueRequest$SecretIdList' => 'The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.
The ARN or name of the secret.
', 'CancelRotateSecretRequest$SecretId' => 'The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'DeleteResourcePolicyRequest$SecretId' => 'The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'DeleteSecretRequest$SecretId' => 'The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'DescribeSecretRequest$SecretId' => 'The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'GetResourcePolicyRequest$SecretId' => 'The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'GetSecretValueRequest$SecretId' => 'The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'ListSecretVersionIdsRequest$SecretId' => 'The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'PutResourcePolicyRequest$SecretId' => 'The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'PutSecretValueRequest$SecretId' => 'The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
If the secret doesn\'t already exist, use CreateSecret instead.
The ARN or name of the secret.
', 'ReplicateSecretToRegionsRequest$SecretId' => 'The ARN or name of the secret to replicate.
', 'RestoreSecretRequest$SecretId' => 'The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'RotateSecretRequest$SecretId' => 'The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'SecretIdListType$member' => NULL, 'StopReplicationToReplicaRequest$SecretId' => 'The ARN of the primary secret.
', 'TagResourceRequest$SecretId' => 'The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'UntagResourceRequest$SecretId' => 'The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'UpdateSecretRequest$SecretId' => 'The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'UpdateSecretVersionStageRequest$SecretId' => 'The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'ValidateResourcePolicyRequest$SecretId' => 'The ARN or name of the secret with the resource-based policy you want to validate.
', ], ], 'SecretListEntry' => [ 'base' => 'A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use GetSecretValue .
A list of the secrets in the account.
', ], ], 'SecretNameType' => [ 'base' => NULL, 'refs' => [ 'CancelRotateSecretResponse$Name' => 'The name of the secret.
', 'CreateSecretResponse$Name' => 'The name of the new secret.
', 'DeleteSecretResponse$Name' => 'The name of the secret.
', 'DescribeSecretResponse$Name' => 'The name of the secret.
', 'GetSecretValueResponse$Name' => 'The friendly name of the secret.
', 'ListSecretVersionIdsResponse$Name' => 'The name of the secret.
', 'PutSecretValueResponse$Name' => 'The name of the secret.
', 'RestoreSecretResponse$Name' => 'The name of the secret that was restored.
', 'RotateSecretResponse$Name' => 'The name of the secret.
', 'SecretListEntry$Name' => 'The friendly name of the secret.
', 'SecretValueEntry$Name' => 'The friendly name of the secret.
', 'UpdateSecretResponse$Name' => 'The name of the secret that was updated.
', 'UpdateSecretVersionStageResponse$Name' => 'The name of the secret that was updated.
', ], ], 'SecretStringType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$SecretString' => 'The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString or SecretBinary must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
', 'PutSecretValueRequest$SecretString' => 'The text to encrypt and store in the new version of the secret.
You must include SecretBinary or SecretString, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
', 'SecretValueEntry$SecretString' => 'The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
', 'UpdateSecretRequest$SecretString' => 'The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary or SecretString must have a value, but not both.
A structure that contains the secret value and other details for a secret.
', 'refs' => [ 'SecretValuesType$member' => NULL, ], ], 'SecretValuesType' => [ 'base' => NULL, 'refs' => [ 'BatchGetSecretValueResponse$SecretValues' => 'A list of secret values.
', ], ], 'SecretVersionIdType' => [ 'base' => NULL, 'refs' => [ 'CancelRotateSecretResponse$VersionId' => 'The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage value AWSPENDING from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
The unique identifier associated with the version of the new secret.
', 'GetSecretValueRequest$VersionId' => 'The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don\'t specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version.
This value is typically a UUID-type value with 32 hexadecimal digits.
', 'GetSecretValueResponse$VersionId' => 'The unique identifier of this version of the secret.
', 'PutSecretValueResponse$VersionId' => 'The unique identifier of the version of the secret.
', 'RotateSecretResponse$VersionId' => 'The ID of the new version of the secret.
', 'SecretValueEntry$VersionId' => 'The unique version identifier of this version of the secret.
', 'SecretVersionsListEntry$VersionId' => 'The unique version identifier of this version of the secret.
', 'SecretVersionsToStagesMapType$key' => NULL, 'UpdateSecretResponse$VersionId' => 'If Secrets Manager created a new version of the secret during this operation, then VersionId contains the unique identifier of the new version.
The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
', 'UpdateSecretVersionStageRequest$MoveToVersionId' => 'The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId, the two parameters must refer to the same secret version. If you don\'t specify either a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT version.
The staging label to add to this version.
', ], ], 'SecretVersionStagesType' => [ 'base' => NULL, 'refs' => [ 'GetSecretValueResponse$VersionStages' => 'A list of all of the staging labels currently attached to this version of the secret.
', 'PutSecretValueRequest$VersionStages' => 'A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that\'s already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If you don\'t include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.
The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process.
', 'SecretValueEntry$VersionStages' => 'A list of all of the staging labels currently attached to this version of the secret.
', 'SecretVersionsListEntry$VersionStages' => 'An array of staging labels that are currently associated with this version of the secret.
', 'SecretVersionsToStagesMapType$value' => NULL, ], ], 'SecretVersionsListEntry' => [ 'base' => 'A structure that contains information about one version of a secret.
', 'refs' => [ 'SecretVersionsListType$member' => NULL, ], ], 'SecretVersionsListType' => [ 'base' => NULL, 'refs' => [ 'ListSecretVersionIdsResponse$Versions' => 'A list of the versions of the secret.
', ], ], 'SecretVersionsToStagesMapType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$VersionIdsToStages' => 'A list of the versions of the secret that have staging labels attached. Versions that don\'t have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT, which indicates the current version of the secret.
AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
', 'SecretListEntry$SecretVersionsToStages' => 'A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.
Secrets are listed by CreatedDate.
Status message such as "Secret with this name already exists in this region".
', ], ], 'StatusType' => [ 'base' => NULL, 'refs' => [ 'ReplicationStatusType$Status' => 'The status can be InProgress, Failed, or InSync.
A structure that contains information about a tag.
', 'refs' => [ 'TagListType$member' => NULL, ], ], 'TagKeyListType' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'A list of tag key names to remove from the secret. You don\'t specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
', ], ], 'TagKeyType' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key identifier, or name, of the tag.
', 'TagKeyListType$member' => NULL, ], ], 'TagListType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$Tags' => 'A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets\' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.
', 'DescribeSecretResponse$Tags' => 'The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
', 'SecretListEntry$Tags' => 'The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagValueType' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The string value associated with the key of the tag.
', ], ], 'TimestampType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$CreatedDate' => 'The date the secret was created.
', 'SecretListEntry$CreatedDate' => 'The date and time when a secret was created.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecretVersionStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecretVersionStageResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidateResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidateResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationErrorsEntry' => [ 'base' => 'Displays errors that occurred during validation of the resource policy.
', 'refs' => [ 'ValidationErrorsType$member' => NULL, ], ], 'ValidationErrorsType' => [ 'base' => NULL, 'refs' => [ 'ValidateResourcePolicyResponse$ValidationErrors' => 'Validation errors if your policy didn\'t pass validation.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
For a list of endpoints, see Amazon Web Services Secrets Manager endpoints.
Support and Feedback for Amazon Web Services Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.
Logging API Requests
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that\'s collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
', 'operations' => [ 'BatchGetSecretValue' => 'Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.
To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response.
Secrets Manager generates CloudTrail GetSecretValue log entries for each secret you request when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:BatchGetSecretValue, and you must have secretsmanager:GetSecretValue for each secret. If you use filters, you must also have secretsmanager:ListSecrets. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for the keys. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To determine which version has a specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works.
To turn on automatic rotation again, call RotateSecret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn\'t encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
For secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services.
For information about creating a secret in the console, see Create a secret.
To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the JSON you store in the SecretString matches the JSON structure of a database secret.
If you don\'t specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn\'t already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can\'t use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CreateSecret. If you include tags in the secret, you also need secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.
Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
You can\'t delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately.
You can\'t directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background.
To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DescribeSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: !\\"#$%&\'()*+,-./:;<=>?@[\\\\]^_`{|}~
Secrets Manager generates a CloudTrail log entry when you call this action.
Required permissions: secretsmanager:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:GetResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.
To retrieve the values for a group of secrets, call BatchGetSecretValue.
We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications.
To retrieve the previous version of a secret, use VersionStage and specify AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:GetSecretValue. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for that key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.
To list the secrets in the account, use ListSecrets.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.
To list the versions of a secret, use ListSecretVersionIds.
To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListSecrets. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to a secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value.
We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages. If you don\'t include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it. If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken that matches an existing version\'s VersionId, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can\'t modify an existing version; you can only create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutSecretValue. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Replicates the secret to a new Regions. See Multi-Region secrets.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ReplicateSecretToRegions. If the primary secret is encrypted with a KMS key other than aws/secretsmanager, you also need kms:Decrypt permission to the key. To encrypt the replicated secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Encrypt to the key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RestoreSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Configures and starts the asynchronous process of rotating the secret. For information about rotation, see Rotate secrets in the Secrets Manager User Guide. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don\'t include the configuration parameters, the operation starts a rotation with the values already stored in the secret.
When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. For more information, see Permissions for rotation.
Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
You must call this operation from the Region in which you want to promote the replica to a primary secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:StopReplicationToReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret\'s metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Removes specific tags from a secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UntagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.
We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new version. Then it attaches the label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If you call this operation with a ClientRequestToken that matches an existing version\'s VersionId, the operation results in an error. You can\'t modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also have kms:GenerateDataKey, kms:Encrypt, and kms:Decrypt permissions on the key. If you change the KMS key and you don\'t have kms:Encrypt permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information, see Secret encryption and decryption.
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including it in this call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is considered to be \'deprecated\' and can be deleted by Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecretVersionStage. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets.
The API performs three checks when validating the policy:
Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ValidateResourcePolicy and secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.
', ], ], 'APIErrorType' => [ 'base' => 'The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue.
', 'refs' => [ 'APIErrorListType$member' => NULL, ], ], 'AddReplicaRegionListType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$AddReplicaRegions' => 'A list of Regions and KMS keys to replicate secrets.
', 'ReplicateSecretToRegionsRequest$AddReplicaRegions' => 'A list of Regions in which to replicate the secret.
', ], ], 'AutomaticallyRotateAfterDaysType' => [ 'base' => NULL, 'refs' => [ 'RotationRulesType$AutomaticallyAfterDays' => 'The number of days between rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated. If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation date based on the previous rotation. Manually updating the secret value by calling PutSecretValue or UpdateSecret is considered a valid rotation.
In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.
Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren\'t overwritten.
', 'DeleteSecretRequest$ForceDeleteWithoutRecovery' => 'Specifies whether to delete the secret without any recovery window. You can\'t use both this parameter and RecoveryWindowInDays in the same call. If you don\'t use either, then by default Secrets Manager uses a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
If you forcibly delete an already deleted or nonexistent secret, the operation does not return ResourceNotFoundException.
Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
Specifies whether to include versions of secrets that don\'t have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager. By default, versions without staging labels aren\'t included.
', 'ListSecretsRequest$IncludePlannedDeletion' => 'Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren\'t included.
', 'PutResourcePolicyRequest$BlockPublicPolicy' => 'Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren\'t blocked.
Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:
Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)
Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)
To review permissions to your secrets, see Determine who has permissions to your secrets.
Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren\'t overwritten.
', 'RotateSecretRequest$RotateImmediately' => 'Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.
For secrets that use a Lambda rotation function to rotate, if you don\'t immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.
By default, Secrets Manager rotates the secret immediately.
', 'ValidateResourcePolicyResponse$PolicyValidationPassed' => 'True if your policy passes validation, otherwise false.
', ], ], 'CancelRotateSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelRotateSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'ClientRequestTokenType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$ClientRequestToken' => 'If you include SecretString or SecretBinary, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken value isn\'t already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString and SecretBinary values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version\'s SecretString and SecretBinary values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId of the new version.
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken value isn\'t already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version\'s SecretString or SecretBinary values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can\'t modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId of the new version.
A unique identifier for the new version of the secret. You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn\'t attempt to create a secret version twice.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
', 'UpdateSecretRequest$ClientRequestToken' => 'If you include SecretString or SecretBinary, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
', ], ], 'CreateSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedDateType' => [ 'base' => NULL, 'refs' => [ 'GetSecretValueResponse$CreatedDate' => 'The date and time that this version of the secret was created. If you don\'t specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
The date the secret was created.
', 'SecretVersionsListEntry$CreatedDate' => 'The date and time this version of the secret was created.
', ], ], 'DecryptionFailure' => [ 'base' => 'Secrets Manager can\'t decrypt the protected secret text using the provided KMS key.
', 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletedDateType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$DeletedDate' => 'The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
', 'SecretListEntry$DeletedDate' => 'The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.
The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays.
The description of the secret.
', 'DescribeSecretResponse$Description' => 'The description of the secret.
', 'SecretListEntry$Description' => 'The user-provided description of the secret.
', 'UpdateSecretRequest$Description' => 'The description of the secret.
', ], ], 'DurationType' => [ 'base' => NULL, 'refs' => [ 'RotationRulesType$Duration' => 'The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don\'t specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.
Secrets Manager can\'t encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
', 'refs' => [], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'APIErrorType$ErrorCode' => 'The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue, for example ResourceNotFoundException,InvalidParameterException, InvalidRequestException, DecryptionFailure, or AccessDeniedException.
A message describing the error.
', 'DecryptionFailure$Message' => NULL, 'EncryptionFailure$Message' => NULL, 'InternalServiceError$Message' => NULL, 'InvalidNextTokenException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'MalformedPolicyDocumentException$Message' => NULL, 'PreconditionNotMetException$Message' => NULL, 'PublicPolicyException$Message' => NULL, 'ResourceExistsException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ValidationErrorsEntry$ErrorMessage' => 'Displays error messages if validation encounters problems during validation of the resource policy.
', ], ], 'ExcludeCharactersType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$ExcludeCharacters' => 'A string of the characters that you don\'t want in the password.
', ], ], 'ExcludeLowercaseType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$ExcludeLowercase' => 'Specifies whether to exclude lowercase letters from the password. If you don\'t include this switch, the password can contain lowercase letters.
', ], ], 'ExcludeNumbersType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$ExcludeNumbers' => 'Specifies whether to exclude numbers from the password. If you don\'t include this switch, the password can contain numbers.
', ], ], 'ExcludePunctuationType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$ExcludePunctuation' => 'Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & \' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~. If you don\'t include this switch, the password can contain punctuation.
Specifies whether to exclude uppercase letters from the password. If you don\'t include this switch, the password can contain uppercase letters.
', ], ], 'Filter' => [ 'base' => 'Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.
', 'refs' => [ 'FiltersListType$member' => NULL, ], ], 'FilterNameStringType' => [ 'base' => NULL, 'refs' => [ 'Filter$Key' => 'The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
owning-service: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
The keyword to filter for.
You can prefix your search value with an exclamation mark (!) in order to perform negation filters.
The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.
The filters to apply to the list of secrets.
', ], ], 'GetRandomPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRandomPasswordResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecretValueRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecretValueResponse' => [ 'base' => NULL, 'refs' => [], ], 'IncludeSpaceType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$IncludeSpace' => 'Specifies whether to include the space character. If you include this switch, the password can contain space characters.
', ], ], 'InternalServiceError' => [ 'base' => 'An error occurred on the server side.
', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => 'The NextToken value is invalid.
The parameter name or value is invalid.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn\'t already have a Lambda function ARN configured and you didn\'t include such an ARN as a parameter in this call.
The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
The KMS keys used to encrypt the secret version.
', ], ], 'KmsKeyIdType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$KmsKeyId' => 'The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don\'t specify this value, then Secrets Manager uses the key aws/secretsmanager. If that key doesn\'t yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can\'t use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted. Secrets created using the console use an KMS key ID.
The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don\'t include this field, Secrets Manager uses aws/secretsmanager.
Can be an ARN, Key ID, or Alias.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If you don\'t have kms:Encrypt permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.
A key alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.
If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn\'t already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.
You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
', 'ReplicationStatusType$LastAccessedDate' => 'The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
', 'SecretListEntry$LastAccessedDate' => 'The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
', 'SecretVersionsListEntry$LastAccessedDate' => 'The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.
', ], ], 'LastChangedDateType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$LastChangedDate' => 'The last date and time that this secret was modified in any way.
', 'SecretListEntry$LastChangedDate' => 'The last date and time that this secret was modified in any way.
', ], ], 'LastRotatedDateType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$LastRotatedDate' => 'The last date and time that Secrets Manager rotated the secret. If the secret isn\'t configured for rotation or rotation has been disabled, Secrets Manager returns null.
', 'SecretListEntry$LastRotatedDate' => 'The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn\'t ever rotated.
', ], ], 'LimitExceededException' => [ 'base' => 'The request failed because it would exceed one of the Secrets Manager quotas.
', 'refs' => [], ], 'ListSecretVersionIdsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecretVersionIdsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecretsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecretsResponse' => [ 'base' => NULL, 'refs' => [], ], 'MalformedPolicyDocumentException' => [ 'base' => 'The resource policy has syntax errors.
', 'refs' => [], ], 'MaxResultsBatchType' => [ 'base' => NULL, 'refs' => [ 'BatchGetSecretValueRequest$MaxResults' => 'The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecretVersionIds again with the value from NextToken.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.
The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
', 'DeleteResourcePolicyResponse$Name' => 'The name of the secret that the resource-based policy was deleted for.
', 'GetResourcePolicyResponse$Name' => 'The name of the secret that the resource-based policy was retrieved for.
', 'PutResourcePolicyResponse$Name' => 'The name of the secret.
', 'ValidationErrorsEntry$CheckName' => 'Checks the name of the policy.
', ], ], 'NextRotationDateType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$NextRotationDate' => 'The next rotation is scheduled to occur on or before this date. If the secret isn\'t configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.
This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.
', 'SecretListEntry$NextRotationDate' => 'The next rotation is scheduled to occur on or before this date. If the secret isn\'t configured for rotation or rotation has been disabled, Secrets Manager returns null.
', ], ], 'NextTokenType' => [ 'base' => NULL, 'refs' => [ 'BatchGetSecretValueRequest$NextToken' => 'A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call BatchGetSecretValue again with this value.
Secrets Manager includes this value if there\'s more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call BatchGetSecretValue again with this value.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds again with this value.
Secrets Manager includes this value if there\'s more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds again with this value.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.
Secrets Manager includes this value if there\'s more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets again with this value.
A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
', 'PutResourcePolicyRequest$ResourcePolicy' => 'A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
', 'ValidateResourcePolicyRequest$ResourcePolicy' => 'A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
', ], ], 'OwningServiceType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$OwningService' => 'The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
', 'SecretListEntry$OwningService' => 'Returns the name of the service that created the secret.
', ], ], 'PasswordLengthType' => [ 'base' => NULL, 'refs' => [ 'GetRandomPasswordRequest$PasswordLength' => 'The length of the password. If you don\'t include this parameter, the default length is 32 characters.
', ], ], 'PreconditionNotMetException' => [ 'base' => 'The request failed because you did not complete all the prerequisite steps.
', 'refs' => [], ], 'PublicPolicyException' => [ 'base' => 'The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.
A string with the password.
', ], ], 'RecoveryWindowInDaysType' => [ 'base' => NULL, 'refs' => [ 'DeleteSecretRequest$RecoveryWindowInDays' => 'The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret. You can\'t use both this parameter and ForceDeleteWithoutRecovery in the same call. If you don\'t use either, then by default Secrets Manager uses a 30 day recovery window.
The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
A Region code. For a list of Region codes, see Name and code of Regions.
', 'ReplicationStatusType$Region' => 'The Region where replication occurs.
', 'SecretListEntry$PrimaryRegion' => 'The Region where Secrets Manager originated the secret.
', ], ], 'RemoveRegionsFromReplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRegionsFromReplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'RemoveReplicaRegionListType' => [ 'base' => NULL, 'refs' => [ 'RemoveRegionsFromReplicationRequest$RemoveReplicaRegions' => 'The Regions of the replicas to remove.
', ], ], 'ReplicaRegionType' => [ 'base' => 'A custom type that specifies a Region and the KmsKeyId for a replica secret.
A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the replica.
InSync, which indicates that the replica was created.
A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the replica.
InSync, which indicates that the replica was created.
The status of replicas for this secret after you remove Regions.
', 'ReplicateSecretToRegionsResponse$ReplicationStatus' => 'The status of replication.
', ], ], 'ReplicationStatusType' => [ 'base' => 'A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don\'t include this switch, the password contains at least one of every character type.
', ], ], 'ResourceExistsException' => [ 'base' => 'A resource with the ID you requested already exists.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'Secrets Manager can\'t find the resource that you asked for.
', 'refs' => [], ], 'RestoreSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'RotateSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'RotateSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'RotationEnabledType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$RotationEnabled' => 'Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
', 'SecretListEntry$RotationEnabled' => 'Indicates whether automatic, scheduled rotation is enabled for this secret.
', ], ], 'RotationLambdaARNType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$RotationLambdaARN' => 'The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
', 'RotateSecretRequest$RotationLambdaARN' => 'For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.
For secrets that use managed rotation, omit this field. For more information, see Managed rotation in the Secrets Manager User Guide.
', 'SecretListEntry$RotationLambdaARN' => 'The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .
A structure that defines the rotation configuration for the secret.
', 'refs' => [ 'DescribeSecretResponse$RotationRules' => 'The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
', 'RotateSecretRequest$RotationRules' => 'A structure that defines the rotation configuration for this secret.
', 'SecretListEntry$RotationRules' => 'A structure that defines the rotation configuration for the secret.
', ], ], 'ScheduleExpressionType' => [ 'base' => NULL, 'refs' => [ 'RotationRulesType$ScheduleExpression' => 'A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.
Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.
You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.
The ARN of the secret.
', 'CreateSecretResponse$ARN' => 'The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don\'t get access to the new secret because the ARNs are different.
', 'DeleteResourcePolicyResponse$ARN' => 'The ARN of the secret that the resource-based policy was deleted for.
', 'DeleteSecretResponse$ARN' => 'The ARN of the secret.
', 'DescribeSecretResponse$ARN' => 'The ARN of the secret.
', 'GetResourcePolicyResponse$ARN' => 'The ARN of the secret that the resource-based policy was retrieved for.
', 'GetSecretValueResponse$ARN' => 'The ARN of the secret.
', 'ListSecretVersionIdsResponse$ARN' => 'The ARN of the secret.
', 'PutResourcePolicyResponse$ARN' => 'The ARN of the secret.
', 'PutSecretValueResponse$ARN' => 'The ARN of the secret.
', 'RemoveRegionsFromReplicationResponse$ARN' => 'The ARN of the primary secret.
', 'ReplicateSecretToRegionsResponse$ARN' => 'The ARN of the primary secret.
', 'RestoreSecretResponse$ARN' => 'The ARN of the secret that was restored.
', 'RotateSecretResponse$ARN' => 'The ARN of the secret.
', 'SecretListEntry$ARN' => 'The Amazon Resource Name (ARN) of the secret.
', 'SecretValueEntry$ARN' => 'The Amazon Resource Name (ARN) of the secret.
', 'StopReplicationToReplicaResponse$ARN' => 'The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
', 'UpdateSecretResponse$ARN' => 'The ARN of the secret that was updated.
', 'UpdateSecretVersionStageResponse$ARN' => 'The ARN of the secret that was updated.
', ], ], 'SecretBinaryType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$SecretBinary' => 'The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString or SecretBinary must have a value, but not both.
This parameter is not available in the Secrets Manager console.
', 'GetSecretValueResponse$SecretBinary' => 'The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.
The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary or SecretString, but not both.
You can\'t access this value from the Secrets Manager console.
', 'SecretValueEntry$SecretBinary' => 'The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The parameter represents the binary data as a base64-encoded string.
', 'UpdateSecretRequest$SecretBinary' => 'The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary or SecretString must have a value, but not both.
You can\'t access this parameter in the Secrets Manager console.
', ], ], 'SecretIdListType' => [ 'base' => NULL, 'refs' => [ 'BatchGetSecretValueRequest$SecretIdList' => 'The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.
The ARN or name of the secret.
', 'CancelRotateSecretRequest$SecretId' => 'The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'DeleteResourcePolicyRequest$SecretId' => 'The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'DeleteSecretRequest$SecretId' => 'The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'DescribeSecretRequest$SecretId' => 'The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'GetResourcePolicyRequest$SecretId' => 'The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'GetSecretValueRequest$SecretId' => 'The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'ListSecretVersionIdsRequest$SecretId' => 'The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'PutResourcePolicyRequest$SecretId' => 'The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'PutSecretValueRequest$SecretId' => 'The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
If the secret doesn\'t already exist, use CreateSecret instead.
The ARN or name of the secret.
', 'ReplicateSecretToRegionsRequest$SecretId' => 'The ARN or name of the secret to replicate.
', 'RestoreSecretRequest$SecretId' => 'The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'RotateSecretRequest$SecretId' => 'The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'SecretIdListType$member' => NULL, 'StopReplicationToReplicaRequest$SecretId' => 'The ARN of the primary secret.
', 'TagResourceRequest$SecretId' => 'The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'UntagResourceRequest$SecretId' => 'The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'UpdateSecretRequest$SecretId' => 'The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'UpdateSecretVersionStageRequest$SecretId' => 'The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
', 'ValidateResourcePolicyRequest$SecretId' => 'This field is reserved for internal use.
', ], ], 'SecretListEntry' => [ 'base' => 'A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use GetSecretValue .
A list of the secrets in the account.
', ], ], 'SecretNameType' => [ 'base' => NULL, 'refs' => [ 'CancelRotateSecretResponse$Name' => 'The name of the secret.
', 'CreateSecretResponse$Name' => 'The name of the new secret.
', 'DeleteSecretResponse$Name' => 'The name of the secret.
', 'DescribeSecretResponse$Name' => 'The name of the secret.
', 'GetSecretValueResponse$Name' => 'The friendly name of the secret.
', 'ListSecretVersionIdsResponse$Name' => 'The name of the secret.
', 'PutSecretValueResponse$Name' => 'The name of the secret.
', 'RestoreSecretResponse$Name' => 'The name of the secret that was restored.
', 'RotateSecretResponse$Name' => 'The name of the secret.
', 'SecretListEntry$Name' => 'The friendly name of the secret.
', 'SecretValueEntry$Name' => 'The friendly name of the secret.
', 'UpdateSecretResponse$Name' => 'The name of the secret that was updated.
', 'UpdateSecretVersionStageResponse$Name' => 'The name of the secret that was updated.
', ], ], 'SecretStringType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$SecretString' => 'The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString or SecretBinary must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
', 'PutSecretValueRequest$SecretString' => 'The text to encrypt and store in the new version of the secret.
You must include SecretBinary or SecretString, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
', 'SecretValueEntry$SecretString' => 'The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
', 'UpdateSecretRequest$SecretString' => 'The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary or SecretString must have a value, but not both.
A structure that contains the secret value and other details for a secret.
', 'refs' => [ 'SecretValuesType$member' => NULL, ], ], 'SecretValuesType' => [ 'base' => NULL, 'refs' => [ 'BatchGetSecretValueResponse$SecretValues' => 'A list of secret values.
', ], ], 'SecretVersionIdType' => [ 'base' => NULL, 'refs' => [ 'CancelRotateSecretResponse$VersionId' => 'The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage value AWSPENDING from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
The unique identifier associated with the version of the new secret.
', 'GetSecretValueRequest$VersionId' => 'The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don\'t specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version.
This value is typically a UUID-type value with 32 hexadecimal digits.
', 'GetSecretValueResponse$VersionId' => 'The unique identifier of this version of the secret.
', 'PutSecretValueResponse$VersionId' => 'The unique identifier of the version of the secret.
', 'RotateSecretResponse$VersionId' => 'The ID of the new version of the secret.
', 'SecretValueEntry$VersionId' => 'The unique version identifier of this version of the secret.
', 'SecretVersionsListEntry$VersionId' => 'The unique version identifier of this version of the secret.
', 'SecretVersionsToStagesMapType$key' => NULL, 'UpdateSecretResponse$VersionId' => 'If Secrets Manager created a new version of the secret during this operation, then VersionId contains the unique identifier of the new version.
The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
', 'UpdateSecretVersionStageRequest$MoveToVersionId' => 'The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId, the two parameters must refer to the same secret version. If you don\'t specify either a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT version.
The staging label to add to this version.
', ], ], 'SecretVersionStagesType' => [ 'base' => NULL, 'refs' => [ 'GetSecretValueResponse$VersionStages' => 'A list of all of the staging labels currently attached to this version of the secret.
', 'PutSecretValueRequest$VersionStages' => 'A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that\'s already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If you don\'t include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.
The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process.
', 'SecretValueEntry$VersionStages' => 'A list of all of the staging labels currently attached to this version of the secret.
', 'SecretVersionsListEntry$VersionStages' => 'An array of staging labels that are currently associated with this version of the secret.
', 'SecretVersionsToStagesMapType$value' => NULL, ], ], 'SecretVersionsListEntry' => [ 'base' => 'A structure that contains information about one version of a secret.
', 'refs' => [ 'SecretVersionsListType$member' => NULL, ], ], 'SecretVersionsListType' => [ 'base' => NULL, 'refs' => [ 'ListSecretVersionIdsResponse$Versions' => 'A list of the versions of the secret.
', ], ], 'SecretVersionsToStagesMapType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$VersionIdsToStages' => 'A list of the versions of the secret that have staging labels attached. Versions that don\'t have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT, which indicates the current version of the secret.
AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
', 'SecretListEntry$SecretVersionsToStages' => 'A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.
Secrets are listed by CreatedDate.
Status message such as "Secret with this name already exists in this region".
', ], ], 'StatusType' => [ 'base' => NULL, 'refs' => [ 'ReplicationStatusType$Status' => 'The status can be InProgress, Failed, or InSync.
A structure that contains information about a tag.
', 'refs' => [ 'TagListType$member' => NULL, ], ], 'TagKeyListType' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'A list of tag key names to remove from the secret. You don\'t specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
', ], ], 'TagKeyType' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key identifier, or name, of the tag.
', 'TagKeyListType$member' => NULL, ], ], 'TagListType' => [ 'base' => NULL, 'refs' => [ 'CreateSecretRequest$Tags' => 'A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets\' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.
', 'DescribeSecretResponse$Tags' => 'The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
', 'SecretListEntry$Tags' => 'The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagValueType' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The string value associated with the key of the tag.
', ], ], 'TimestampType' => [ 'base' => NULL, 'refs' => [ 'DescribeSecretResponse$CreatedDate' => 'The date the secret was created.
', 'SecretListEntry$CreatedDate' => 'The date and time when a secret was created.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecretRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecretResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecretVersionStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecretVersionStageResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidateResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidateResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationErrorsEntry' => [ 'base' => 'Displays errors that occurred during validation of the resource policy.
', 'refs' => [ 'ValidationErrorsType$member' => NULL, ], ], 'ValidationErrorsType' => [ 'base' => NULL, 'refs' => [ 'ValidateResourcePolicyResponse$ValidationErrors' => 'Validation errors if your policy didn\'t pass validation.
', ], ], ],];