Topic policy details of the Guardrail.
" + } + }, + "contentPolicy": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAssessment", + "traits": { + "smithy.api#documentation": "Content policy details of the Guardrail.
" + } + }, + "wordPolicy": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAssessment", + "traits": { + "smithy.api#documentation": "Word policy details of the Guardrail.
" + } + }, + "sensitiveInformationPolicy": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAssessment", + "traits": { + "smithy.api#documentation": "Sensitive Information policy details of Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Assessment details of the content analyzed by Guardrails.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailAssessmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailAssessment" + } + }, "com.amazonaws.bedrockagentruntime#GuardrailConfiguration": { "type": "structure", "members": { @@ -1546,6 +1602,660 @@ "smithy.api#documentation": "The configuration details for the guardrail.
" } }, + "com.amazonaws.bedrockagentruntime#GuardrailContentFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilterType", + "traits": { + "smithy.api#documentation": "The type of content detected in the filter by the Guardrail.
" + } + }, + "confidence": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilterConfidence", + "traits": { + "smithy.api#documentation": "The confidence level regarding the content detected in the filter by the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAction", + "traits": { + "smithy.api#documentation": "The action placed on the content by the Guardrail filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the content filter used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentFilterConfidence": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilter" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentFilterType": { + "type": "enum", + "members": { + "INSULTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSULTS" + } + }, + "HATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HATE" + } + }, + "SEXUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEXUAL" + } + }, + "VIOLENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIOLENCE" + } + }, + "MISCONDUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONDUCT" + } + }, + "PROMPT_ATTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROMPT_ATTACK" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAssessment": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilterList", + "traits": { + "smithy.api#documentation": "The filter details of the policy assessment used in the Guardrails filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy assessment in the Guardrails filter.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailCustomWord": { + "type": "structure", + "members": { + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match details for the custom word filter in the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction", + "traits": { + "smithy.api#documentation": "The action details for the custom word filter in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The custom word details for the filter in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailCustomWordList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailCustomWord" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailManagedWord": { + "type": "structure", + "members": { + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match details for the managed word filter in the Guardrail.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailManagedWordType", + "traits": { + "smithy.api#documentation": "The type details for the managed word filter in the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction", + "traits": { + "smithy.api#documentation": "The action details for the managed word filter in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The managed word details for the filter in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailManagedWordList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailManagedWord" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailManagedWordType": { + "type": "enum", + "members": { + "PROFANITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFANITY" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityType", + "traits": { + "smithy.api#documentation": "The type of PII the Guardrail filter has identified and removed.
" + } + }, + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match to settings in the Guardrail filter to identify and remove PII.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAction", + "traits": { + "smithy.api#documentation": "The action of the Guardrail filter to identify and remove PII.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Guardrail filter to identify and remove personally identifiable information (PII).
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilter" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityType": { + "type": "enum", + "members": { + "ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDRESS" + } + }, + "AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGE" + } + }, + "AWS_ACCESS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_ACCESS_KEY" + } + }, + "AWS_SECRET_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SECRET_KEY" + } + }, + "CA_HEALTH_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_HEALTH_NUMBER" + } + }, + "CA_SOCIAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" + } + }, + "CREDIT_DEBIT_CARD_CVV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_CVV" + } + }, + "CREDIT_DEBIT_CARD_EXPIRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_EXPIRY" + } + }, + "CREDIT_DEBIT_CARD_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_NUMBER" + } + }, + "DRIVER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIVER_ID" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "LICENSE_PLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_PLATE" + } + }, + "MAC_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAC_ADDRESS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD" + } + }, + "PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE" + } + }, + "PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIN" + } + }, + "SWIFT_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SWIFT_CODE" + } + }, + "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" + } + }, + "UK_NATIONAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" + } + }, + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USERNAME" + } + }, + "US_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ACCOUNT_NUMBER" + } + }, + "US_BANK_ROUTING_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ROUTING_NUMBER" + } + }, + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" + } + }, + "US_PASSPORT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_PASSPORT_NUMBER" + } + }, + "US_SOCIAL_SECURITY_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_SOCIAL_SECURITY_NUMBER" + } + }, + "VEHICLE_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailRegexFilter": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name details for the regex filter used in the Guardrail.
" + } + }, + "regex": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The regex details for the regex filter used in the Guardrail.
" + } + }, + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match details for the regex filter used in the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAction", + "traits": { + "smithy.api#documentation": "The action details for the regex filter used in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for the regex filter used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailRegexFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailRegexFilter" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + }, + "ANONYMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANONYMIZED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAssessment": { + "type": "structure", + "members": { + "piiEntities": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilterList", + "traits": { + "smithy.api#documentation": "The details of the PII entities used in the sensitive policy assessment for the Guardrail.
" + } + }, + "regexes": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailRegexFilterList", + "traits": { + "smithy.api#documentation": "The details of the regexes used in the sensitive policy assessment for the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the sensitive policy assessment used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopic": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name details on a specific topic in the Guardrail.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicType", + "traits": { + "smithy.api#documentation": "The type details on a specific topic in the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAction", + "traits": { + "smithy.api#documentation": "The action details on a specific topic in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for a specific topic defined in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopicList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTopic" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAssessment": { + "type": "structure", + "members": { + "topics": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicList", + "traits": { + "smithy.api#documentation": "The topic details of the policy assessment used in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy assessment used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopicType": { + "type": "enum", + "members": { + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTrace": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailAction", + "traits": { + "smithy.api#documentation": "The trace action details used with the Guardrail.
" + } + }, + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The details of the trace Id used in the Guardrail Trace.
" + } + }, + "inputAssessments": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailAssessmentList", + "traits": { + "smithy.api#documentation": "The details of the input assessments used in the Guardrail Trace.
" + } + }, + "outputAssessments": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailAssessmentList", + "traits": { + "smithy.api#documentation": "The details of the output assessments used in the Guardrail Trace.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The trace details used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAssessment": { + "type": "structure", + "members": { + "customWords": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailCustomWordList", + "traits": { + "smithy.api#documentation": "The custom word details for words defined in the Guardrail filter.
" + } + }, + "managedWordLists": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailManagedWordList", + "traits": { + "smithy.api#documentation": "The managed word lists for words defined in the Guardrail filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The assessment details for words defined in the Guardrail filter.
", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#Identifier": { "type": "string", "traits": { @@ -3577,6 +4287,12 @@ "com.amazonaws.bedrockagentruntime#Trace": { "type": "union", "members": { + "guardrailTrace": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTrace", + "traits": { + "smithy.api#documentation": "The trace details for a trace defined in the Guardrail filter.
" + } + }, "preProcessingTrace": { "target": "com.amazonaws.bedrockagentruntime#PreProcessingTrace", "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.json b/codegen/sdk-codegen/aws-models/bedrock-agent.json index b1733e1e6be..3b690c8af91 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json @@ -274,6 +274,12 @@ "traits": { "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The guardrails configuration assigned to the agent.
" + } } }, "traits": { @@ -790,7 +796,7 @@ "smithy.api#length": { "max": 2048 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents_.+$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" } }, "com.amazonaws.bedrockagent#AgentStatus": { @@ -899,6 +905,12 @@ "traits": { "smithy.api#documentation": "The latest version of the agent.
" } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The details of the guardrails configuration in the agent summary.
" + } } }, "traits": { @@ -1012,6 +1024,12 @@ "traits": { "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The guardrails configuration assigned to the agent version.
" + } } }, "traits": { @@ -1072,6 +1090,12 @@ "traits": { "smithy.api#documentation": "The description of the version of the agent.
" } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The details of the guardrails configuration in the agent version summary.
" + } } }, "traits": { @@ -1939,9 +1963,9 @@ "traits": { "smithy.api#length": { "min": 20, - "max": 1011 + "max": 2048 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[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][_-]?)+)$" } }, "com.amazonaws.bedrockagent#BucketOwnerAccountId": { @@ -2369,6 +2393,12 @@ "traits": { "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is created.
" + } } }, "traits": { @@ -4266,6 +4296,41 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrockagent#GuardrailConfiguration": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockagent#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "The guardrails identifier assigned to the guardrails configuration.
" + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockagent#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The guardrails version assigned to the guardrails configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the guardrails configuration.
" + } + }, + "com.amazonaws.bedrockagent#GuardrailIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, + "com.amazonaws.bedrockagent#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([0-9]{1,8})|(DRAFT))$" + } + }, "com.amazonaws.bedrockagent#Id": { "type": "string", "traits": { @@ -4675,7 +4740,7 @@ "traits": { "smithy.api#length": { "min": 40, - "max": 1200 + "max": 4000 }, "smithy.api#sensitive": {} } @@ -6352,7 +6417,7 @@ "basePromptTemplate": { "target": "com.amazonaws.bedrockagent#BasePromptTemplate", "traits": { - "smithy.api#documentation": "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.
" + "smithy.api#documentation": "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.
" } }, "inferenceConfiguration": { @@ -6396,7 +6461,7 @@ "overrideLambda": { "target": "com.amazonaws.bedrockagent#LambdaArn", "traits": { - "smithy.api#documentation": "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.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is updated.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/controltower.json b/codegen/sdk-codegen/aws-models/controltower.json index 0f16f243391..c0b7fb60cde 100644 --- a/codegen/sdk-codegen/aws-models/controltower.json +++ b/codegen/sdk-codegen/aws-models/controltower.json @@ -7,41 +7,26 @@ "operations": [ { "target": "com.amazonaws.controltower#DisableControl" - }, - { - "target": "com.amazonaws.controltower#EnableControl" - }, - { - "target": "com.amazonaws.controltower#GetControlOperation" - }, - { - "target": "com.amazonaws.controltower#GetEnabledControl" - }, - { - "target": "com.amazonaws.controltower#ListEnabledControls" - }, - { - "target": "com.amazonaws.controltower#ListTagsForResource" - }, - { - "target": "com.amazonaws.controltower#TagResource" - }, - { - "target": "com.amazonaws.controltower#UntagResource" - }, - { - "target": "com.amazonaws.controltower#UpdateEnabledControl" } ], "resources": [ { "target": "com.amazonaws.controltower#BaselineResource" }, + { + "target": "com.amazonaws.controltower#ControlOperationResource" + }, { "target": "com.amazonaws.controltower#EnabledBaselineResource" }, + { + "target": "com.amazonaws.controltower#EnabledControlResource" + }, { "target": "com.amazonaws.controltower#LandingZoneResource" + }, + { + "target": "com.amazonaws.controltower#TaggingResource" } ], "traits": { @@ -76,7 +61,7 @@ "x-amzn-trace-id" ] }, - "smithy.api#documentation": "These interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
\nTo call these APIs, you'll need to know:
\nthe 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.
\n\n To get the controlIdentifier for your Amazon Web Services Control Tower\n control:\n
The controlIdentifier is an ARN that is specified for each\n 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\n find the controlIdentifier for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.\n
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the Controls reference guide section\n of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed.
\n\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n
\n Example:\n
\n\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n
\n To get the targetIdentifier:\n
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.
\n\n OU ARN format:\n
\n\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n
\n Details and examples\n
\n\n Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation\n
\nTo view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n
\n\n Recording API Requests\n
\nAmazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.
", + "smithy.api#documentation": "Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
\n\n \n controls\n \n
\n\n \n landing zones\n \n
\n\n \n baselines\n \n
\nFor more information about these types of resources, see the \n Amazon Web Services Control Tower User Guide\n .
\n\n About control APIs\n
\nThese interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
\nTo call these APIs, you'll need to know:
\nthe 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.
\n\n To get the controlIdentifier for your Amazon Web Services Control Tower\n control:\n
The controlIdentifier is an ARN that is specified for each\n 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\n 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.\n
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the Controls reference guide section\n of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed.
\n\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n
\n Example:\n
\n\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n
\n To get the targetIdentifier:\n
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.
\n\n OU ARN format:\n
\n\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n
\n About landing zone APIs\n
\nYou 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.
\nFor 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.
\n\n About baseline APIs\n
\nYou 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.
\nThe 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.
\n\n Details and examples\n
\n\n Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation\n
\nTo view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n
\n\n Recording API Requests\n
\nAmazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.
", "smithy.api#title": "AWS Control Tower", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1141,6 +1126,18 @@ "smithy.api#pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$" } }, + "com.amazonaws.controltower#ControlIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#ControlIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.controltower#ControlOperation": { "type": "structure", "members": { @@ -1175,48 +1172,226 @@ "traits": { "smithy.api#documentation": "If the operation result is FAILED, this string contains a message explaining\n why the operation failed.
The identifier of the specified operation.
" + } + }, + "controlIdentifier": { + "target": "com.amazonaws.controltower#ControlIdentifier", + "traits": { + "smithy.api#documentation": "The controlIdentifier of the control for the operation.
The target upon which the control operation is working.
" + } + }, + "enabledControlIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "The controlIdentifier of the enabled control.
An operation performed by the control.
" } }, + "com.amazonaws.controltower#ControlOperationFilter": { + "type": "structure", + "members": { + "controlIdentifiers": { + "target": "com.amazonaws.controltower#ControlIdentifiers", + "traits": { + "smithy.api#documentation": "The set of controlIdentifier returned by the filter.
The set of targetIdentifier objects returned by the filter.
The set controlIdentifier of enabled controls selected by the filter.
Lists the status of control operations.
" + } + }, + "controlOperationTypes": { + "target": "com.amazonaws.controltower#ControlOperationTypes", + "traits": { + "smithy.api#documentation": "The set of ControlOperation objects returned by the filter.
A filter object that lets you call ListCOntrolOperations with a specific filter.
The type of operation.
" + } + }, + "startTime": { + "target": "com.amazonaws.controltower#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which a control operation began.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "endTime": { + "target": "com.amazonaws.controltower#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the control operation was completed.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "status": { + "target": "com.amazonaws.controltower#ControlOperationStatus", + "traits": { + "smithy.api#documentation": "The status of the specified control operation.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A speficic message displayed as part of the control status.
" + } + }, + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of a control operation.
" + } + }, + "controlIdentifier": { + "target": "com.amazonaws.controltower#ControlIdentifier", + "traits": { + "smithy.api#documentation": "The controlIdentifier of a control.
The unique identifier of the target of a control operation.
" } - ] + }, + "enabledControlIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "The controlIdentifier of an enabled control.
A summary of information about the specified control operation.
" } }, "com.amazonaws.controltower#ControlOperationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ENABLE_CONTROL", - "value": "ENABLE_CONTROL" - }, - { - "name": "DISABLE_CONTROL", - "value": "DISABLE_CONTROL" - }, - { - "name": "UPDATE_ENABLED_CONTROL", - "value": "UPDATE_ENABLED_CONTROL" + "type": "enum", + "members": { + "ENABLE_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_CONTROL" } - ] + }, + "DISABLE_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_CONTROL" + } + }, + "UPDATE_ENABLED_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_ENABLED_CONTROL" + } + } + } + }, + "com.amazonaws.controltower#ControlOperationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#ControlOperationType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.controltower#ControlOperations": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#ControlOperationSummary" } }, "com.amazonaws.controltower#CreateLandingZone": { @@ -1266,7 +1441,7 @@ "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file.
", + "smithy.api#documentation": "The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review \n Launch your landing zone.
", "smithy.api#required": {} } }, @@ -1404,7 +1579,7 @@ } ], "traits": { - "smithy.api#documentation": "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 \n the Amazon Web Services Control Tower User Guide\n .
The drift summary of the enabled control.
\nAmazon Web Services Control Tower expects the enabled control\n configuration to include all supported and governed Regions. If the enabled control differs\n from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
" } }, + "com.amazonaws.controltower#DriftStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#DriftStatus" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.controltower#EnableBaseline": { "type": "operation", "input": { @@ -1589,7 +1782,7 @@ } ], "traits": { - "smithy.api#documentation": "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 \n the Amazon Web Services Control Tower User Guide\n .
A list of input parameter values, which are specified to configure the control when you enable it.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.controltower#EnableControlOutput": { @@ -1747,6 +1943,9 @@ "smithy.api#documentation": "The ARN of the EnabledControl resource.
Information about the enabled control.
" } }, + "com.amazonaws.controltower#EnabledControlFilter": { + "type": "structure", + "members": { + "controlIdentifiers": { + "target": "com.amazonaws.controltower#ControlIdentifiers", + "traits": { + "smithy.api#documentation": "The set of controlIdentifier returned by the filter.
A list of EnablementStatus items.
A list of DriftStatus items.
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.
" + } + }, + "com.amazonaws.controltower#EnabledControlIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.controltower#EnabledControlParameter": { "type": "structure", "members": { @@ -2090,6 +2327,26 @@ "target": "com.amazonaws.controltower#EnabledControlParameter" } }, + "com.amazonaws.controltower#EnabledControlResource": { + "type": "resource", + "identifiers": { + "enabledControlIdentifier": { + "target": "com.amazonaws.controltower#Arn" + } + }, + "create": { + "target": "com.amazonaws.controltower#EnableControl" + }, + "read": { + "target": "com.amazonaws.controltower#GetEnabledControl" + }, + "update": { + "target": "com.amazonaws.controltower#UpdateEnabledControl" + }, + "list": { + "target": "com.amazonaws.controltower#ListEnabledControls" + } + }, "com.amazonaws.controltower#EnabledControlSummary": { "type": "structure", "members": { @@ -2177,6 +2434,18 @@ "smithy.api#documentation": "The deployment summary of the enabled control.
" } }, + "com.amazonaws.controltower#EnablementStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#EnablementStatus" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.controltower#GetBaseline": { "type": "operation", "input": { @@ -2203,7 +2472,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieve details about an existing Baseline resource by specifying its identifier.
Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
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 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 \n the Amazon Web Services Control Tower User Guide\n .
Returns the status of the specified landing zone operation. Details for an operation are available for \n 60 days.
", + "smithy.api#documentation": "Returns the status of the specified landing zone operation. Details for an operation are available for \n 90 days.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -2667,7 +2942,7 @@ "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "The landing zone manifest.yaml text file that specifies the landing zone configurations.
The landing zone manifest JSON text file that specifies the landing zone configurations.
", "smithy.api#required": {} } }, @@ -2935,7 +3210,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a summary list of all available baselines.
", + "smithy.api#documentation": "Returns a summary list of all available baselines. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
", "smithy.api#http": { "code": 200, "method": "POST", @@ -3000,6 +3275,106 @@ "smithy.api#output": {} } }, + "com.amazonaws.controltower#ListControlOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#ListControlOperationsInput" + }, + "output": { + "target": "com.amazonaws.controltower#ListControlOperationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a list of operations in progress or queued.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-control-operations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "controlOperations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controltower#ListControlOperationsInput": { + "type": "structure", + "members": { + "filter": { + "target": "com.amazonaws.controltower#ControlOperationFilter", + "traits": { + "smithy.api#documentation": "An input filter for the ListControlOperations API that lets you select the types of control operations to view.
A pagination token.
" + } + }, + "maxResults": { + "target": "com.amazonaws.controltower#ListControlOperationsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be shown.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#ListControlOperationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.controltower#ListControlOperationsNextToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.controltower#ListControlOperationsOutput": { + "type": "structure", + "members": { + "controlOperations": { + "target": "com.amazonaws.controltower#ControlOperations", + "traits": { + "smithy.api#documentation": "Returns a list of output from control operations. PLACEHOLDER
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.controltower#ListControlOperationsNextToken", + "traits": { + "smithy.api#documentation": "A pagination token.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.controltower#ListEnabledBaselines": { "type": "operation", "input": { @@ -3023,7 +3398,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.
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 \n the Amazon Web Services Control Tower User Guide\n .
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.
How many results to return per API call.
" } + }, + "filter": { + "target": "com.amazonaws.controltower#EnabledControlFilter", + "traits": { + "smithy.api#documentation": "An input filter for the ListCEnabledControls API that lets you select the types of control operations to view.
Retrieves the next page of results. If the string is empty, the response is the\n end of the results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.controltower#ListLandingZones": { @@ -3412,7 +3799,7 @@ } ], "traits": { - "smithy.api#documentation": "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 \n the Amazon Web Services Control Tower User Guide\n .
Updates an EnabledBaseline resource's applied parameters or version.
Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file.
The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review \n Launch your landing zone.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/osis.json b/codegen/sdk-codegen/aws-models/osis.json index d1db83f403b..0ff17add88a 100644 --- a/codegen/sdk-codegen/aws-models/osis.json +++ b/codegen/sdk-codegen/aws-models/osis.json @@ -772,6 +772,12 @@ } } }, + "com.amazonaws.osis#BlueprintFormat": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(YAML|JSON)$" + } + }, "com.amazonaws.osis#Boolean": { "type": "boolean" }, @@ -787,7 +793,7 @@ } }, "traits": { - "smithy.api#documentation": "Options that specify the configuration of a persistent buffer.\n To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions.
" + "smithy.api#documentation": "Options that specify the configuration of a persistent buffer.\n To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.
The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing\n log group or create a new one. For example,\n /aws/OpenSearchService/IngestionService/my-pipeline.
The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing\n log group or create a new one. For example,\n /aws/vendedlogs/OpenSearchService/pipelines.
Exception is thrown when an operation has been disabled.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.osis#EncryptionAtRestOptions": { "type": "structure", "members": { "KmsKeyArn": { "target": "com.amazonaws.osis#KmsKeyArn", "traits": { - "smithy.api#documentation": "The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion.\n By default, data is encrypted using an AWS owned key.
", + "smithy.api#documentation": "The ARN of the KMS key used to encrypt buffer data.\n By default, data is encrypted using an Amazon Web Services owned key.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Options to control how OpenSearch encrypts all data-at-rest.
" + "smithy.api#documentation": "Options to control how OpenSearch encrypts buffer data.
" } }, "com.amazonaws.osis#ErrorMessage": { @@ -1157,6 +1188,9 @@ { "target": "com.amazonaws.osis#AccessDeniedException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -1188,6 +1222,9 @@ { "target": "com.amazonaws.osis#AccessDeniedException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -1217,6 +1254,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Format": { + "target": "com.amazonaws.osis#BlueprintFormat", + "traits": { + "smithy.api#documentation": "The format format of the blueprint to retrieve.
", + "smithy.api#httpQuery": "format" + } } }, "traits": { @@ -1231,6 +1275,12 @@ "traits": { "smithy.api#documentation": "The requested blueprint in YAML format.
" } + }, + "Format": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "The format of the blueprint.
" + } } }, "traits": { @@ -1249,6 +1299,9 @@ { "target": "com.amazonaws.osis#AccessDeniedException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -1304,7 +1357,7 @@ "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { - "smithy.api#documentation": "The name of the pipeline to get information about.
", + "smithy.api#documentation": "The name of the pipeline.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1400,6 +1453,9 @@ { "target": "com.amazonaws.osis#AccessDeniedException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -1452,6 +1508,9 @@ { "target": "com.amazonaws.osis#AccessDeniedException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -1530,6 +1589,9 @@ { "target": "com.amazonaws.osis#AccessDeniedException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -1714,7 +1776,13 @@ "ServiceVpcEndpoints": { "target": "com.amazonaws.osis#ServiceVpcEndpointsList", "traits": { - "smithy.api#documentation": "A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.
" + "smithy.api#documentation": "A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
" + } + }, + "Destinations": { + "target": "com.amazonaws.osis#PipelineDestinationList", + "traits": { + "smithy.api#documentation": "Destinations to which the pipeline writes data.
" } }, "Tags": { @@ -1752,6 +1820,30 @@ "traits": { "smithy.api#documentation": "The YAML configuration of the blueprint.
" } + }, + "DisplayName": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "The display name of the blueprint.
" + } + }, + "DisplayDescription": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "A description of the blueprint.
" + } + }, + "Service": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "The name of the service that the blueprint is associated with.
" + } + }, + "UseCase": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "The use case that the blueprint relates to.
" + } } }, "traits": { @@ -1766,6 +1858,30 @@ "traits": { "smithy.api#documentation": "The name of the blueprint.
" } + }, + "DisplayName": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "The display name of the blueprint.
" + } + }, + "DisplayDescription": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "A description of the blueprint.
" + } + }, + "Service": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "The name of the service that the blueprint is associated with.
" + } + }, + "UseCase": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "The use case that the blueprint relates to.
" + } } }, "traits": { @@ -1787,6 +1903,32 @@ } } }, + "com.amazonaws.osis#PipelineDestination": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "The name of the service receiving data from the pipeline.
" + } + }, + "Endpoint": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "The endpoint receiving data from the pipeline.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the destination of a pipeline.
" + } + }, + "com.amazonaws.osis#PipelineDestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.osis#PipelineDestination" + } + }, "com.amazonaws.osis#PipelineName": { "type": "string", "traits": { @@ -1924,6 +2066,12 @@ "smithy.api#documentation": "The date and time when the pipeline was last updated.
" } }, + "Destinations": { + "target": "com.amazonaws.osis#PipelineDestinationList", + "traits": { + "smithy.api#documentation": "A list of destinations to which the pipeline writes data.
" + } + }, "Tags": { "target": "com.amazonaws.osis#TagList", "traits": { @@ -2009,7 +2157,7 @@ "VpcEndpointId": { "target": "com.amazonaws.osis#String", "traits": { - "smithy.api#documentation": "The ID of the VPC endpoint that was created.
" + "smithy.api#documentation": "The unique identifier of the VPC endpoint that was created.
" } } }, @@ -2038,6 +2186,9 @@ { "target": "com.amazonaws.osis#ConflictException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -2099,6 +2250,9 @@ { "target": "com.amazonaws.osis#ConflictException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -2226,6 +2380,9 @@ { "target": "com.amazonaws.osis#AccessDeniedException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -2303,6 +2460,9 @@ { "target": "com.amazonaws.osis#AccessDeniedException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -2367,6 +2527,9 @@ { "target": "com.amazonaws.osis#ConflictException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -2464,6 +2627,9 @@ { "target": "com.amazonaws.osis#AccessDeniedException" }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, { "target": "com.amazonaws.osis#InternalException" }, @@ -2548,6 +2714,27 @@ "target": "com.amazonaws.osis#ValidationMessage" } }, + "com.amazonaws.osis#VpcAttachmentOptions": { + "type": "structure", + "members": { + "AttachToVpc": { + "target": "com.amazonaws.osis#Boolean", + "traits": { + "smithy.api#documentation": "Whether a VPC is attached to the pipeline.
", + "smithy.api#required": {} + } + }, + "CidrBlock": { + "target": "com.amazonaws.osis#CidrBlock", + "traits": { + "smithy.api#documentation": "The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options for attaching a VPC to pipeline.
" + } + }, "com.amazonaws.osis#VpcEndpoint": { "type": "structure", "members": { @@ -2606,6 +2793,12 @@ "traits": { "smithy.api#documentation": "A list of security groups associated with the VPC endpoint.
" } + }, + "VpcAttachmentOptions": { + "target": "com.amazonaws.osis#VpcAttachmentOptions", + "traits": { + "smithy.api#documentation": "Options for attaching a VPC to a pipeline.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index b1c3b4943d9..798e14c5fd5 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -4177,7 +4177,7 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
\nFor information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters only
" + "smithy.api#documentation": "A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.
\nFor information on AZs, see \n Availability Zones\n in the Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters only
\nConstraints:
\nCan't specify more than three AZs.
\nThe database engine to use for this DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: aurora-mysql | aurora-postgresql | mysql | postgres\n
The database engine to use for this DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
\n neptune - For information about using Amazon Neptune, see the\n \n Amazon Neptune User Guide\n .
The CA certificate identifier to use for the DB cluster's server certificate.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide.
\nValid for Cluster Type: Multi-AZ DB clusters
" } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n 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, \n 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, \n 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:
\nAmazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide\n
\nAmazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
Specifies whether to use the multi-tenant configuration or the single-tenant\n configuration (default). This parameter only applies to RDS for Oracle container\n database (CDB) engines.
\nNote the following restrictions:
\nThe DB engine that you specify in the request must support the multi-tenant\n configuration. If you attempt to enable the multi-tenant configuration on a DB\n engine that doesn't support it, the request fails.
\nIf you specify the multi-tenant configuration when you create your DB instance,\n you can't later modify this DB instance to use the single-tenant configuration.
\nThe life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n 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, \n 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.
\nYou can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n 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.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n 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 \n
The engine version to use for this global database cluster.
\nConstraints:
\nCan'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.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. \n 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, \n 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.
\nYou can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, \n 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.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for the DB cluster.
\nFor more information, see CreateDBCluster.
" + } } }, "traits": { @@ -9431,6 +9455,12 @@ "traits": { "smithy.api#documentation": "Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the\n single-tenant configuration (FALSE).
" } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The life cycle type for the DB instance.
\nFor more information, see CreateDBInstance.
" + } } }, "traits": { @@ -19380,6 +19410,12 @@ "smithy.api#documentation": "Indicates the database engine version.
" } }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The life cycle type for the global cluster.
\nFor more information, see CreateGlobalCluster.
" + } + }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { @@ -23243,7 +23279,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "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\n
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 \n
The type of pending maintenance action that is available for the resource. \n Valid actions are system-update, db-upgrade, hardware-maintenance, \n and ca-certificate-rotation.
The type of pending maintenance action that is available for the resource.
\nFor more information about maintenance actions, see Maintaining a DB instance.
\nValid Values: system-update | db-upgrade | hardware-maintenance | ca-certificate-rotation\n
Specifies the storage type to be associated with the DB cluster.
\nValid Values: aurora, aurora-iopt1\n
Default: aurora\n
Valid for: Aurora DB clusters only
" } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n 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, \n 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, \n 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:
\nAmazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide\n
\nAmazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
Reserved for future use.
" } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n 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, \n 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, \n 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:
\nAmazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide\n
\nAmazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
Reserved for future use.
" } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n 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, \n 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, \n 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:
\nAmazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide\n
\nAmazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The CA certificate identifier to use for the DB instance's server certificate.
\nThis setting doesn't apply to RDS Custom DB instances.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n 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, \n 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, \n 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.
\nThis 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.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The CA certificate identifier to use for the DB instance's server certificate.
\nThis setting doesn't apply to RDS Custom DB instances.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n 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, \n 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, \n 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.
\nThis 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.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The CA certificate identifier to use for the DB instance's server certificate.
\nThis setting doesn't apply to RDS Custom DB instances.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" } + }, + "EngineLifecycleSupport": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n 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, \n 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, \n 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.
\nThis 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.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
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.
" } }, "IsMajorVersionUpgrade": { diff --git a/codegen/sdk-codegen/aws-models/secrets-manager.json b/codegen/sdk-codegen/aws-models/secrets-manager.json index e24ad655487..004db92d47f 100644 --- a/codegen/sdk-codegen/aws-models/secrets-manager.json +++ b/codegen/sdk-codegen/aws-models/secrets-manager.json @@ -673,7 +673,22 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response.
\nSecrets 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.
\n\n Required permissions: \n secretsmanager:DescribeSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response.
\nSecrets 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.
\n\n Required permissions: \n secretsmanager:DescribeSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.
\nTo turn on rotation, use RotateSecret. To turn off\n rotation, use CancelRotateSecret.
" + "smithy.api#documentation": "Specifies whether automatic rotation is turned on for this secret.
\nTo turn on rotation, use RotateSecret. To turn off\n rotation, use CancelRotateSecret.
" } }, "RotationLambdaARN": { @@ -1227,7 +1242,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret to retrieve.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See Finding a secret from a partial ARN.
", "smithy.api#required": {} } }, @@ -1579,7 +1594,20 @@ "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" - } + }, + "smithy.test#smokeTests": [ + { + "id": "ListSecretsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.secretsmanager#ListSecretsRequest": { @@ -2430,7 +2458,7 @@ "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. \n The rotation schedule is defined in RotateSecretRequest$RotationRules.
\nFor 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 \n \n testSecret \n 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.
" + "smithy.api#documentation": "Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. \n The rotation schedule is defined in RotateSecretRequest$RotationRules.
\nFor 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 \n \n testSecret \n 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.
" } } }, @@ -3445,7 +3473,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "The ARN or name of the secret with the resource-based policy you want to validate.
" + "smithy.api#documentation": "This field is reserved for internal use.
" } }, "ResourcePolicy": {