From 8915ee75bf79cc4a5c26bf90483d7b6f704ea2a1 Mon Sep 17 00:00:00 2001
From: Dongie Agnir <261310+dagnir@users.noreply.github.com>
Date: Fri, 19 Sep 2025 11:07:44 -0700
Subject: [PATCH 1/4] Reuse computed checksums across retries (#6413)
* Reuse computed checksums across retries
This commit adds the ability to reuse previously computed checksums for
a request across retries.
This ensures that if a request data stream is modified between attempts
that the server will reject the request.
As part of this change, the `http-auth-spi` package has been updated to
expose a new interface: `PayloadChecksumStore`. This is a simple storage
interface that allows signers to store and retrieve computed checksums.
Additionally, a new `SignerProperty` is introduced,
`SdkInternalHttpSignerProperty.CHECKSUM_CACHE` so that signers and
their callers can access this cache.
Note that both the interface and associated signer property are
`@SdkProtectedApi` and not intended to be used by non-SDK consumers of
`http-auth-spi`.
Finally, this adds a dependency on `checksums-spi` for `http-auth-spi`.
* Update core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/http/pipeline/stages/SigningStage.java
Co-authored-by: David Ho <70000000+davidh44@users.noreply.github.com>
* Review comments
---------
Co-authored-by: David Ho <70000000+davidh44@users.noreply.github.com>
---
.../signer/AwsChunkedV4aPayloadSigner.java | 34 ++-
.../signer/DefaultAwsCrtV4aHttpSigner.java | 16 +-
.../signer/AwsChunkedV4PayloadSigner.java | 34 ++-
.../auth/aws/internal/signer/Checksummer.java | 14 +-
.../signer/DefaultAwsV4HttpSigner.java | 15 +-
.../internal/signer/FlexibleChecksummer.java | 16 +-
.../signer/NoOpPayloadChecksumStore.java | 45 ++++
.../ChecksumTrailerProvider.java | 17 +-
.../internal/signer/util/ChecksumUtil.java | 9 +-
.../awssdk/http/auth/aws/TestUtils.java | 8 +-
.../awssdk/http/auth/aws/crt/TestUtils.java | 7 +-
.../DefaultAwsCrtV4aHttpSignerTest.java | 185 ++++++++++++-
.../signer/DefaultAwsV4HttpSignerTest.java | 253 ++++++++++++++----
.../signer/FlexibleChecksummerTest.java | 72 ++++-
.../ChecksumTrailerProviderTest.java | 87 ++++++
core/http-auth-spi/pom.xml | 5 +
.../signer/DefaultPayloadChecksumStore.java | 46 ++++
.../auth/spi/signer/PayloadChecksumStore.java | 52 ++++
.../signer/SdkInternalHttpSignerProperty.java | 37 +++
.../spi/signer/PayloadChecksumStoreTest.java | 78 ++++++
.../SdkInternalExecutionAttribute.java | 8 +
.../checksums/LegacyPayloadChecksumCache.java | 37 +++
.../pipeline/stages/HttpChecksumStage.java | 10 +
.../http/pipeline/stages/SigningStage.java | 12 +-
.../stages/HttpChecksumStageSraTest.java | 27 ++
.../pipeline/stages/SigningStageTest.java | 32 +++
services/s3/pom.xml | 6 +
.../s3/checksums/ChecksumReuseTest.java | 163 +++++++++++
28 files changed, 1237 insertions(+), 88 deletions(-)
create mode 100644 core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/NoOpPayloadChecksumStore.java
create mode 100644 core/http-auth-aws/src/test/java/software/amazon/awssdk/http/auth/aws/internal/signer/chunkedencoding/ChecksumTrailerProviderTest.java
create mode 100644 core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/internal/signer/DefaultPayloadChecksumStore.java
create mode 100644 core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/signer/PayloadChecksumStore.java
create mode 100644 core/http-auth-spi/src/main/java/software/amazon/awssdk/http/auth/spi/signer/SdkInternalHttpSignerProperty.java
create mode 100644 core/http-auth-spi/src/test/java/software/amazon/awssdk/http/auth/spi/signer/PayloadChecksumStoreTest.java
create mode 100644 core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/checksums/LegacyPayloadChecksumCache.java
create mode 100644 services/s3/src/test/java/software/amazon/awssdk/services/s3/checksums/ChecksumReuseTest.java
diff --git a/core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/crt/internal/signer/AwsChunkedV4aPayloadSigner.java b/core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/crt/internal/signer/AwsChunkedV4aPayloadSigner.java
index 0124b2ea2c56..644e204f34b0 100644
--- a/core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/crt/internal/signer/AwsChunkedV4aPayloadSigner.java
+++ b/core/http-auth-aws/src/main/java/software/amazon/awssdk/http/auth/aws/crt/internal/signer/AwsChunkedV4aPayloadSigner.java
@@ -35,12 +35,15 @@
import software.amazon.awssdk.http.Header;
import software.amazon.awssdk.http.SdkHttpRequest;
import software.amazon.awssdk.http.auth.aws.internal.signer.CredentialScope;
+import software.amazon.awssdk.http.auth.aws.internal.signer.NoOpPayloadChecksumStore;
import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChecksumTrailerProvider;
import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChunkedEncodedInputStream;
import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.TrailerProvider;
import software.amazon.awssdk.http.auth.aws.internal.signer.io.ChecksumInputStream;
import software.amazon.awssdk.http.auth.aws.internal.signer.io.ResettableContentStreamProvider;
+import software.amazon.awssdk.http.auth.spi.signer.PayloadChecksumStore;
import software.amazon.awssdk.utils.BinaryUtils;
+import software.amazon.awssdk.utils.Logger;
import software.amazon.awssdk.utils.Pair;
import software.amazon.awssdk.utils.StringInputStream;
import software.amazon.awssdk.utils.Validate;
@@ -51,16 +54,20 @@
*/
@SdkInternalApi
public final class AwsChunkedV4aPayloadSigner implements V4aPayloadSigner {
+ private static final Logger LOG = Logger.loggerFor(AwsChunkedV4aPayloadSigner.class);
private final CredentialScope credentialScope;
private final int chunkSize;
private final ChecksumAlgorithm checksumAlgorithm;
+ private final PayloadChecksumStore payloadChecksumStore;
private final List
is in preview release and is subject to change.
Welcome to the Amazon Bedrock AgentCore Control plane API reference. Control plane actions configure, create, modify, and monitor Amazon Web Services resources.
" } diff --git a/services/bedrockagentruntime/pom.xml b/services/bedrockagentruntime/pom.xml index 5ff7fc5d2a29..39952334931f 100644 --- a/services/bedrockagentruntime/pom.xml +++ b/services/bedrockagentruntime/pom.xml @@ -17,7 +17,7 @@Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.
" + "documentation":"Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.
", + "readonly":true }, "GetAgentMemory":{ "name":"GetAgentMemory", @@ -160,7 +160,8 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Gets the sessions stored in the memory of the agent.
" + "documentation":"Gets the sessions stored in the memory of the agent.
", + "readonly":true }, "GetExecutionFlowSnapshot":{ "name":"GetExecutionFlowSnapshot", @@ -178,7 +179,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Retrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
" + "documentation":"Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
", + "readonly":true }, "GetInvocationStep":{ "name":"GetInvocationStep", @@ -214,7 +217,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" + "documentation":"Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "readonly":true }, "GetSession":{ "name":"GetSession", @@ -232,7 +236,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" + "documentation":"Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "readonly":true }, "InvokeAgent":{ "name":"InvokeAgent", @@ -317,7 +322,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" + "documentation":"Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "readonly":true }, "ListInvocations":{ "name":"ListInvocations", @@ -371,7 +379,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" + "documentation":"Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "readonly":true }, "ListSessions":{ "name":"ListSessions", @@ -388,7 +397,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" + "documentation":"Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -406,7 +416,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"List all the tags for the resource you specify.
" + "documentation":"List all the tags for the resource you specify.
", + "readonly":true }, "OptimizePrompt":{ "name":"OptimizePrompt", @@ -490,7 +501,8 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Queries a knowledge base and retrieves information from it.
" + "documentation":"Queries a knowledge base and retrieves information from it.
", + "readonly":true }, "RetrieveAndGenerate":{ "name":"RetrieveAndGenerate", @@ -642,13 +654,13 @@ "APISchema":{ "type":"structure", "members":{ - "payload":{ - "shape":"Payload", - "documentation":"The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
" - }, "s3":{ "shape":"S3Identifier", "documentation":"Contains details about the S3 object containing the OpenAPI schema for the action group.
" + }, + "payload":{ + "shape":"Payload", + "documentation":"The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
" } }, "documentation":"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.
", @@ -658,7 +670,7 @@ "type":"string", "max":2048, "min":0, - "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" + "pattern":"arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}" }, "AccessDeniedException":{ "type":"structure", @@ -675,13 +687,13 @@ "ActionGroupExecutor":{ "type":"structure", "members":{ - "customControl":{ - "shape":"CustomControlMethod", - "documentation":" To return the action group invocation results directly in the InvokeInlineAgent
response, specify RETURN_CONTROL
.
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + }, + "customControl":{ + "shape":"CustomControlMethod", + "documentation":" To return the action group invocation results directly in the InvokeInlineAgent
response, specify RETURN_CONTROL
.
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.
", @@ -694,22 +706,14 @@ "shape":"ActionGroupName", "documentation":"The name of the action group.
" }, + "verb":{ + "shape":"Verb", + "documentation":"The API method being used, based off the action group.
" + }, "apiPath":{ "shape":"ApiPath", "documentation":"The path to the API to call, based off the action group.
" }, - "executionType":{ - "shape":"ExecutionType", - "documentation":"How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.
" - }, - "function":{ - "shape":"Function", - "documentation":"The function in the action group to call.
" - }, - "invocationId":{ - "shape":"String", - "documentation":"The unique identifier of the invocation. Only returned if the executionType
is RETURN_CONTROL
.
The parameters in the Lambda input event.
" @@ -718,9 +722,17 @@ "shape":"RequestBody", "documentation":"The parameters in the request body for the Lambda input event.
" }, - "verb":{ - "shape":"Verb", - "documentation":"The API method being used, based off the action group.
" + "function":{ + "shape":"Function", + "documentation":"The function in the action group to call.
" + }, + "executionType":{ + "shape":"ExecutionType", + "documentation":"How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.
" + }, + "invocationId":{ + "shape":"String", + "documentation":"The unique identifier of the invocation. Only returned if the executionType
is RETURN_CONTROL
.
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.
" @@ -728,13 +740,13 @@ "ActionGroupInvocationOutput":{ "type":"structure", "members":{ - "metadata":{ - "shape":"Metadata", - "documentation":"Contains information about the action group output.
" - }, "text":{ "shape":"ActionGroupOutputString", "documentation":"The JSON-formatted string returned by the API invoked by the action group.
" + }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the action group output.
" } }, "documentation":"Contains the JSON-formatted string returned by the API invoked by the action group.
" @@ -792,38 +804,37 @@ }, "AdditionalModelRequestFieldsValue":{ "type":"structure", - "members":{ - }, + "members":{}, "document":true }, "AgentActionGroup":{ "type":"structure", "required":["actionGroupName"], "members":{ - "actionGroupExecutor":{ - "shape":"ActionGroupExecutor", - "documentation":"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.
" - }, "actionGroupName":{ "shape":"ResourceName", "documentation":"The name of the action group.
" }, - "apiSchema":{ - "shape":"APISchema", - "documentation":"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.
" - }, "description":{ "shape":"ResourceDescription", "documentation":"A description of the action group.
" }, - "functionSchema":{ - "shape":"FunctionSchema", - "documentation":"Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" - }, "parentActionGroupSignature":{ "shape":"ActionGroupSignature", "documentation":"Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description
, apiSchema
, and actionGroupExecutor
fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput
.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter
.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
ANTHROPIC.Computer
- Gives the agent permission to use the mouse and keyboard and take screenshots.
ANTHROPIC.TextEditor
- Gives the agent permission to view, create and edit files.
ANTHROPIC.Bash
- Gives the agent permission to run commands in a bash shell.
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.
" + }, + "apiSchema":{ + "shape":"APISchema", + "documentation":"Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + }, + "functionSchema":{ + "shape":"FunctionSchema", + "documentation":"Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + }, "parentActionGroupSignatureParams":{ "shape":"ActionGroupSignatureParams", "documentation":"The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
An action invocation result.
" + "type":{ + "shape":"PayloadType", + "documentation":"The input type.
" }, "text":{ "shape":"AgentCollaboratorPayloadString", "documentation":"Input text.
" }, - "type":{ - "shape":"PayloadType", - "documentation":"The input type.
" + "returnControlResults":{ + "shape":"ReturnControlResults", + "documentation":"An action invocation result.
" } }, "documentation":"Input for an agent collaborator. The input can be text or an action invocation result.
" @@ -876,14 +887,14 @@ "AgentCollaboratorInvocationInput":{ "type":"structure", "members":{ - "agentCollaboratorAliasArn":{ - "shape":"AgentAliasArn", - "documentation":"The collaborator's alias ARN.
" - }, "agentCollaboratorName":{ "shape":"String", "documentation":"The collaborator's name.
" }, + "agentCollaboratorAliasArn":{ + "shape":"AgentAliasArn", + "documentation":"The collaborator's alias ARN.
" + }, "input":{ "shape":"AgentCollaboratorInputPayload", "documentation":"Text or action invocation result input for the collaborator.
" @@ -894,21 +905,21 @@ "AgentCollaboratorInvocationOutput":{ "type":"structure", "members":{ - "agentCollaboratorAliasArn":{ - "shape":"AgentAliasArn", - "documentation":"The output's agent collaborator alias ARN.
" - }, "agentCollaboratorName":{ "shape":"String", "documentation":"The output's agent collaborator name.
" }, - "metadata":{ - "shape":"Metadata", - "documentation":"Contains information about the output from the agent collaborator.
" + "agentCollaboratorAliasArn":{ + "shape":"AgentAliasArn", + "documentation":"The output's agent collaborator alias ARN.
" }, "output":{ "shape":"AgentCollaboratorOutputPayload", "documentation":"The output's output.
" + }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the output from the agent collaborator.
" } }, "documentation":"Output from an agent collaborator.
" @@ -916,17 +927,17 @@ "AgentCollaboratorOutputPayload":{ "type":"structure", "members":{ - "returnControlPayload":{ - "shape":"ReturnControlPayload", - "documentation":"An action invocation result.
" + "type":{ + "shape":"PayloadType", + "documentation":"The type of output.
" }, "text":{ "shape":"AgentCollaboratorPayloadString", "documentation":"Text output.
" }, - "type":{ - "shape":"PayloadType", - "documentation":"The type of output.
" + "returnControlPayload":{ + "shape":"ReturnControlPayload", + "documentation":"An action invocation result.
" } }, "documentation":"Output from an agent collaborator. The output can be text or an action invocation result.
" @@ -939,13 +950,17 @@ "type":"string", "max":10, "min":0, - "pattern":"^[0-9a-zA-Z]+$" + "pattern":"[0-9a-zA-Z]+" + }, + "AgentTraces":{ + "type":"list", + "member":{"shape":"TracePart"} }, "AgentVersion":{ "type":"string", "max":5, "min":1, - "pattern":"^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + "pattern":"(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})" }, "AnalyzePromptEvent":{ "type":"structure", @@ -972,26 +987,14 @@ "shape":"String", "documentation":"The action group that the API operation belongs to.
" }, - "actionInvocationType":{ - "shape":"ActionInvocationType", - "documentation":"Contains information about the API operation to invoke.
" - }, - "agentId":{ + "httpMethod":{ "shape":"String", - "documentation":"The agent's ID.
" + "documentation":"The HTTP method of the API operation.
" }, "apiPath":{ "shape":"ApiPath", "documentation":"The path to the API operation.
" }, - "collaboratorName":{ - "shape":"Name", - "documentation":"The agent collaborator's name.
" - }, - "httpMethod":{ - "shape":"String", - "documentation":"The HTTP method of the API operation.
" - }, "parameters":{ "shape":"ApiParameters", "documentation":"The parameters to provide for the API request, as the agent elicited from the user.
" @@ -999,6 +1002,18 @@ "requestBody":{ "shape":"ApiRequestBody", "documentation":"The request body to provide for the API request, as the agent elicited from the user.
" + }, + "actionInvocationType":{ + "shape":"ActionInvocationType", + "documentation":"Contains information about the API operation to invoke.
" + }, + "agentId":{ + "shape":"String", + "documentation":"The agent's ID.
" + }, + "collaboratorName":{ + "shape":"Name", + "documentation":"The agent collaborator's name.
" } }, "documentation":"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
The action group that the API operation belongs to.
" }, - "agentId":{ + "httpMethod":{ "shape":"String", - "documentation":"The agent's ID.
" + "documentation":"The HTTP method for the API operation.
" }, "apiPath":{ "shape":"ApiPath", @@ -1059,9 +1074,9 @@ "shape":"ConfirmationState", "documentation":"Controls the API operations or functions to invoke based on the user confirmation.
" }, - "httpMethod":{ - "shape":"String", - "documentation":"The HTTP method for the API operation.
" + "responseState":{ + "shape":"ResponseState", + "documentation":"Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" }, "httpStatusCode":{ "shape":"Integer", @@ -1071,9 +1086,9 @@ "shape":"ResponseBody", "documentation":"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.
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
" + "agentId":{ + "shape":"String", + "documentation":"The agent's ID.
" } }, "documentation":"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
Contains configurations for a reranker model.
" - }, "numberOfResults":{ "shape":"BedrockRerankingConfigurationNumberOfResultsInteger", "documentation":"The number of results to return after reranking.
" + }, + "modelConfiguration":{ + "shape":"BedrockRerankingModelConfiguration", + "documentation":"Contains configurations for a reranker model.
" } }, "documentation":"Contains configurations for an Amazon Bedrock reranker model.
" @@ -1158,19 +1173,19 @@ "type":"string", "max":2048, "min":1, - "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" + "pattern":"(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?" }, "BedrockRerankingModelConfiguration":{ "type":"structure", "required":["modelArn"], "members":{ - "additionalModelRequestFields":{ - "shape":"AdditionalModelRequestFields", - "documentation":"A JSON object whose keys are request fields for the model and whose values are values for those fields.
" - }, "modelArn":{ "shape":"BedrockModelArn", "documentation":"The ARN of the reranker model.
" + }, + "additionalModelRequestFields":{ + "shape":"AdditionalModelRequestFields", + "documentation":"A JSON object whose keys are request fields for the model and whose values are values for those fields.
" } }, "documentation":"Contains configurations for a reranker model.
" @@ -1178,13 +1193,13 @@ "BedrockSessionContentBlock":{ "type":"structure", "members":{ - "image":{ - "shape":"ImageBlock", - "documentation":"The image in the invocation step.
" - }, "text":{ "shape":"BedrockSessionContentBlockTextString", "documentation":"The text in the invocation step.
" + }, + "image":{ + "shape":"ImageBlock", + "documentation":"The image in the invocation step.
" } }, "documentation":"A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the payLoad
of the PutInvocationStep API operation. You retrieve the content with the GetInvocationStep API operation.
For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", @@ -1214,11 +1229,15 @@ "ByteContentDoc":{ "type":"structure", "required":[ + "identifier", "contentType", - "data", - "identifier" + "data" ], "members":{ + "identifier":{ + "shape":"Identifier", + "documentation":"The file name of the document contained in the wrapper object.
" + }, "contentType":{ "shape":"ContentType", "documentation":"The MIME type of the document contained in the wrapper object.
" @@ -1226,10 +1245,6 @@ "data":{ "shape":"ByteContentBlob", "documentation":"The byte value of the file to upload, encoded as a Base-64 string.
" - }, - "identifier":{ - "shape":"Identifier", - "documentation":"The file name of the document contained in the wrapper object.
" } }, "documentation":"This property contains the document to chat with, along with its attributes.
" @@ -1237,17 +1252,17 @@ "ByteContentFile":{ "type":"structure", "required":[ - "data", - "mediaType" + "mediaType", + "data" ], "members":{ - "data":{ - "shape":"ByteContentBlob", - "documentation":"The raw bytes of the file to attach. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.
" - }, "mediaType":{ "shape":"MimeType", "documentation":"The MIME type of data contained in the file used for chat.
" + }, + "data":{ + "shape":"ByteContentBlob", + "documentation":"The raw bytes of the file to attach. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.
" } }, "documentation":"The property contains the file to chat with, along with its attributes.
" @@ -1288,7 +1303,8 @@ "shape":"Citation", "documentation":"The citation.
", "deprecated":true, - "deprecatedMessage":"Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event." + "deprecatedMessage":"Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event.", + "deprecatedSince":"2024-12-17" }, "generatedResponsePart":{ "shape":"GeneratedResponsePart", @@ -1323,22 +1339,22 @@ "CodeInterpreterInvocationOutput":{ "type":"structure", "members":{ - "executionError":{ - "shape":"String", - "documentation":"Contains the error returned from code execution.
" - }, "executionOutput":{ "shape":"String", "documentation":"Contains the successful output returned from code execution
" }, - "executionTimeout":{ - "shape":"Boolean", - "documentation":"Indicates if the execution of the code timed out.
" + "executionError":{ + "shape":"String", + "documentation":"Contains the error returned from code execution.
" }, "files":{ "shape":"Files", "documentation":"Contains output files, if generated by code execution.
" }, + "executionTimeout":{ + "shape":"Boolean", + "documentation":"Indicates if the execution of the code timed out.
" + }, "metadata":{ "shape":"Metadata", "documentation":"Contains information about the output from the code interpreter.
" @@ -1359,22 +1375,6 @@ "instruction" ], "members":{ - "actionGroups":{ - "shape":"AgentActionGroups", - "documentation":"List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
" - }, - "agentCollaboration":{ - "shape":"AgentCollaboration", - "documentation":"Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
" - }, - "agentName":{ - "shape":"Name", - "documentation":" Name of the inline collaborator agent which must be the same name as specified for collaboratorName
.
Settings of the collaborator agent.
" - }, "customerEncryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
" @@ -1383,25 +1383,41 @@ "shape":"ModelIdentifier", "documentation":"The foundation model used by the inline collaborator agent.
" }, - "guardrailConfiguration":{ - "shape":"GuardrailConfigurationWithArn", - "documentation":"Details of the guardwrail associated with the inline collaborator.
" + "instruction":{ + "shape":"Instruction", + "documentation":"Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
" }, "idleSessionTTLInSeconds":{ "shape":"SessionTTL", "documentation":"The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator 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.
" }, - "instruction":{ - "shape":"Instruction", - "documentation":"Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
" + "actionGroups":{ + "shape":"AgentActionGroups", + "documentation":"List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
" }, "knowledgeBases":{ "shape":"KnowledgeBases", "documentation":"Knowledge base associated with the inline collaborator agent.
" }, - "promptOverrideConfiguration":{ - "shape":"PromptOverrideConfiguration", + "guardrailConfiguration":{ + "shape":"GuardrailConfigurationWithArn", + "documentation":"Details of the guardwrail associated with the inline collaborator.
" + }, + "promptOverrideConfiguration":{ + "shape":"PromptOverrideConfiguration", "documentation":"Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.
" + }, + "agentCollaboration":{ + "shape":"AgentCollaboration", + "documentation":"Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
" + }, + "collaboratorConfigurations":{ + "shape":"CollaboratorConfigurations", + "documentation":"Settings of the collaborator agent.
" + }, + "agentName":{ + "shape":"Name", + "documentation":" Name of the inline collaborator agent which must be the same name as specified for collaboratorName
.
List of inline collaborators.
" @@ -1409,21 +1425,21 @@ "CollaboratorConfiguration":{ "type":"structure", "required":[ - "collaboratorInstruction", - "collaboratorName" + "collaboratorName", + "collaboratorInstruction" ], "members":{ - "agentAliasArn":{ - "shape":"AgentAliasArn", - "documentation":"The Amazon Resource Name (ARN) of the inline collaborator agent.
" + "collaboratorName":{ + "shape":"Name", + "documentation":" Name of the inline collaborator agent which must be the same name as specified for agentName
.
Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
" }, - "collaboratorName":{ - "shape":"Name", - "documentation":" Name of the inline collaborator agent which must be the same name as specified for agentName
.
The Amazon Resource Name (ARN) of the inline collaborator agent.
" }, "relayConversationHistory":{ "shape":"RelayConversationHistory", @@ -1444,21 +1460,21 @@ "type":"structure", "required":[ "nodeName", - "satisfiedConditions", - "timestamp" + "timestamp", + "satisfiedConditions" ], "members":{ "nodeName":{ "shape":"NodeName", "documentation":"The name of the condition node that evaluated the conditions.
" }, - "satisfiedConditions":{ - "shape":"SatisfiedConditions", - "documentation":"A list of conditions that were satisfied during the evaluation.
" - }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the condition evaluation occurred.
" + }, + "satisfiedConditions":{ + "shape":"SatisfiedConditions", + "documentation":"A list of conditions that were satisfied during the evaluation.
" } }, "documentation":"Contains information about a condition evaluation result during a flow execution. This event is generated when a condition node in the flow evaluates its conditions.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
A description for the interactions in the invocation. For example, \"User asking about weather in Seattle\".
" - }, "invocationId":{ "shape":"Uuid", "documentation":"A unique identifier for the invocation in UUID format.
" }, + "description":{ + "shape":"InvocationDescription", + "documentation":"A description for the interactions in the invocation. For example, \"User asking about weather in Seattle\".
" + }, "sessionIdentifier":{ "shape":"SessionIdentifier", "documentation":"The unique identifier for the associated session for the invocation. You can specify either the session's sessionId
or its Amazon Resource Name (ARN).
The timestamp for when the invocation was created.
" + "sessionId":{ + "shape":"Uuid", + "documentation":"The unique identifier for the session associated with the invocation.
" }, "invocationId":{ "shape":"Uuid", "documentation":"The unique identifier for the invocation.
" }, - "sessionId":{ - "shape":"Uuid", - "documentation":"The unique identifier for the session associated with the invocation.
" + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp for when the invocation was created.
" } } }, "CreateSessionRequest":{ "type":"structure", "members":{ - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.
" - }, "sessionMetadata":{ "shape":"SessionMetadataMap", "documentation":"A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.
" }, + "encryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.
" + }, "tags":{ "shape":"TagsMap", "documentation":"Specify the key-value pairs for the tags that you want to attach to the session.
" @@ -1601,27 +1617,27 @@ "CreateSessionResponse":{ "type":"structure", "required":[ - "createdAt", - "sessionArn", "sessionId", - "sessionStatus" + "sessionArn", + "sessionStatus", + "createdAt" ], "members":{ - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"The timestamp for when the session was created.
" + "sessionId":{ + "shape":"Uuid", + "documentation":"The unique identifier for the session.
" }, "sessionArn":{ "shape":"SessionArn", "documentation":"The Amazon Resource Name (ARN) of the created session.
" }, - "sessionId":{ - "shape":"Uuid", - "documentation":"The unique identifier for the session.
" - }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"The current status of the session.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp for when the session was created.
" } } }, @@ -1649,13 +1665,13 @@ "CustomOrchestrationTrace":{ "type":"structure", "members":{ - "event":{ - "shape":"CustomOrchestrationTraceEvent", - "documentation":"The event details used with the custom orchestration.
" - }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" + }, + "event":{ + "shape":"CustomOrchestrationTraceEvent", + "documentation":"The event details used with the custom orchestration.
" } }, "documentation":"The trace behavior for the custom orchestration.
", @@ -1680,22 +1696,22 @@ "DeleteAgentMemoryRequest":{ "type":"structure", "required":[ - "agentAliasId", - "agentId" + "agentId", + "agentAliasId" ], "members":{ - "agentAliasId":{ - "shape":"AgentAliasId", - "documentation":"The unique identifier of an alias of an agent.
", - "location":"uri", - "locationName":"agentAliasId" - }, "agentId":{ "shape":"AgentId", "documentation":"The unique identifier of the agent to which the alias belongs.
", "location":"uri", "locationName":"agentId" }, + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"The unique identifier of an alias of an agent.
", + "location":"uri", + "locationName":"agentAliasId" + }, "memoryId":{ "shape":"MemoryId", "documentation":"The unique identifier of the memory.
", @@ -1712,8 +1728,7 @@ }, "DeleteAgentMemoryResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteSessionRequest":{ "type":"structure", @@ -1729,8 +1744,7 @@ }, "DeleteSessionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DependencyFailedException":{ "type":"structure", @@ -1750,8 +1764,7 @@ }, "Document":{ "type":"structure", - "members":{ - }, + "members":{}, "document":true }, "Double":{ @@ -1773,19 +1786,19 @@ "EndSessionResponse":{ "type":"structure", "required":[ - "sessionArn", "sessionId", + "sessionArn", "sessionStatus" ], "members":{ - "sessionArn":{ - "shape":"SessionArn", - "documentation":"The Amazon Resource Name (ARN) of the session you ended.
" - }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier of the session you ended.
" }, + "sessionArn":{ + "shape":"SessionArn", + "documentation":"The Amazon Resource Name (ARN) of the session you ended.
" + }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"The current status of the session you ended.
" @@ -1803,17 +1816,17 @@ "type":"structure", "required":["sourceType"], "members":{ - "byteContent":{ - "shape":"ByteContentDoc", - "documentation":"The identifier, contentType, and data of the external source wrapper object.
" + "sourceType":{ + "shape":"ExternalSourceType", + "documentation":"The source type of the external source wrapper object.
" }, "s3Location":{ "shape":"S3ObjectDoc", "documentation":"The S3 location of the external source wrapper object.
" }, - "sourceType":{ - "shape":"ExternalSourceType", - "documentation":"The source type of the external source wrapper object.
" + "byteContent":{ + "shape":"ByteContentDoc", + "documentation":"The identifier, contentType, and data of the external source wrapper object.
" } }, "documentation":"The unique external source of the content contained in the wrapper object.
" @@ -1834,9 +1847,9 @@ "ExternalSourcesGenerationConfiguration":{ "type":"structure", "members":{ - "additionalModelRequestFields":{ - "shape":"AdditionalModelRequestFields", - "documentation":"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.
" + "promptTemplate":{ + "shape":"PromptTemplate", + "documentation":"Contain the textPromptTemplate string for the external source wrapper object.
" }, "guardrailConfiguration":{ "shape":"GuardrailConfiguration", @@ -1846,13 +1859,13 @@ "shape":"InferenceConfig", "documentation":"Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
" }, + "additionalModelRequestFields":{ + "shape":"AdditionalModelRequestFields", + "documentation":"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.
" + }, "performanceConfig":{ "shape":"PerformanceConfiguration", "documentation":"The latency configuration for the model.
" - }, - "promptTemplate":{ - "shape":"PromptTemplate", - "documentation":"Contain the textPromptTemplate string for the external source wrapper object.
" } }, "documentation":"Contains the generation configuration of the external source wrapper object.
" @@ -1864,10 +1877,6 @@ "sources" ], "members":{ - "generationConfiguration":{ - "shape":"ExternalSourcesGenerationConfiguration", - "documentation":"The prompt used with the external source wrapper object with the retrieveAndGenerate
function.
The model Amazon Resource Name (ARN) for the external source wrapper object in the retrieveAndGenerate
function.
The document for the external source wrapper object in the retrieveAndGenerate
function.
The prompt used with the external source wrapper object with the retrieveAndGenerate
function.
The configurations of the external source wrapper object in the retrieveAndGenerate
function.
The failure code for the trace.
" + "traceId":{ + "shape":"TraceId", + "documentation":"The unique identifier of the trace.
" }, "failureReason":{ "shape":"FailureReasonString", "documentation":"The reason the interaction failed.
" }, + "failureCode":{ + "shape":"Integer", + "documentation":"The failure code for the trace.
" + }, "metadata":{ "shape":"Metadata", "documentation":"Information about the failure that occurred.
" - }, - "traceId":{ - "shape":"TraceId", - "documentation":"The unique identifier of the trace.
" } }, "documentation":"Contains information about the failure of the interaction.
", @@ -1950,17 +1963,17 @@ "type":"structure", "required":["sourceType"], "members":{ - "byteContent":{ - "shape":"ByteContentFile", - "documentation":"The data and the text of the attached files.
" + "sourceType":{ + "shape":"FileSourceType", + "documentation":"The source type of the files to attach.
" }, "s3Location":{ "shape":"S3ObjectFile", "documentation":"The s3 location of the files to attach.
" }, - "sourceType":{ - "shape":"FileSourceType", - "documentation":"The source type of the files to attach.
" + "byteContent":{ + "shape":"ByteContentFile", + "documentation":"The data and the text of the attached files.
" } }, "documentation":"The source file of the content contained in the wrapper object.
" @@ -2008,20 +2021,19 @@ }, "FilterValue":{ "type":"structure", - "members":{ - }, + "members":{}, "document":true }, "FinalResponse":{ "type":"structure", "members":{ - "metadata":{ - "shape":"Metadata", - "documentation":"Contains information about the invoke agent operation.
" - }, "text":{ "shape":"FinalResponseString", "documentation":"The text in the response to the user.
" + }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the invoke agent operation.
" } }, "documentation":"Contains details about the response to the user.
" @@ -2038,7 +2050,7 @@ "type":"string", "max":2048, "min":0, - "pattern":"^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" + "pattern":"(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\\bTSTALIASID\\b|[0-9a-zA-Z]+)" }, "FlowCompletionEvent":{ "type":"structure", @@ -2060,6 +2072,13 @@ "INPUT_REQUIRED" ] }, + "FlowControlNodeType":{ + "type":"string", + "enum":[ + "Iterator", + "Loop" + ] + }, "FlowErrorCode":{ "type":"string", "enum":[ @@ -2083,6 +2102,10 @@ "FlowExecutionError":{ "type":"structure", "members":{ + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node in the flow where the error occurred (if applicable).
" + }, "error":{ "shape":"FlowExecutionErrorType", "documentation":"The error code for the type of error that occurred.
" @@ -2090,10 +2113,6 @@ "message":{ "shape":"String", "documentation":"A descriptive message that provides details about the error.
" - }, - "nodeName":{ - "shape":"NodeName", - "documentation":"The name of the node in the flow where the error occurred (if applicable).
" } }, "documentation":"Contains information about an error that occurred during an flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.
" - }, - "flowFailureEvent":{ - "shape":"FlowFailureEvent", - "documentation":"Contains information about a failure that occurred at the flow level during execution.
" - }, "flowInputEvent":{ "shape":"FlowExecutionInputEvent", "documentation":"Contains information about the inputs provided to the flow at the start of execution.
" @@ -2125,10 +2136,6 @@ "shape":"FlowExecutionOutputEvent", "documentation":"Contains information about the outputs produced by the flow at the end of execution.
" }, - "nodeFailureEvent":{ - "shape":"NodeFailureEvent", - "documentation":"Contains information about a failure that occurred at a specific node during execution.
" - }, "nodeInputEvent":{ "shape":"NodeInputEvent", "documentation":"Contains information about the inputs provided to a specific node during execution.
" @@ -2136,6 +2143,26 @@ "nodeOutputEvent":{ "shape":"NodeOutputEvent", "documentation":"Contains information about the outputs produced by a specific node during execution.
" + }, + "conditionResultEvent":{ + "shape":"ConditionResultEvent", + "documentation":"Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.
" + }, + "nodeFailureEvent":{ + "shape":"NodeFailureEvent", + "documentation":"Contains information about a failure that occurred at a specific node during execution.
" + }, + "flowFailureEvent":{ + "shape":"FlowFailureEvent", + "documentation":"Contains information about a failure that occurred at the flow level during execution.
" + }, + "nodeActionEvent":{ + "shape":"NodeActionEvent", + "documentation":"Contains information about an action (operation) called by a node during execution.
" + }, + "nodeDependencyEvent":{ + "shape":"NodeDependencyEvent", + "documentation":"Contains information about an internal trace of a specific node during execution.
" } }, "documentation":"Represents an event that occurred during an flow execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
A list of input fields provided to the flow.
" - }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that receives the inputs.
" @@ -2185,6 +2208,10 @@ "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the inputs are provided.
" + }, + "fields":{ + "shape":"FlowInputFields", + "documentation":"A list of input fields provided to the flow.
" } }, "documentation":"Contains information about the inputs provided to the flow at the start of a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
A list of output fields produced by the flow.
" - }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that produces the outputs.
" @@ -2215,6 +2238,10 @@ "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the outputs are produced.
" + }, + "fields":{ + "shape":"FlowOutputFields", + "documentation":"A list of output fields produced by the flow.
" } }, "documentation":"Contains information about the outputs produced by the flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The timestamp when the flow execution was created.
" - }, - "endedAt":{ - "shape":"DateTimestamp", - "documentation":"The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" - }, - "executionArn":{ - "shape":"FlowExecutionIdentifier", - "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
" + "executionArn":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", @@ -2280,6 +2299,14 @@ "status":{ "shape":"FlowExecutionStatus", "documentation":"The current status of the flow execution.
Flow executions time out after 24 hours.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the flow execution was created.
" + }, + "endedAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" } }, "documentation":"Contains summary information about a flow execution, including its status, timestamps, and identifiers.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The timestamp when the failure occurred.
" + }, "errorCode":{ "shape":"FlowErrorCode", "documentation":"The error code that identifies the type of failure that occurred.
" @@ -2299,10 +2330,6 @@ "errorMessage":{ "shape":"String", "documentation":"A descriptive message that provides details about the failure.
" - }, - "timestamp":{ - "shape":"DateTimestamp", - "documentation":"The timestamp when the failure occurred.
" } }, "documentation":"Contains information about a failure that occurred at the flow level during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about an input into the prompt flow.
" - }, - "nodeInputName":{ - "shape":"NodeInputName", - "documentation":"The name of the input from the flow input node.
" - }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the flow input node that begins the prompt flow.
" @@ -2336,6 +2355,14 @@ "nodeOutputName":{ "shape":"NodeOutputName", "documentation":"The name of the output from the flow input node that begins the prompt flow.
" + }, + "content":{ + "shape":"FlowInputContent", + "documentation":"Contains information about an input into the prompt flow.
" + }, + "nodeInputName":{ + "shape":"NodeInputName", + "documentation":"The name of the input from the flow input node.
" } }, "documentation":"Contains information about an input into the prompt flow and where to send it.
" @@ -2355,17 +2382,17 @@ "FlowInputField":{ "type":"structure", "required":[ - "content", - "name" + "name", + "content" ], "members":{ - "content":{ - "shape":"FlowExecutionContent", - "documentation":"The content of the input field, which can contain text or structured data.
" - }, "name":{ "shape":"NodeInputName", "documentation":"The name of the input field as defined in the flow's input schema.
" + }, + "content":{ + "shape":"FlowExecutionContent", + "documentation":"The content of the input field, which can contain text or structured data.
" } }, "documentation":"Represents an input field provided to a flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The content payload containing the input request details for the multi-turn interaction.
" - }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node in the flow that is requesting the input.
" @@ -2413,12 +2436,48 @@ "nodeType":{ "shape":"NodeType", "documentation":"The type of the node in the flow that is requesting the input.
" + }, + "content":{ + "shape":"FlowMultiTurnInputContent", + "documentation":"The content payload containing the input request details for the multi-turn interaction.
" } }, "documentation":"Response object from the flow multi-turn node requesting additional information.
", "event":true, "sensitive":true }, + "FlowNodeIODataType":{ + "type":"string", + "enum":[ + "String", + "Number", + "Boolean", + "Object", + "Array" + ] + }, + "FlowNodeInputCategory":{ + "type":"string", + "enum":[ + "LoopCondition", + "ReturnValueToLoopStart", + "ExitLoop" + ] + }, + "FlowNodeInputExpression":{ + "type":"string", + "max":64, + "min":1, + "sensitive":true + }, + "FlowNodeInputName":{ + "type":"string", + "pattern":"[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}" + }, + "FlowNodeOutputName":{ + "type":"string", + "pattern":"[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}" + }, "FlowOutputContent":{ "type":"structure", "members":{ @@ -2433,15 +2492,11 @@ "FlowOutputEvent":{ "type":"structure", "required":[ - "content", "nodeName", - "nodeType" + "nodeType", + "content" ], "members":{ - "content":{ - "shape":"FlowOutputContent", - "documentation":"The content in the output.
" - }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the flow output node that the output is from.
" @@ -2449,6 +2504,10 @@ "nodeType":{ "shape":"NodeType", "documentation":"The type of the node that the output is from.
" + }, + "content":{ + "shape":"FlowOutputContent", + "documentation":"The content in the output.
" } }, "documentation":"Contains information about an output from prompt flow invoction.
", @@ -2458,17 +2517,17 @@ "FlowOutputField":{ "type":"structure", "required":[ - "content", - "name" + "name", + "content" ], "members":{ - "content":{ - "shape":"FlowExecutionContent", - "documentation":"The content of the output field, which can contain text or structured data.
" - }, "name":{ "shape":"NodeOutputName", "documentation":"The name of the output field as defined in the flow's output schema.
" + }, + "content":{ + "shape":"FlowExecutionContent", + "documentation":"The content of the output field, which can contain text or structured data.
" } }, "documentation":"Represents an output field produced by a flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The request is denied because of missing access permissions. Check your permissions and retry your request.
" - }, - "badGatewayException":{ - "shape":"BadGatewayException", - "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" - }, - "conflictException":{ - "shape":"ConflictException", - "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" - }, - "dependencyFailedException":{ - "shape":"DependencyFailedException", - "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" + "flowOutputEvent":{ + "shape":"FlowOutputEvent", + "documentation":"Contains information about an output from flow invocation.
" }, "flowCompletionEvent":{ "shape":"FlowCompletionEvent", "documentation":"Contains information about why the flow completed.
" }, - "flowMultiTurnInputRequestEvent":{ - "shape":"FlowMultiTurnInputRequestEvent", - "documentation":"The event stream containing the multi-turn input request information from the flow.
" - }, - "flowOutputEvent":{ - "shape":"FlowOutputEvent", - "documentation":"Contains information about an output from flow invocation.
" - }, "flowTraceEvent":{ "shape":"FlowTraceEvent", "documentation":"Contains information about a trace, which tracks an input or output for a node in the flow.
" @@ -2519,6 +2558,10 @@ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, + "validationException":{ + "shape":"ValidationException", + "documentation":"Input validation failed. Check your request parameters and retry the request.
" + }, "resourceNotFoundException":{ "shape":"ResourceNotFoundException", "documentation":"The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" @@ -2531,9 +2574,25 @@ "shape":"ThrottlingException", "documentation":"The number of requests exceeds the limit. Resubmit your request later.
" }, - "validationException":{ - "shape":"ValidationException", - "documentation":"Input validation failed. Check your request parameters and retry the request.
" + "accessDeniedException":{ + "shape":"AccessDeniedException", + "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" + }, + "conflictException":{ + "shape":"ConflictException", + "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" + }, + "dependencyFailedException":{ + "shape":"DependencyFailedException", + "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" + }, + "badGatewayException":{ + "shape":"BadGatewayException", + "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" + }, + "flowMultiTurnInputRequestEvent":{ + "shape":"FlowMultiTurnInputRequestEvent", + "documentation":"The event stream containing the multi-turn input request information from the flow.
" } }, "documentation":"The output of the flow.
", @@ -2542,14 +2601,6 @@ "FlowTrace":{ "type":"structure", "members":{ - "conditionNodeResultTrace":{ - "shape":"FlowTraceConditionNodeResultEvent", - "documentation":"Contains information about an output from a condition node.
" - }, - "nodeActionTrace":{ - "shape":"FlowTraceNodeActionEvent", - "documentation":"Contains information about an action (operation) called by a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
" - }, "nodeInputTrace":{ "shape":"FlowTraceNodeInputEvent", "documentation":"Contains information about the input into a node.
" @@ -2557,6 +2608,18 @@ "nodeOutputTrace":{ "shape":"FlowTraceNodeOutputEvent", "documentation":"Contains information about the output from a node.
" + }, + "conditionNodeResultTrace":{ + "shape":"FlowTraceConditionNodeResultEvent", + "documentation":"Contains information about an output from a condition node.
" + }, + "nodeActionTrace":{ + "shape":"FlowTraceNodeActionEvent", + "documentation":"Contains information about an action (operation) called by a node.
" + }, + "nodeDependencyTrace":{ + "shape":"FlowTraceDependencyEvent", + "documentation":"Contains information about an internal trace of a node.
" } }, "documentation":"Contains information about an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", @@ -2579,21 +2642,21 @@ "type":"structure", "required":[ "nodeName", - "satisfiedConditions", - "timestamp" + "timestamp", + "satisfiedConditions" ], "members":{ "nodeName":{ "shape":"NodeName", "documentation":"The name of the condition node.
" }, - "satisfiedConditions":{ - "shape":"FlowTraceConditions", - "documentation":"An array of objects containing information about the conditions that were satisfied.
" - }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the trace was returned.
" + }, + "satisfiedConditions":{ + "shape":"FlowTraceConditions", + "documentation":"An array of objects containing information about the conditions that were satisfied.
" } }, "documentation":"Contains information about an output from a condition node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", @@ -2605,6 +2668,30 @@ "max":5, "min":1 }, + "FlowTraceDependencyEvent":{ + "type":"structure", + "required":[ + "nodeName", + "timestamp", + "traceElements" + ], + "members":{ + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node that generated the dependency trace.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The date and time that the dependency trace was generated.
" + }, + "traceElements":{ + "shape":"TraceElements", + "documentation":"The trace elements containing detailed information about the dependency.
" + } + }, + "documentation":"Contains information about a dependency trace event in the flow.
", + "sensitive":true + }, "FlowTraceEvent":{ "type":"structure", "required":["trace"], @@ -2621,19 +2708,19 @@ "type":"structure", "required":[ "nodeName", - "operationName", + "timestamp", "requestId", "serviceName", - "timestamp" + "operationName" ], "members":{ "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that called the operation.
" }, - "operationName":{ - "shape":"String", - "documentation":"The name of the operation that the node called.
" + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The date and time that the operation was called.
" }, "requestId":{ "shape":"String", @@ -2643,9 +2730,17 @@ "shape":"String", "documentation":"The name of the service that the node called.
" }, - "timestamp":{ - "shape":"DateTimestamp", - "documentation":"The date and time that the operation was called.
" + "operationName":{ + "shape":"String", + "documentation":"The name of the operation that the node called.
" + }, + "operationRequest":{ + "shape":"Document", + "documentation":"The request payload sent to the downstream service.
" + }, + "operationResponse":{ + "shape":"Document", + "documentation":"The response payload received from the downstream service.
" } }, "documentation":"Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes.
", @@ -2666,15 +2761,11 @@ "FlowTraceNodeInputEvent":{ "type":"structure", "required":[ - "fields", "nodeName", - "timestamp" + "timestamp", + "fields" ], "members":{ - "fields":{ - "shape":"FlowTraceNodeInputFields", - "documentation":"An array of objects containing information about each field in the input.
" - }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that received the input.
" @@ -2682,25 +2773,73 @@ "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the trace was returned.
" + }, + "fields":{ + "shape":"FlowTraceNodeInputFields", + "documentation":"An array of objects containing information about each field in the input.
" } }, "documentation":"Contains information about the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true }, + "FlowTraceNodeInputExecutionChain":{ + "type":"list", + "member":{"shape":"FlowTraceNodeInputExecutionChainItem"}, + "sensitive":true + }, + "FlowTraceNodeInputExecutionChainItem":{ + "type":"structure", + "required":[ + "nodeName", + "type" + ], + "members":{ + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node in the execution chain.
" + }, + "index":{ + "shape":"Integer", + "documentation":"The index position of this item in the execution chain.
" + }, + "type":{ + "shape":"FlowControlNodeType", + "documentation":"The type of execution chain item. Supported values are Iterator and Loop.
" + } + }, + "documentation":"Represents an item in the execution chain for flow trace node input tracking.
", + "sensitive":true + }, "FlowTraceNodeInputField":{ "type":"structure", "required":[ - "content", - "nodeInputName" + "nodeInputName", + "content" ], "members":{ + "nodeInputName":{ + "shape":"NodeInputName", + "documentation":"The name of the node input.
" + }, "content":{ "shape":"FlowTraceNodeInputContent", "documentation":"The content of the node input.
" }, - "nodeInputName":{ - "shape":"NodeInputName", - "documentation":"The name of the node input.
" + "source":{ + "shape":"FlowTraceNodeInputSource", + "documentation":"The source node that provides input data to this field.
" + }, + "type":{ + "shape":"FlowNodeIODataType", + "documentation":"The data type of the input field for compatibility validation.
" + }, + "category":{ + "shape":"FlowNodeInputCategory", + "documentation":"The category of the input field.
" + }, + "executionChain":{ + "shape":"FlowTraceNodeInputExecutionChain", + "documentation":"The execution path through nested nodes like iterators and loops.
" } }, "documentation":"Contains information about a field in the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", @@ -2712,6 +2851,30 @@ "max":5, "min":1 }, + "FlowTraceNodeInputSource":{ + "type":"structure", + "required":[ + "nodeName", + "outputFieldName", + "expression" + ], + "members":{ + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the source node that provides the input data.
" + }, + "outputFieldName":{ + "shape":"FlowNodeOutputName", + "documentation":"The name of the output field from the source node.
" + }, + "expression":{ + "shape":"FlowNodeInputExpression", + "documentation":"The expression used to extract data from the source.
" + } + }, + "documentation":"Represents the source of input data for a flow trace node field.
", + "sensitive":true + }, "FlowTraceNodeOutputContent":{ "type":"structure", "members":{ @@ -2726,15 +2889,11 @@ "FlowTraceNodeOutputEvent":{ "type":"structure", "required":[ - "fields", "nodeName", - "timestamp" + "timestamp", + "fields" ], "members":{ - "fields":{ - "shape":"FlowTraceNodeOutputFields", - "documentation":"An array of objects containing information about each field in the output.
" - }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that yielded the output.
" @@ -2742,7 +2901,11 @@ "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the trace was returned.
" - } + }, + "fields":{ + "shape":"FlowTraceNodeOutputFields", + "documentation":"An array of objects containing information about each field in the output.
" + } }, "documentation":"Contains information about the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true @@ -2750,17 +2913,25 @@ "FlowTraceNodeOutputField":{ "type":"structure", "required":[ - "content", - "nodeOutputName" + "nodeOutputName", + "content" ], "members":{ + "nodeOutputName":{ + "shape":"NodeOutputName", + "documentation":"The name of the node output.
" + }, "content":{ "shape":"FlowTraceNodeOutputContent", "documentation":"The content of the node output.
" }, - "nodeOutputName":{ - "shape":"NodeOutputName", - "documentation":"The name of the node output.
" + "next":{ + "shape":"FlowTraceNodeOutputNextList", + "documentation":"The next node that receives output data from this field.
" + }, + "type":{ + "shape":"FlowNodeIODataType", + "documentation":"The data type of the output field for compatibility validation.
" } }, "documentation":"Contains information about a field in the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", @@ -2772,6 +2943,29 @@ "max":2, "min":1 }, + "FlowTraceNodeOutputNext":{ + "type":"structure", + "required":[ + "nodeName", + "inputFieldName" + ], + "members":{ + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the next node that receives the output data.
" + }, + "inputFieldName":{ + "shape":"FlowNodeInputName", + "documentation":"The name of the input field in the next node that receives the data.
" + } + }, + "documentation":"Represents the next node that receives output data from a flow trace.
", + "sensitive":true + }, + "FlowTraceNodeOutputNextList":{ + "type":"list", + "member":{"shape":"FlowTraceNodeOutputNext"} + }, "Function":{ "type":"string", "sensitive":true @@ -2780,14 +2974,14 @@ "type":"structure", "required":["name"], "members":{ - "description":{ - "shape":"FunctionDescription", - "documentation":"A description of the function and its purpose.
" - }, "name":{ "shape":"ResourceName", "documentation":"A name for the function.
" }, + "description":{ + "shape":"FunctionDescription", + "documentation":"A description of the function and its purpose.
" + }, "parameters":{ "shape":"ParameterMap", "documentation":"The parameters that the agent elicits from the user to fulfill the function.
" @@ -2812,6 +3006,14 @@ "shape":"String", "documentation":"The action group that the function belongs to.
" }, + "parameters":{ + "shape":"FunctionParameters", + "documentation":"A list of parameters of the function.
" + }, + "function":{ + "shape":"String", + "documentation":"The name of the function.
" + }, "actionInvocationType":{ "shape":"ActionInvocationType", "documentation":"Contains information about the function to invoke,
" @@ -2823,14 +3025,6 @@ "collaboratorName":{ "shape":"Name", "documentation":"The collaborator's name.
" - }, - "function":{ - "shape":"String", - "documentation":"The name of the function.
" - }, - "parameters":{ - "shape":"FunctionParameters", - "documentation":"A list of parameters of the function.
" } }, "documentation":"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
The action group that the function belongs to.
" }, - "agentId":{ - "shape":"String", - "documentation":"The agent's ID.
" - }, "confirmationState":{ "shape":"ConfirmationState", "documentation":"Contains the user confirmation information about the function that was called.
" @@ -2884,6 +3074,10 @@ "responseState":{ "shape":"ResponseState", "documentation":"Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" + }, + "agentId":{ + "shape":"String", + "documentation":"The agent's ID.
" } }, "documentation":"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
An SQL query that corresponds to the natural language query.
" - }, "type":{ "shape":"GeneratedQueryType", "documentation":"The type of transformed query.
" + }, + "sql":{ + "shape":"String", + "documentation":"An SQL query that corresponds to the natural language query.
" } }, "documentation":"Contains information about a query generated for a natural language query.
", @@ -2966,9 +3160,9 @@ "GenerationConfiguration":{ "type":"structure", "members":{ - "additionalModelRequestFields":{ - "shape":"AdditionalModelRequestFields", - "documentation":"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.
" + "promptTemplate":{ + "shape":"PromptTemplate", + "documentation":"Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$
variable. For more information, see Use placeholder variables in the user guide.
Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
" }, + "additionalModelRequestFields":{ + "shape":"AdditionalModelRequestFields", + "documentation":"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.
" + }, "performanceConfig":{ "shape":"PerformanceConfiguration", "documentation":"The latency configuration for the model.
" - }, - "promptTemplate":{ - "shape":"PromptTemplate", - "documentation":"Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$
variable. For more information, see Use placeholder variables in the user guide.
Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
" @@ -2992,23 +3186,17 @@ "GetAgentMemoryRequest":{ "type":"structure", "required":[ - "agentAliasId", "agentId", - "memoryId", - "memoryType" + "agentAliasId", + "memoryType", + "memoryId" ], "members":{ - "agentAliasId":{ - "shape":"AgentAliasId", - "documentation":"The unique identifier of an alias of an agent.
", - "location":"uri", - "locationName":"agentAliasId" - }, - "agentId":{ - "shape":"AgentId", - "documentation":"The unique identifier of the agent to which the alias belongs.
", - "location":"uri", - "locationName":"agentId" + "nextToken":{ + "shape":"NextToken", + "documentation":"If the total number of results is greater than the maxItems 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.
The unique identifier of the memory.
", - "location":"querystring", - "locationName":"memoryId" + "agentId":{ + "shape":"AgentId", + "documentation":"The unique identifier of the agent to which the alias belongs.
", + "location":"uri", + "locationName":"agentId" + }, + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"The unique identifier of an alias of an agent.
", + "location":"uri", + "locationName":"agentAliasId" }, "memoryType":{ "shape":"MemoryType", @@ -3028,40 +3222,40 @@ "location":"querystring", "locationName":"memoryType" }, - "nextToken":{ - "shape":"NextToken", - "documentation":"If the total number of results is greater than the maxItems 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.
The unique identifier of the memory.
", "location":"querystring", - "locationName":"nextToken" + "locationName":"memoryId" } } }, "GetAgentMemoryResponse":{ "type":"structure", "members":{ - "memoryContents":{ - "shape":"Memories", - "documentation":"Contains details of the sessions stored in the memory
" - }, "nextToken":{ "shape":"NextToken", "documentation":"If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken
field to return the next batch of results.
Contains details of the sessions stored in the memory
" } } }, "GetExecutionFlowSnapshotRequest":{ "type":"structure", "required":[ - "executionIdentifier", + "flowIdentifier", "flowAliasIdentifier", - "flowIdentifier" + "executionIdentifier" ], "members":{ - "executionIdentifier":{ - "shape":"FlowExecutionIdentifier", - "documentation":"The unique identifier of the flow execution.
", + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", "location":"uri", - "locationName":"executionIdentifier" + "locationName":"flowIdentifier" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", @@ -3069,63 +3263,63 @@ "location":"uri", "locationName":"flowAliasIdentifier" }, - "flowIdentifier":{ - "shape":"FlowIdentifier", - "documentation":"The unique identifier of the flow.
", + "executionIdentifier":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The unique identifier of the flow execution.
", "location":"uri", - "locationName":"flowIdentifier" + "locationName":"executionIdentifier" } } }, "GetExecutionFlowSnapshotResponse":{ "type":"structure", "required":[ - "definition", - "executionRoleArn", - "flowAliasIdentifier", "flowIdentifier", - "flowVersion" + "flowAliasIdentifier", + "flowVersion", + "executionRoleArn", + "definition" ], "members":{ - "customerEncryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.
" - }, - "definition":{ - "shape":"String", - "documentation":"The flow definition used for the flow execution, including the nodes, connections, and configuration at the time when the execution started.
The definition returns as a string that follows the structure of a FlowDefinition object.
" - }, - "executionRoleArn":{ - "shape":"FlowExecutionRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution.
" + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias used for the flow execution.
" }, - "flowIdentifier":{ - "shape":"FlowIdentifier", - "documentation":"The unique identifier of the flow.
" - }, "flowVersion":{ "shape":"Version", "documentation":"The version of the flow used for the flow execution.
" + }, + "executionRoleArn":{ + "shape":"FlowExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution.
" + }, + "definition":{ + "shape":"String", + "documentation":"The flow definition used for the flow execution, including the nodes, connections, and configuration at the time when the execution started.
The definition returns as a string that follows the structure of a FlowDefinition object.
" + }, + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.
" } } }, "GetFlowExecutionRequest":{ "type":"structure", "required":[ - "executionIdentifier", + "flowIdentifier", "flowAliasIdentifier", - "flowIdentifier" + "executionIdentifier" ], "members":{ - "executionIdentifier":{ - "shape":"FlowExecutionIdentifier", - "documentation":"The unique identifier of the flow execution to retrieve.
", + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", "location":"uri", - "locationName":"executionIdentifier" + "locationName":"flowIdentifier" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", @@ -3133,11 +3327,11 @@ "location":"uri", "locationName":"flowAliasIdentifier" }, - "flowIdentifier":{ - "shape":"FlowIdentifier", - "documentation":"The unique identifier of the flow.
", + "executionIdentifier":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The unique identifier of the flow execution to retrieve.
", "location":"uri", - "locationName":"flowIdentifier" + "locationName":"executionIdentifier" } } }, @@ -3145,13 +3339,25 @@ "type":"structure", "required":[ "executionArn", + "status", + "startedAt", "flowAliasIdentifier", "flowIdentifier", - "flowVersion", - "startedAt", - "status" + "flowVersion" ], "members":{ + "executionArn":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
" + }, + "status":{ + "shape":"FlowExecutionStatus", + "documentation":"The current status of the flow execution.
Flow executions time out after 24 hours.
" + }, + "startedAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the flow execution started.
" + }, "endedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" @@ -3160,10 +3366,6 @@ "shape":"FlowExecutionErrors", "documentation":"A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.
" }, - "executionArn":{ - "shape":"FlowExecutionIdentifier", - "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
" - }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias used for the execution.
" @@ -3175,14 +3377,6 @@ "flowVersion":{ "shape":"Version", "documentation":"The version of the flow used for the execution.
" - }, - "startedAt":{ - "shape":"DateTimestamp", - "documentation":"The timestamp when the flow execution started.
" - }, - "status":{ - "shape":"FlowExecutionStatus", - "documentation":"The current status of the flow execution.
Flow executions time out after 24 hours.
" } } }, @@ -3237,40 +3431,40 @@ "GetSessionResponse":{ "type":"structure", "required":[ - "createdAt", - "lastUpdatedAt", - "sessionArn", "sessionId", - "sessionStatus" + "sessionArn", + "sessionStatus", + "createdAt", + "lastUpdatedAt" ], "members":{ + "sessionId":{ + "shape":"Uuid", + "documentation":"The unique identifier for the session in UUID format.
" + }, + "sessionArn":{ + "shape":"SessionArn", + "documentation":"The Amazon Resource Name (ARN) of the session.
" + }, + "sessionStatus":{ + "shape":"SessionStatus", + "documentation":"The current status of the session.
" + }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the session was created.
" }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see Amazon Bedrock session encryption.
" - }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the session was last modified.
" }, - "sessionArn":{ - "shape":"SessionArn", - "documentation":"The Amazon Resource Name (ARN) of the session.
" - }, - "sessionId":{ - "shape":"Uuid", - "documentation":"The unique identifier for the session in UUID format.
" - }, "sessionMetadata":{ "shape":"SessionMetadataMap", "documentation":"A map of key-value pairs containing attributes persisted across the session.
" }, - "sessionStatus":{ - "shape":"SessionStatus", - "documentation":"The current status of the session.
" + "encryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see Amazon Bedrock session encryption.
" } } }, @@ -3291,21 +3485,21 @@ "GuardrailAssessment":{ "type":"structure", "members":{ - "contentPolicy":{ - "shape":"GuardrailContentPolicyAssessment", - "documentation":"Content policy details of the Guardrail.
" - }, - "sensitiveInformationPolicy":{ - "shape":"GuardrailSensitiveInformationPolicyAssessment", - "documentation":"Sensitive Information policy details of Guardrail.
" - }, "topicPolicy":{ "shape":"GuardrailTopicPolicyAssessment", "documentation":"Topic policy details of the Guardrail.
" }, + "contentPolicy":{ + "shape":"GuardrailContentPolicyAssessment", + "documentation":"Content policy details of the Guardrail.
" + }, "wordPolicy":{ "shape":"GuardrailWordPolicyAssessment", "documentation":"Word policy details of the Guardrail.
" + }, + "sensitiveInformationPolicy":{ + "shape":"GuardrailSensitiveInformationPolicyAssessment", + "documentation":"Sensitive Information policy details of Guardrail.
" } }, "documentation":"Assessment details of the content analyzed by Guardrails.
", @@ -3337,13 +3531,13 @@ "type":"string", "max":64, "min":0, - "pattern":"^[a-z0-9]+$" + "pattern":"[a-z0-9]+" }, "GuardrailConfigurationGuardrailVersionString":{ "type":"string", "max":5, "min":1, - "pattern":"^(([1-9][0-9]{0,7})|(DRAFT))$" + "pattern":"(([1-9][0-9]{0,7})|(DRAFT))" }, "GuardrailConfigurationWithArn":{ "type":"structure", @@ -3366,17 +3560,17 @@ "GuardrailContentFilter":{ "type":"structure", "members":{ - "action":{ - "shape":"GuardrailContentPolicyAction", - "documentation":"The action placed on the content by the Guardrail filter.
" + "type":{ + "shape":"GuardrailContentFilterType", + "documentation":"The type of content detected in the filter by the Guardrail.
" }, "confidence":{ "shape":"GuardrailContentFilterConfidence", "documentation":"The confidence level regarding the content detected in the filter by the Guardrail.
" }, - "type":{ - "shape":"GuardrailContentFilterType", - "documentation":"The type of content detected in the filter by the Guardrail.
" + "action":{ + "shape":"GuardrailContentPolicyAction", + "documentation":"The action placed on the content by the Guardrail filter.
" } }, "documentation":"Details of the content filter used in the Guardrail.
", @@ -3425,13 +3619,13 @@ "GuardrailCustomWord":{ "type":"structure", "members":{ - "action":{ - "shape":"GuardrailWordPolicyAction", - "documentation":"The action details for the custom word filter in the Guardrail.
" - }, "match":{ "shape":"String", "documentation":"The match details for the custom word filter in the Guardrail.
" + }, + "action":{ + "shape":"GuardrailWordPolicyAction", + "documentation":"The action details for the custom word filter in the Guardrail.
" } }, "documentation":"The custom word details for the filter in the Guardrail.
", @@ -3457,15 +3651,11 @@ "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]+))$" + "pattern":"(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))" }, "GuardrailManagedWord":{ "type":"structure", "members":{ - "action":{ - "shape":"GuardrailWordPolicyAction", - "documentation":"The action details for the managed word filter in the Guardrail.
" - }, "match":{ "shape":"String", "documentation":"The match details for the managed word filter in the Guardrail.
" @@ -3473,6 +3663,10 @@ "type":{ "shape":"GuardrailManagedWordType", "documentation":"The type details for the managed word filter in the Guardrail.
" + }, + "action":{ + "shape":"GuardrailWordPolicyAction", + "documentation":"The action details for the managed word filter in the Guardrail.
" } }, "documentation":"The managed word details for the filter in the Guardrail.
", @@ -3490,17 +3684,17 @@ "GuardrailPiiEntityFilter":{ "type":"structure", "members":{ - "action":{ - "shape":"GuardrailSensitiveInformationPolicyAction", - "documentation":"The action of the Guardrail filter to identify and remove PII.
" + "type":{ + "shape":"GuardrailPiiEntityType", + "documentation":"The type of PII the Guardrail filter has identified and removed.
" }, "match":{ "shape":"String", "documentation":"The match to settings in the Guardrail filter to identify and remove PII.
" }, - "type":{ - "shape":"GuardrailPiiEntityType", - "documentation":"The type of PII the Guardrail filter has identified and removed.
" + "action":{ + "shape":"GuardrailSensitiveInformationPolicyAction", + "documentation":"The action of the Guardrail filter to identify and remove PII.
" } }, "documentation":"The Guardrail filter to identify and remove personally identifiable information (PII).
", @@ -3550,14 +3744,6 @@ "GuardrailRegexFilter":{ "type":"structure", "members":{ - "action":{ - "shape":"GuardrailSensitiveInformationPolicyAction", - "documentation":"The action details for the regex filter used in the Guardrail.
" - }, - "match":{ - "shape":"String", - "documentation":"The match details for the regex filter used in the Guardrail.
" - }, "name":{ "shape":"String", "documentation":"The name details for the regex filter used in the Guardrail.
" @@ -3565,6 +3751,14 @@ "regex":{ "shape":"String", "documentation":"The regex details for the regex filter used in the Guardrail.
" + }, + "match":{ + "shape":"String", + "documentation":"The match details for the regex filter used in the Guardrail.
" + }, + "action":{ + "shape":"GuardrailSensitiveInformationPolicyAction", + "documentation":"The action details for the regex filter used in the Guardrail.
" } }, "documentation":"The details for the regex filter used in the Guardrail.
", @@ -3600,10 +3794,6 @@ "GuardrailTopic":{ "type":"structure", "members":{ - "action":{ - "shape":"GuardrailTopicPolicyAction", - "documentation":"The action details on a specific topic in the Guardrail.
" - }, "name":{ "shape":"String", "documentation":"The name details on a specific topic in the Guardrail.
" @@ -3611,6 +3801,10 @@ "type":{ "shape":"GuardrailTopicType", "documentation":"The type details on a specific topic in the Guardrail.
" + }, + "action":{ + "shape":"GuardrailTopicPolicyAction", + "documentation":"The action details on a specific topic in the Guardrail.
" } }, "documentation":"The details for a specific topic defined in the Guardrail.
", @@ -3647,21 +3841,21 @@ "shape":"GuardrailAction", "documentation":"The trace action details used with the Guardrail.
" }, + "traceId":{ + "shape":"TraceId", + "documentation":"The details of the trace Id used in the Guardrail Trace.
" + }, "inputAssessments":{ "shape":"GuardrailAssessmentList", "documentation":"The details of the input assessments used in the Guardrail Trace.
" }, - "metadata":{ - "shape":"Metadata", - "documentation":"Contains information about the Guardrail output.
" - }, "outputAssessments":{ "shape":"GuardrailAssessmentList", "documentation":"The details of the output assessments used in the Guardrail Trace.
" }, - "traceId":{ - "shape":"TraceId", - "documentation":"The details of the trace Id used in the Guardrail Trace.
" + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the Guardrail output.
" } }, "documentation":"The trace details used in the Guardrail.
", @@ -3671,7 +3865,7 @@ "type":"string", "max":5, "min":1, - "pattern":"^(([1-9][0-9]{0,7})|(DRAFT))$" + "pattern":"(([1-9][0-9]{0,7})|(DRAFT))" }, "GuardrailWordPolicyAction":{ "type":"string", @@ -3821,25 +4015,25 @@ "InferenceConfiguration":{ "type":"structure", "members":{ - "maximumLength":{ - "shape":"MaximumLength", - "documentation":"The maximum number of tokens allowed in the generated response.
" - }, - "stopSequences":{ - "shape":"StopSequences", - "documentation":"A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" - }, "temperature":{ "shape":"Temperature", "documentation":"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.
" }, + "topP":{ + "shape":"TopP", + "documentation":"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 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
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 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
The maximum number of tokens allowed in the generated response.
" + }, + "stopSequences":{ + "shape":"StopSequences", + "documentation":"A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" } }, "documentation":"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.
" @@ -3858,13 +4052,13 @@ "InlineAgentPayloadPart":{ "type":"structure", "members":{ - "attribution":{ - "shape":"Attribution", - "documentation":"Contains citations for a part of an agent response.
" - }, "bytes":{ "shape":"PartBody", "documentation":"A part of the agent response in bytes.
" + }, + "attribution":{ + "shape":"Attribution", + "documentation":"Contains citations for a part of an agent response.
" } }, "documentation":"Contains a part of an agent response and citations for it.
", @@ -3874,42 +4068,30 @@ "InlineAgentResponseStream":{ "type":"structure", "members":{ - "accessDeniedException":{ - "shape":"AccessDeniedException", - "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" - }, - "badGatewayException":{ - "shape":"BadGatewayException", - "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" - }, "chunk":{ "shape":"InlineAgentPayloadPart", "documentation":"Contains a part of an agent response and citations for it.
" }, - "conflictException":{ - "shape":"ConflictException", - "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" - }, - "dependencyFailedException":{ - "shape":"DependencyFailedException", - "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" + "trace":{ + "shape":"InlineAgentTracePart", + "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" }, - "files":{ - "shape":"InlineAgentFilePart", - "documentation":"Contains intermediate response for code interpreter if any files have been generated.
" + "returnControl":{ + "shape":"InlineAgentReturnControlPayload", + "documentation":"Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" }, "internalServerException":{ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, + "validationException":{ + "shape":"ValidationException", + "documentation":"Input validation failed. Check your request parameters and retry the request.
" + }, "resourceNotFoundException":{ "shape":"ResourceNotFoundException", "documentation":"The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" }, - "returnControl":{ - "shape":"InlineAgentReturnControlPayload", - "documentation":"Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" - }, "serviceQuotaExceededException":{ "shape":"ServiceQuotaExceededException", "documentation":"The number of requests exceeds the service quota. Resubmit your request later.
" @@ -3918,13 +4100,25 @@ "shape":"ThrottlingException", "documentation":"The number of requests exceeds the limit. Resubmit your request later.
" }, - "trace":{ - "shape":"InlineAgentTracePart", - "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" + "accessDeniedException":{ + "shape":"AccessDeniedException", + "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" }, - "validationException":{ - "shape":"ValidationException", - "documentation":"Input validation failed. Check your request parameters and retry the request.
" + "conflictException":{ + "shape":"ConflictException", + "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" + }, + "dependencyFailedException":{ + "shape":"DependencyFailedException", + "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" + }, + "badGatewayException":{ + "shape":"BadGatewayException", + "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" + }, + "files":{ + "shape":"InlineAgentFilePart", + "documentation":"Contains intermediate response for code interpreter if any files have been generated.
" } }, "documentation":"The response from invoking the agent and associated citations and trace information.
", @@ -3933,13 +4127,13 @@ "InlineAgentReturnControlPayload":{ "type":"structure", "members":{ - "invocationId":{ - "shape":"String", - "documentation":"The identifier of the action group invocation.
" - }, "invocationInputs":{ "shape":"InvocationInputs", "documentation":"A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
" + }, + "invocationId":{ + "shape":"String", + "documentation":"The identifier of the action group invocation.
" } }, "documentation":"Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the InvokeAgent response API operation.
", @@ -3949,25 +4143,25 @@ "InlineAgentTracePart":{ "type":"structure", "members":{ + "sessionId":{ + "shape":"SessionId", + "documentation":"The unique identifier of the session with the agent.
" + }, + "trace":{ + "shape":"Trace", + "documentation":"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.
" + }, "callerChain":{ "shape":"CallerChain", "documentation":"The caller chain for the trace part.
" }, - "collaboratorName":{ - "shape":"Name", - "documentation":"The collaborator name for the trace part.
" - }, "eventTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time that trace occurred.
" }, - "sessionId":{ - "shape":"SessionId", - "documentation":"The unique identifier of the session with the agent.
" - }, - "trace":{ - "shape":"Trace", - "documentation":"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.
" + "collaboratorName":{ + "shape":"Name", + "documentation":"The collaborator name for the trace part.
" } }, "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", @@ -3987,17 +4181,9 @@ "InlineSessionState":{ "type":"structure", "members":{ - "conversationHistory":{ - "shape":"ConversationHistory", - "documentation":"Contains the conversation history that persist across sessions.
" - }, - "files":{ - "shape":"InputFiles", - "documentation":"Contains information about the files used by code interpreter.
" - }, - "invocationId":{ - "shape":"String", - "documentation":" The identifier of the invocation of an action. This value must match the invocationId
returned in the InvokeInlineAgent
response for the action whose results are provided in the returnControlInvocationResults
field. For more information, see Return control to the agent developer.
Contains attributes that persist across a session and the values of those attributes.
" }, "promptSessionAttributes":{ "shape":"PromptSessionAttributesMap", @@ -4007,9 +4193,17 @@ "shape":"ReturnControlInvocationResults", "documentation":"Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.
If you include this field in the sessionState
field, the inputText
field will be ignored.
Contains attributes that persist across a session and the values of those attributes.
" + "invocationId":{ + "shape":"String", + "documentation":" The identifier of the invocation of an action. This value must match the invocationId
returned in the InvokeInlineAgent
response for the action whose results are provided in the returnControlInvocationResults
field. For more information, see Return control to the agent developer.
Contains information about the files used by code interpreter.
" + }, + "conversationHistory":{ + "shape":"ConversationHistory", + "documentation":"Contains the conversation history that persist across sessions.
" } }, "documentation":" 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 InvokeInlineAgent
request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context
Contains information about the action group to be invoked.
" - }, - "agentCollaboratorInvocationInput":{ - "shape":"AgentCollaboratorInvocationInput", - "documentation":"The collaborator's invocation input.
" - }, - "codeInterpreterInvocationInput":{ - "shape":"CodeInterpreterInvocationInput", - "documentation":"Contains information about the code interpreter to be invoked.
" + "traceId":{ + "shape":"TraceId", + "documentation":"The unique identifier of the trace.
" }, "invocationType":{ "shape":"InvocationType", "documentation":"Specifies whether the agent is invoking an action group or a knowledge base.
" }, + "actionGroupInvocationInput":{ + "shape":"ActionGroupInvocationInput", + "documentation":"Contains information about the action group to be invoked.
" + }, "knowledgeBaseLookupInput":{ "shape":"KnowledgeBaseLookupInput", "documentation":"Contains details about the knowledge base to look up and the query to be made.
" }, - "traceId":{ - "shape":"TraceId", - "documentation":"The unique identifier of the trace.
" + "codeInterpreterInvocationInput":{ + "shape":"CodeInterpreterInvocationInput", + "documentation":"Contains information about the code interpreter to be invoked.
" + }, + "agentCollaboratorInvocationInput":{ + "shape":"AgentCollaboratorInvocationInput", + "documentation":"The collaborator's invocation input.
" } }, "documentation":"Contains information pertaining to the action group or knowledge base that is being invoked.
", @@ -4164,13 +4358,17 @@ "InvocationStep":{ "type":"structure", "required":[ + "sessionId", "invocationId", "invocationStepId", "invocationStepTime", - "payload", - "sessionId" + "payload" ], "members":{ + "sessionId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the session containing the invocation step.
" + }, "invocationId":{ "shape":"Uuid", "documentation":"The unique identifier (in UUID format) for the invocation that includes the invocation step.
" @@ -4186,10 +4384,6 @@ "payload":{ "shape":"InvocationStepPayload", "documentation":"Payload content, such as text and images, for the invocation step.
" - }, - "sessionId":{ - "shape":"Uuid", - "documentation":"The unique identifier of the session containing the invocation step.
" } }, "documentation":"Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" @@ -4212,12 +4406,16 @@ "InvocationStepSummary":{ "type":"structure", "required":[ + "sessionId", "invocationId", "invocationStepId", - "invocationStepTime", - "sessionId" + "invocationStepTime" ], "members":{ + "sessionId":{ + "shape":"Uuid", + "documentation":"The unique identifier for the session associated with the invocation step.
" + }, "invocationId":{ "shape":"Uuid", "documentation":"A unique identifier for the invocation in UUID format.
" @@ -4229,10 +4427,6 @@ "invocationStepTime":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the invocation step was created.
" - }, - "sessionId":{ - "shape":"Uuid", - "documentation":"The unique identifier for the session associated with the invocation step.
" } }, "documentation":"Contains details about an invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" @@ -4244,22 +4438,22 @@ "InvocationSummary":{ "type":"structure", "required":[ - "createdAt", + "sessionId", "invocationId", - "sessionId" + "createdAt" ], "members":{ - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"The timestamp for when the invocation was created.
" + "sessionId":{ + "shape":"Uuid", + "documentation":"The unique identifier for the session associated with the invocation.
" }, "invocationId":{ "shape":"Uuid", "documentation":"A unique identifier for the invocation in UUID format.
" }, - "sessionId":{ - "shape":"Uuid", - "documentation":"The unique identifier for the session associated with the invocation.
" + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp for when the invocation was created.
" } }, "documentation":"Contains details about an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" @@ -4277,16 +4471,14 @@ "InvokeAgentRequest":{ "type":"structure", "required":[ - "agentAliasId", "agentId", + "agentAliasId", "sessionId" ], "members":{ - "agentAliasId":{ - "shape":"AgentAliasId", - "documentation":"The alias of the agent to use.
", - "location":"uri", - "locationName":"agentAliasId" + "sessionState":{ + "shape":"SessionState", + "documentation":"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.
Model performance settings for the request.
" + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"The alias of the agent to use.
", + "location":"uri", + "locationName":"agentAliasId" }, - "enableTrace":{ - "shape":"Boolean", - "documentation":"Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
" + "sessionId":{ + "shape":"SessionId", + "documentation":"The unique identifier of the session. Use the same value across requests to continue the same conversation.
", + "location":"uri", + "locationName":"sessionId" }, "endSession":{ "shape":"Boolean", "documentation":"Specifies whether to end the session with the agent or not.
" }, + "enableTrace":{ + "shape":"Boolean", + "documentation":"Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
" + }, "inputText":{ "shape":"InputText", "documentation":"The prompt text to send the agent.
If you include returnControlInvocationResults
in the sessionState
field, the inputText
field will be ignored.
The unique identifier of the agent memory.
" }, + "bedrockModelConfigurations":{ + "shape":"BedrockModelConfigurations", + "documentation":"Model performance settings for the request.
" + }, + "streamingConfigurations":{ + "shape":"StreamingConfigurations", + "documentation":"Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream
action.
Specifies parameters that control how the service populates the agent prompt for an InvokeAgent
request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
The unique identifier of the session. Use the same value across requests to continue the same conversation.
", - "location":"uri", - "locationName":"sessionId" - }, - "sessionState":{ - "shape":"SessionState", - "documentation":"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.
The ARN of the resource making the request.
", "location":"header", "locationName":"x-amz-source-arn" - }, - "streamingConfigurations":{ - "shape":"StreamingConfigurations", - "documentation":"Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream
action.
The unique identifier of the agent memory.
", - "location":"header", - "locationName":"x-amz-bedrock-agent-memory-id" - }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session with the agent.
", "location":"header", "locationName":"x-amz-bedrock-agent-session-id" + }, + "memoryId":{ + "shape":"MemoryId", + "documentation":"The unique identifier of the agent memory.
", + "location":"header", + "locationName":"x-amz-bedrock-agent-memory-id" } }, "payload":"completion" @@ -4376,18 +4570,16 @@ "InvokeFlowRequest":{ "type":"structure", "required":[ - "flowAliasIdentifier", "flowIdentifier", + "flowAliasIdentifier", "inputs" ], "members":{ - "enableTrace":{ - "shape":"Boolean", - "documentation":"Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
" - }, - "executionId":{ - "shape":"FlowExecutionId", - "documentation":"The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
" + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", @@ -4395,19 +4587,21 @@ "location":"uri", "locationName":"flowAliasIdentifier" }, - "flowIdentifier":{ - "shape":"FlowIdentifier", - "documentation":"The unique identifier of the flow.
", - "location":"uri", - "locationName":"flowIdentifier" - }, "inputs":{ "shape":"FlowInputs", "documentation":"A list of objects, each containing information about an input into the flow.
" }, + "enableTrace":{ + "shape":"Boolean", + "documentation":"Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
" + }, "modelPerformanceConfiguration":{ "shape":"ModelPerformanceConfiguration", "documentation":"Model performance settings for the request.
" + }, + "executionId":{ + "shape":"FlowExecutionId", + "documentation":"The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
" } } }, @@ -4415,15 +4609,15 @@ "type":"structure", "required":["responseStream"], "members":{ + "responseStream":{ + "shape":"FlowResponseStream", + "documentation":"The output of the flow, returned as a stream. If there's an error, the error is returned.
" + }, "executionId":{ "shape":"FlowExecutionId", "documentation":"The unique identifier for the current flow execution.
", "location":"header", "locationName":"x-amz-bedrock-flow-execution-id" - }, - "responseStream":{ - "shape":"FlowResponseStream", - "documentation":"The output of the flow, returned as a stream. If there's an error, the error is returned.
" } }, "payload":"responseStream" @@ -4436,95 +4630,95 @@ "sessionId" ], "members":{ - "actionGroups":{ - "shape":"AgentActionGroups", - "documentation":"A list of action groups with each action group defining the action the inline agent needs to carry out.
" - }, - "agentCollaboration":{ - "shape":"AgentCollaboration", - "documentation":"Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
" - }, - "agentName":{ - "shape":"Name", - "documentation":"The name for the agent.
" - }, - "bedrockModelConfigurations":{ - "shape":"InlineBedrockModelConfigurations", - "documentation":"Model settings for the request.
" - }, - "collaboratorConfigurations":{ - "shape":"CollaboratorConfigurations", - "documentation":"Settings for an inline agent collaborator called with InvokeInlineAgent.
" - }, - "collaborators":{ - "shape":"Collaborators", - "documentation":"List of collaborator inline agents.
" - }, - "customOrchestration":{ - "shape":"CustomOrchestration", - "documentation":"Contains details of the custom orchestration configured for the agent.
" - }, "customerEncryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
" }, - "enableTrace":{ - "shape":"Boolean", - "documentation":"Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
" - }, - "endSession":{ - "shape":"Boolean", - "documentation":"Specifies whether to end the session with the inline agent or not.
" - }, "foundationModel":{ "shape":"ModelIdentifier", "documentation":" The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0
.
The guardrails to assign to the inline agent.
" + "instruction":{ + "shape":"Instruction", + "documentation":"The instructions that tell the inline agent what it should do and how it should interact with users.
" }, "idleSessionTTLInSeconds":{ "shape":"SessionTTL", "documentation":" The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent
request begins a new session.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.
" }, - "inlineSessionState":{ - "shape":"InlineSessionState", - "documentation":"Parameters that specify the various attributes of a sessions. 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. For more information, see Control session context.
If you include returnControlInvocationResults
in the sessionState
field, the inputText
field will be ignored.
The prompt text to send to the agent.
If you include returnControlInvocationResults
in the sessionState
field, the inputText
field will be ignored.
The instructions that tell the inline agent what it should do and how it should interact with users.
" + "actionGroups":{ + "shape":"AgentActionGroups", + "documentation":"A list of action groups with each action group defining the action the inline agent needs to carry out.
" }, "knowledgeBases":{ "shape":"KnowledgeBases", "documentation":"Contains information of the knowledge bases to associate with.
" }, - "orchestrationType":{ - "shape":"OrchestrationType", - "documentation":"Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
" - }, - "promptCreationConfigurations":{ - "shape":"PromptCreationConfigurations", - "documentation":"Specifies parameters that control how the service populates the agent prompt for an InvokeInlineAgent
request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
The guardrails to assign to the inline agent.
" }, "promptOverrideConfiguration":{ "shape":"PromptOverrideConfiguration", "documentation":"Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
" }, + "agentCollaboration":{ + "shape":"AgentCollaboration", + "documentation":"Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
" + }, + "collaboratorConfigurations":{ + "shape":"CollaboratorConfigurations", + "documentation":"Settings for an inline agent collaborator called with InvokeInlineAgent.
" + }, + "agentName":{ + "shape":"Name", + "documentation":"The name for the agent.
" + }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session. Use the same value across requests to continue the same conversation.
", "location":"uri", "locationName":"sessionId" }, + "endSession":{ + "shape":"Boolean", + "documentation":"Specifies whether to end the session with the inline agent or not.
" + }, + "enableTrace":{ + "shape":"Boolean", + "documentation":"Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
" + }, + "inputText":{ + "shape":"InputText", + "documentation":"The prompt text to send to the agent.
If you include returnControlInvocationResults
in the sessionState
field, the inputText
field will be ignored.
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream
action.
Specifies parameters that control how the service populates the agent prompt for an InvokeInlineAgent
request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Parameters that specify the various attributes of a sessions. 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. For more information, see Control session context.
If you include returnControlInvocationResults
in the sessionState
field, the inputText
field will be ignored.
List of collaborator inline agents.
" + }, + "bedrockModelConfigurations":{ + "shape":"InlineBedrockModelConfigurations", + "documentation":"Model settings for the request.
" + }, + "orchestrationType":{ + "shape":"OrchestrationType", + "documentation":"Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
" + }, + "customOrchestration":{ + "shape":"CustomOrchestration", + "documentation":"Contains details of the custom orchestration configured for the agent.
" } } }, @@ -4559,23 +4753,23 @@ "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}$" + "pattern":"arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}" }, "KnowledgeBase":{ "type":"structure", "required":[ - "description", - "knowledgeBaseId" + "knowledgeBaseId", + "description" ], "members":{ - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the knowledge base associated with the inline agent.
" - }, "knowledgeBaseId":{ "shape":"KnowledgeBaseId", "documentation":"The unique identifier for a knowledge base associated with the inline agent.
" }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the knowledge base associated with the inline agent.
" + }, "retrievalConfiguration":{ "shape":"KnowledgeBaseRetrievalConfiguration", "documentation":"The configurations to apply to the knowledge base during query. For more information, see Query configurations.
" @@ -4587,7 +4781,7 @@ "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]+$" + "pattern":"arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+" }, "KnowledgeBaseConfiguration":{ "type":"structure", @@ -4616,18 +4810,18 @@ "type":"string", "max":10, "min":0, - "pattern":"^[0-9a-zA-Z]+$" + "pattern":"[0-9a-zA-Z]+" }, "KnowledgeBaseLookupInput":{ "type":"structure", "members":{ - "knowledgeBaseId":{ - "shape":"TraceKnowledgeBaseId", - "documentation":"The unique identifier of the knowledge base to look up.
" - }, "text":{ "shape":"KnowledgeBaseLookupInputString", "documentation":"The query made to the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"TraceKnowledgeBaseId", + "documentation":"The unique identifier of the knowledge base to look up.
" } }, "documentation":"Contains details about the knowledge base to look up and the query to be made.
" @@ -4639,13 +4833,13 @@ "KnowledgeBaseLookupOutput":{ "type":"structure", "members":{ - "metadata":{ - "shape":"Metadata", - "documentation":"Contains information about the knowledge base output.
" - }, "retrievedReferences":{ "shape":"RetrievedReferences", "documentation":"Contains metadata about the sources cited for the generated response.
" + }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the knowledge base output.
" } }, "documentation":"Contains details about the results from looking up the knowledge base.
" @@ -4690,13 +4884,13 @@ "shape":"RetrievalResultLocation", "documentation":"Contains information about the location of the data source.
" }, - "metadata":{ - "shape":"RetrievalResultMetadata", - "documentation":"Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" - }, "score":{ "shape":"Double", "documentation":"The level of relevance of the result to the query.
" + }, + "metadata":{ + "shape":"RetrievalResultMetadata", + "documentation":"Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" } }, "documentation":"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
Contains configurations for response generation based on the knowledge base query results.
" - }, "knowledgeBaseId":{ "shape":"KnowledgeBaseId", "documentation":"The unique identifier of the knowledge base that is queried.
" @@ -4725,13 +4915,17 @@ "shape":"BedrockModelArn", "documentation":"The ARN of the foundation model or inference profile used to generate a response.
" }, - "orchestrationConfiguration":{ - "shape":"OrchestrationConfiguration", - "documentation":"Settings for how the model processes the prompt prior to retrieval and generation.
" - }, "retrievalConfiguration":{ "shape":"KnowledgeBaseRetrievalConfiguration", "documentation":"Contains configurations for how to retrieve and return the knowledge base query.
" + }, + "generationConfiguration":{ + "shape":"GenerationConfiguration", + "documentation":"Contains configurations for response generation based on the knowledge base query results.
" + }, + "orchestrationConfiguration":{ + "shape":"OrchestrationConfiguration", + "documentation":"Settings for how the model processes the prompt prior to retrieval and generation.
" } }, "documentation":"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
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
" - }, - "implicitFilterConfiguration":{ - "shape":"ImplicitFilterConfiguration", - "documentation":"Settings for implicit filtering.
" - }, "numberOfResults":{ "shape":"KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger", "documentation":"The number of source chunks to retrieve.
", @@ -4756,9 +4942,17 @@ "shape":"SearchType", "documentation":"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.
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
" + }, "rerankingConfiguration":{ "shape":"VectorSearchRerankingConfiguration", "documentation":"Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.
" + }, + "implicitFilterConfiguration":{ + "shape":"ImplicitFilterConfiguration", + "documentation":"Settings for implicit filtering.
" } }, "documentation":"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
The type of events to retrieve. Specify Node
for node-level events or Flow
for flow-level events.
The unique identifier of the flow execution.
", + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", "location":"uri", - "locationName":"executionIdentifier" + "locationName":"flowIdentifier" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", @@ -4807,11 +4995,11 @@ "location":"uri", "locationName":"flowAliasIdentifier" }, - "flowIdentifier":{ - "shape":"FlowIdentifier", - "documentation":"The unique identifier of the flow.
", + "executionIdentifier":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The unique identifier of the flow execution.
", "location":"uri", - "locationName":"flowIdentifier" + "locationName":"executionIdentifier" }, "maxResults":{ "shape":"MaxResults", @@ -4824,6 +5012,12 @@ "documentation":"A token to retrieve the next set of results. This value is returned in the response if more results are available.
", "location":"querystring", "locationName":"nextToken" + }, + "eventType":{ + "shape":"FlowExecutionEventType", + "documentation":"The type of events to retrieve. Specify Node
for node-level events or Flow
for flow-level events.
The unique identifier of the flow alias to list executions for.
", - "location":"querystring", - "locationName":"flowAliasIdentifier" - }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow to list executions for.
", "location":"uri", "locationName":"flowIdentifier" }, + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias to list executions for.
", + "location":"querystring", + "locationName":"flowAliasIdentifier" + }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of flow executions to return in a single response. If more executions exist than the specified maxResults
value, a token is included in the response so that the remaining results can be retrieved.
The unique identifier (in UUID format) for the invocation to list invocation steps for.
" }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"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.
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.
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 unique identifier for the session associated with the invocation steps. You can specify either the session's sessionId
or its Amazon Resource Name (ARN).
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.
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.
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 unique identifier for the session to list invocations for. You can specify either the session's sessionId
or its Amazon Resource Name (ARN).
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 list of summaries for each session in your Amazon Web Services account.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
The unique identifier of the memory where the session summary is stored.
" }, - "sessionExpiryTime":{ - "shape":"DateTimestamp", - "documentation":"The time when the memory duration for the session is set to end.
" - }, "sessionId":{ "shape":"SessionId", "documentation":"The identifier for this session.
" @@ -5080,6 +5270,10 @@ "shape":"DateTimestamp", "documentation":"The start time for this session.
" }, + "sessionExpiryTime":{ + "shape":"DateTimestamp", + "documentation":"The time when the memory duration for the session is set to end.
" + }, "summaryText":{ "shape":"SummaryText", "documentation":"The summarized text for this session.
" @@ -5094,17 +5288,17 @@ "Message":{ "type":"structure", "required":[ - "content", - "role" + "role", + "content" ], "members":{ - "content":{ - "shape":"ContentBlocks", - "documentation":"The message's content.
" - }, "role":{ "shape":"ConversationRole", "documentation":"The message's role.
" + }, + "content":{ + "shape":"ContentBlocks", + "documentation":"The message's content.
" } }, "documentation":"Details about a message.
" @@ -5116,25 +5310,25 @@ "Metadata":{ "type":"structure", "members":{ - "clientRequestId":{ - "shape":"String", - "documentation":"A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.
" + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"In the final response, startTime
is the start time of the agent invocation operation.
In the final response, endTime
is the end time of the agent invocation operation.
The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.
" + }, "operationTotalTimeMs":{ "shape":"Long", "documentation":"The total time it took for the agent to complete execution. This field is only set for the final response.
" }, - "startTime":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"In the final response, startTime
is the start time of the agent invocation operation.
The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.
" + "clientRequestId":{ + "shape":"String", + "documentation":"A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.
" }, "usage":{ "shape":"Usage", @@ -5147,15 +5341,11 @@ "MetadataAttributeSchema":{ "type":"structure", "required":[ - "description", "key", - "type" + "type", + "description" ], "members":{ - "description":{ - "shape":"MetadataAttributeSchemaDescriptionString", - "documentation":"The attribute's description.
" - }, "key":{ "shape":"MetadataAttributeSchemaKeyString", "documentation":"The attribute's key.
" @@ -5163,6 +5353,10 @@ "type":{ "shape":"AttributeType", "documentation":"The attribute's type.
" + }, + "description":{ + "shape":"MetadataAttributeSchemaDescriptionString", + "documentation":"The attribute's description.
" } }, "documentation":"Details about a metadata attribute.
", @@ -5172,13 +5366,13 @@ "type":"string", "max":1024, "min":1, - "pattern":"^[\\s\\S]+$" + "pattern":"[\\s\\S]+" }, "MetadataAttributeSchemaKeyString":{ "type":"string", "max":256, "min":1, - "pattern":"^[\\s\\S]+$" + "pattern":"[\\s\\S]+" }, "MetadataAttributeSchemaList":{ "type":"list", @@ -5206,42 +5400,42 @@ "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][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)$" + "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][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)" }, "ModelInvocationInput":{ "type":"structure", "members":{ - "foundationModel":{ - "shape":"ModelIdentifier", - "documentation":"The identifier of a foundation model.
" + "traceId":{ + "shape":"TraceId", + "documentation":"The unique identifier of the trace.
" }, - "inferenceConfiguration":{ - "shape":"InferenceConfiguration", - "documentation":"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.
" + "text":{ + "shape":"PromptText", + "documentation":"The text that prompted the agent at this step.
" + }, + "type":{ + "shape":"PromptType", + "documentation":"The step in the agent sequence.
" }, "overrideLambda":{ "shape":"LambdaArn", "documentation":"The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
" }, - "parserMode":{ - "shape":"CreationMode", - "documentation":"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.
The text that prompted the agent at this step.
" + "inferenceConfiguration":{ + "shape":"InferenceConfiguration", + "documentation":"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.
" }, - "traceId":{ - "shape":"TraceId", - "documentation":"The unique identifier of the trace.
" + "parserMode":{ + "shape":"CreationMode", + "documentation":"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
.
The step in the agent sequence.
" + "foundationModel":{ + "shape":"ModelIdentifier", + "documentation":"The identifier of a foundation model.
" } }, "documentation":"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 name of the node that called the operation.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The date and time that the operation was called.
" + }, + "requestId":{ + "shape":"String", + "documentation":"The ID of the request that the node made to the operation.
" + }, + "serviceName":{ + "shape":"String", + "documentation":"The name of the service that the node called.
" + }, + "operationName":{ + "shape":"String", + "documentation":"The name of the operation that the node called.
" + }, + "operationRequest":{ + "shape":"Document", + "documentation":"The request payload sent to the downstream service.
" + }, + "operationResponse":{ + "shape":"Document", + "documentation":"The response payload received from the downstream service.
" + } + }, + "documentation":"Contains information about an action (operation) called by a node during execution.
", + "sensitive":true + }, + "NodeDependencyEvent":{ + "type":"structure", + "required":[ + "nodeName", + "timestamp", + "traceElements" + ], + "members":{ + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node that generated the dependency trace.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The date and time that the dependency trace was generated.
" + }, + "traceElements":{ + "shape":"NodeTraceElements", + "documentation":"The trace elements containing detailed information about the node execution.
" + } + }, + "documentation":"Contains information about an internal trace of a specific node during execution.
", + "sensitive":true }, "NodeErrorCode":{ "type":"string", @@ -5304,12 +5564,20 @@ "NodeFailureEvent":{ "type":"structure", "required":[ - "errorCode", - "errorMessage", "nodeName", - "timestamp" + "timestamp", + "errorCode", + "errorMessage" ], "members":{ + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node where the failure occurred.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the node failure occurred.
" + }, "errorCode":{ "shape":"NodeErrorCode", "documentation":"The error code that identifies the type of failure that occurred at the node.
" @@ -5317,57 +5585,91 @@ "errorMessage":{ "shape":"String", "documentation":"A descriptive message that provides details about the node failure.
" - }, + } + }, + "documentation":"Contains information about a failure that occurred at a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node where the failure occurred.
" + "documentation":"The name of the node that received the inputs.
" }, "timestamp":{ "shape":"DateTimestamp", - "documentation":"The timestamp when the node failure occurred.
" + "documentation":"The timestamp when the inputs were provided to the node.
" + }, + "fields":{ + "shape":"NodeInputFields", + "documentation":"A list of input fields provided to the node.
" } }, - "documentation":"Contains information about a failure that occurred at a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about the inputs provided to a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
A list of input fields provided to the node.
" - }, "nodeName":{ "shape":"NodeName", - "documentation":"The name of the node that received the inputs.
" + "documentation":"The name of the node in the execution chain.
" }, - "timestamp":{ - "shape":"DateTimestamp", - "documentation":"The timestamp when the inputs were provided to the node.
" + "index":{ + "shape":"Integer", + "documentation":"The index position of this item in the execution chain.
" + }, + "type":{ + "shape":"FlowControlNodeType", + "documentation":"The type of execution chain item. Supported values are Iterator and Loop.
" } }, - "documentation":"Contains information about the inputs provided to a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Represents an item in the execution chain for node input tracking.
" }, "NodeInputField":{ "type":"structure", "required":[ - "content", - "name" + "name", + "content" ], "members":{ + "name":{ + "shape":"NodeInputName", + "documentation":"The name of the input field as defined in the node's input schema.
" + }, "content":{ "shape":"NodeExecutionContent", "documentation":"The content of the input field, which can contain text or structured data.
" }, - "name":{ - "shape":"NodeInputName", - "documentation":"The name of the input field as defined in the node's input schema.
" + "source":{ + "shape":"NodeInputSource", + "documentation":"The source node that provides input data to this field.
" + }, + "type":{ + "shape":"FlowNodeIODataType", + "documentation":"The data type of the input field for compatibility validation.
" + }, + "category":{ + "shape":"FlowNodeInputCategory", + "documentation":"The category of the input field.
" + }, + "executionChain":{ + "shape":"NodeInputExecutionChain", + "documentation":"The execution path through nested nodes like iterators and loops.
" } }, "documentation":"Represents an input field provided to a node during a flow execution.
", @@ -5381,24 +5683,43 @@ }, "NodeInputName":{ "type":"string", - "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + "pattern":"[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}" + }, + "NodeInputSource":{ + "type":"structure", + "required":[ + "nodeName", + "outputFieldName", + "expression" + ], + "members":{ + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the source node that provides the input data.
" + }, + "outputFieldName":{ + "shape":"FlowNodeOutputName", + "documentation":"The name of the output field from the source node.
" + }, + "expression":{ + "shape":"FlowNodeInputExpression", + "documentation":"The expression used to extract data from the source.
" + } + }, + "documentation":"Represents the source of input data for a node field.
" }, "NodeName":{ "type":"string", - "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + "pattern":"[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}" }, "NodeOutputEvent":{ "type":"structure", "required":[ - "fields", "nodeName", - "timestamp" + "timestamp", + "fields" ], "members":{ - "fields":{ - "shape":"NodeOutputFields", - "documentation":"A list of output fields produced by the node.
" - }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that produced the outputs.
" @@ -5406,6 +5727,10 @@ "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the outputs were produced by the node.
" + }, + "fields":{ + "shape":"NodeOutputFields", + "documentation":"A list of output fields produced by the node.
" } }, "documentation":"Contains information about the outputs produced by a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the output field as defined in the node's output schema.
" + }, "content":{ "shape":"NodeExecutionContent", "documentation":"The content of the output field, which can contain text or structured data.
" }, - "name":{ - "shape":"NodeOutputName", - "documentation":"The name of the output field as defined in the node's output schema.
" + "next":{ + "shape":"NodeOutputNextList", + "documentation":"The next node that receives output data from this field.
" + }, + "type":{ + "shape":"FlowNodeIODataType", + "documentation":"The data type of the output field for compatibility validation.
" } }, "documentation":"Represents an output field produced by a node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the next node that receives the output data.
" + }, + "inputFieldName":{ + "shape":"FlowNodeInputName", + "documentation":"The name of the input field in the next node that receives the data.
" + } + }, + "documentation":"Represents the next node that receives output data.
", + "sensitive":true + }, + "NodeOutputNextList":{ + "type":"list", + "member":{"shape":"NodeOutputNext"} + }, + "NodeTraceElements":{ + "type":"structure", + "members":{ + "agentTraces":{ + "shape":"AgentTraces", + "documentation":"Agent trace information for the node execution.
" + } + }, + "documentation":"Contains trace elements for node execution tracking.
", + "sensitive":true, + "union":true }, "NodeType":{ "type":"string", @@ -5454,11 +5822,19 @@ }, "NonBlankString":{ "type":"string", - "pattern":"^[\\s\\S]*$" + "pattern":"[\\s\\S]*" }, "Observation":{ "type":"structure", "members":{ + "traceId":{ + "shape":"TraceId", + "documentation":"The unique identifier of the trace.
" + }, + "type":{ + "shape":"Type", + "documentation":"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.
Contains the JSON-formatted string returned by the API invoked by the action group.
" @@ -5467,29 +5843,21 @@ "shape":"AgentCollaboratorInvocationOutput", "documentation":"A collaborator's invocation output.
" }, - "codeInterpreterInvocationOutput":{ - "shape":"CodeInterpreterInvocationOutput", - "documentation":"Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" + "knowledgeBaseLookupOutput":{ + "shape":"KnowledgeBaseLookupOutput", + "documentation":"Contains details about the results from looking up the knowledge base.
" }, "finalResponse":{ "shape":"FinalResponse", "documentation":"Contains details about the response to the user.
" }, - "knowledgeBaseLookupOutput":{ - "shape":"KnowledgeBaseLookupOutput", - "documentation":"Contains details about the results from looking up the knowledge base.
" - }, "repromptResponse":{ "shape":"RepromptResponse", "documentation":"Contains details about the response to reprompt the input.
" }, - "traceId":{ - "shape":"TraceId", - "documentation":"The unique identifier of the trace.
" - }, - "type":{ - "shape":"Type", - "documentation":"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.
Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" } }, "documentation":"Contains the result or output of an action group or knowledge base, or the response to the user.
", @@ -5516,7 +5884,7 @@ "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]{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][_-]?)+)$" + "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][_-]?)+)" }, "OptimizePromptResponse":{ "type":"structure", @@ -5555,30 +5923,18 @@ "OptimizedPromptStream":{ "type":"structure", "members":{ - "accessDeniedException":{ - "shape":"AccessDeniedException", - "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" + "optimizedPromptEvent":{ + "shape":"OptimizedPromptEvent", + "documentation":"An event in which the prompt was optimized.
" }, "analyzePromptEvent":{ "shape":"AnalyzePromptEvent", "documentation":"An event in which the prompt was analyzed in preparation for optimization.
" }, - "badGatewayException":{ - "shape":"BadGatewayException", - "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" - }, - "dependencyFailedException":{ - "shape":"DependencyFailedException", - "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" - }, "internalServerException":{ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, - "optimizedPromptEvent":{ - "shape":"OptimizedPromptEvent", - "documentation":"An event in which the prompt was optimized.
" - }, "throttlingException":{ "shape":"ThrottlingException", "documentation":"Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.
" @@ -5586,6 +5942,18 @@ "validationException":{ "shape":"ValidationException", "documentation":"Input validation failed. Check your request parameters and retry the request.
" + }, + "dependencyFailedException":{ + "shape":"DependencyFailedException", + "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" + }, + "accessDeniedException":{ + "shape":"AccessDeniedException", + "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" + }, + "badGatewayException":{ + "shape":"BadGatewayException", + "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" } }, "documentation":"The stream containing events in the prompt optimization process.
", @@ -5594,25 +5962,25 @@ "OrchestrationConfiguration":{ "type":"structure", "members":{ - "additionalModelRequestFields":{ - "shape":"AdditionalModelRequestFields", - "documentation":"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.
" + "promptTemplate":{ + "shape":"PromptTemplate", + "documentation":"Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$
and $output_format_instructions$
variables. For more information, see Use placeholder variables in the user guide.
Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
" }, - "performanceConfig":{ - "shape":"PerformanceConfiguration", - "documentation":"The latency configuration for the model.
" - }, - "promptTemplate":{ - "shape":"PromptTemplate", - "documentation":"Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$
and $output_format_instructions$
variables. For more information, see Use placeholder variables in the user guide.
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.
" }, "queryTransformationConfiguration":{ "shape":"QueryTransformationConfiguration", "documentation":"To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION
.
The latency configuration for the model.
" } }, "documentation":"Settings for how the model processes the prompt prior to retrieval and generation.
" @@ -5631,21 +5999,21 @@ "OrchestrationModelInvocationOutput":{ "type":"structure", "members":{ - "metadata":{ - "shape":"Metadata", - "documentation":"Contains information about the foundation model output from the orchestration step.
" + "traceId":{ + "shape":"TraceId", + "documentation":"The unique identifier of the trace.
" }, "rawResponse":{ "shape":"RawResponse", "documentation":"Contains details of the raw response from the foundation model output.
" }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the foundation model output from the orchestration step.
" + }, "reasoningContent":{ "shape":"ReasoningContentBlock", "documentation":"Contains content about the reasoning that the model made during the orchestration step.
" - }, - "traceId":{ - "shape":"TraceId", - "documentation":"The unique identifier of the trace.
" } }, "documentation":"The foundation model output from the orchestration step.
", @@ -5654,10 +6022,18 @@ "OrchestrationTrace":{ "type":"structure", "members":{ + "rationale":{ + "shape":"Rationale", + "documentation":"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.
" + }, "invocationInput":{ "shape":"InvocationInput", "documentation":"Contains information pertaining to the action group or knowledge base that is being invoked.
" }, + "observation":{ + "shape":"Observation", + "documentation":"Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
" + }, "modelInvocationInput":{ "shape":"ModelInvocationInput", "documentation":"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.
Contains information pertaining to the output from the foundation model that is being invoked.
" - }, - "observation":{ - "shape":"Observation", - "documentation":"Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
" - }, - "rationale":{ - "shape":"Rationale", - "documentation":"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.
" } }, "documentation":"Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
", @@ -5689,10 +6057,6 @@ "OutputFile":{ "type":"structure", "members":{ - "bytes":{ - "shape":"FileBody", - "documentation":"The byte count of files that contains response from code interpreter.
" - }, "name":{ "shape":"String", "documentation":"The name of the file containing response from code interpreter.
" @@ -5700,6 +6064,10 @@ "type":{ "shape":"MimeType", "documentation":"The type of file that contains response from the code interpreter.
" + }, + "bytes":{ + "shape":"FileBody", + "documentation":"The byte count of files that contains response from code interpreter.
" } }, "documentation":"Contains details of the response from code interpreter.
", @@ -5746,13 +6114,13 @@ "shape":"ParameterDescription", "documentation":"A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" }, - "required":{ - "shape":"Boolean", - "documentation":"Whether the parameter is required for the agent to complete the function for action group invocation.
" - }, "type":{ "shape":"ParameterType", "documentation":"The data type of the parameter.
" + }, + "required":{ + "shape":"Boolean", + "documentation":"Whether the parameter is required for the agent to complete the function for action group invocation.
" } }, "documentation":"Contains details about a parameter in a function for an action group.
" @@ -5768,7 +6136,7 @@ }, "ParameterName":{ "type":"string", - "pattern":"^([0-9a-zA-Z][_-]?){1,100}$" + "pattern":"([0-9a-zA-Z][_-]?){1,100}" }, "ParameterType":{ "type":"string", @@ -5797,13 +6165,13 @@ "PayloadPart":{ "type":"structure", "members":{ - "attribution":{ - "shape":"Attribution", - "documentation":"Contains citations for a part of an agent response.
" - }, "bytes":{ "shape":"PartBody", "documentation":"A part of the agent response in bytes.
" + }, + "attribution":{ + "shape":"Attribution", + "documentation":"Contains citations for a part of an agent response.
" } }, "documentation":"Contains a part of an agent response and citations for it.
", @@ -5837,9 +6205,9 @@ "PostProcessingModelInvocationOutput":{ "type":"structure", "members":{ - "metadata":{ - "shape":"Metadata", - "documentation":"Contains information about the foundation model output from the post-processing step.
" + "traceId":{ + "shape":"TraceId", + "documentation":"The unique identifier of the trace.
" }, "parsedResponse":{ "shape":"PostProcessingParsedResponse", @@ -5849,13 +6217,13 @@ "shape":"RawResponse", "documentation":"Details of the raw response from the foundation model output.
" }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the foundation model output from the post-processing step.
" + }, "reasoningContent":{ "shape":"ReasoningContentBlock", "documentation":"Contains content about the reasoning that the model made during the post-processing step.
" - }, - "traceId":{ - "shape":"TraceId", - "documentation":"The unique identifier of the trace.
" } }, "documentation":"The foundation model output from the post-processing step.
", @@ -5891,9 +6259,9 @@ "PreProcessingModelInvocationOutput":{ "type":"structure", "members":{ - "metadata":{ - "shape":"Metadata", - "documentation":"Contains information about the foundation model output from the pre-processing step.
" + "traceId":{ + "shape":"TraceId", + "documentation":"The unique identifier of the trace.
" }, "parsedResponse":{ "shape":"PreProcessingParsedResponse", @@ -5903,28 +6271,28 @@ "shape":"RawResponse", "documentation":"Details of the raw response from the foundation model output.
" }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the foundation model output from the pre-processing step.
" + }, "reasoningContent":{ "shape":"ReasoningContentBlock", "documentation":"Contains content about the reasoning that the model made during the pre-processing step.
" - }, - "traceId":{ - "shape":"TraceId", - "documentation":"The unique identifier of the trace.
" } }, "documentation":"The foundation model output from the pre-processing step.
", "sensitive":true }, - "PreProcessingParsedResponse":{ - "type":"structure", - "members":{ - "isValid":{ - "shape":"Boolean", - "documentation":"Whether the user input is valid or not. If false
, the agent doesn't proceed to orchestration.
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.
" + }, + "isValid":{ + "shape":"Boolean", + "documentation":"Whether the user input is valid or not. If false
, the agent doesn't proceed to orchestration.
Details about the response from the Lambda parsing of the output from the pre-processing step.
", @@ -5949,18 +6317,22 @@ "PromptConfiguration":{ "type":"structure", "members":{ - "additionalModelRequestFields":{ - "shape":"Document", - "documentation":"If the Converse or ConverseStream operations support the model, additionalModelRequestFields
contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration
field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
" + "promptType":{ + "shape":"PromptType", + "documentation":"The step in the agent sequence that this prompt configuration applies to.
" + }, + "promptCreationMode":{ + "shape":"CreationMode", + "documentation":"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.
Specifies whether to allow the inline 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
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.
" }, - "foundationModel":{ - "shape":"ModelIdentifier", - "documentation":"The foundation model to use.
" - }, "inferenceConfiguration":{ "shape":"InferenceConfiguration", "documentation":"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.
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 OVERRIDDEN
, 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.
Specifies whether to allow the inline 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 foundation model to use.
" }, - "promptType":{ - "shape":"PromptType", - "documentation":"The step in the agent sequence that this prompt configuration applies to.
" + "additionalModelRequestFields":{ + "shape":"Document", + "documentation":"If the Converse or ConverseStream operations support the model, additionalModelRequestFields
contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration
field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
" } }, "documentation":"Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" @@ -5993,13 +6361,13 @@ "PromptCreationConfigurations":{ "type":"structure", "members":{ - "excludePreviousThinkingSteps":{ - "shape":"Boolean", - "documentation":"If true
, the service removes any content between <thinking>
tags from previous conversations in an agent session. The service will only remove content from already processed turns. This helps you remove content which might not be useful for current and subsequent invocations. This can reduce the input token count and potentially save costs. The default value is false
.
The number of previous conversations from the ongoing agent session to include in the conversation history of the agent prompt, during the current invocation. This gives you more granular control over the context that the model is made aware of, and helps the model remove older context which is no longer useful during the ongoing agent session.
" + }, + "excludePreviousThinkingSteps":{ + "shape":"Boolean", + "documentation":"If true
, the service removes any content between <thinking>
tags from previous conversations in an agent session. The service will only remove content from already processed turns. This helps you remove content which might not be useful for current and subsequent invocations. This can reduce the input token count and potentially save costs. The default value is false
.
Specifies parameters that control how the service populates the agent prompt for an InvokeAgent
or InvokeInlineAgent
request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
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 Amazon Bedrock Agents.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" + }, + "overrideLambda":{ + "shape":"LambdaResourceArn", + "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
. For more information, see Parser Lambda function in Amazon Bedrock Agents.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", @@ -6074,20 +6442,22 @@ "PutInvocationStepRequest":{ "type":"structure", "required":[ + "sessionIdentifier", "invocationIdentifier", "invocationStepTime", - "payload", - "sessionIdentifier" + "payload" ], "members":{ + "sessionIdentifier":{ + "shape":"SessionIdentifier", + "documentation":"The unique identifier for the session to add the invocation step to. You can specify either the session's sessionId
or its Amazon Resource Name (ARN).
The unique identifier (in UUID format) of the invocation to add the invocation step to.
" }, - "invocationStepId":{ - "shape":"Uuid", - "documentation":"The unique identifier of the invocation step in UUID format.
" - }, "invocationStepTime":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the invocation step occurred.
" @@ -6096,11 +6466,9 @@ "shape":"InvocationStepPayload", "documentation":"The payload for the invocation step, including text and images for the interaction.
" }, - "sessionIdentifier":{ - "shape":"SessionIdentifier", - "documentation":"The unique identifier for the session to add the invocation step to. You can specify either the session's sessionId
or its Amazon Resource Name (ARN).
The unique identifier of the invocation step in UUID format.
" } } }, @@ -6117,17 +6485,17 @@ "QueryGenerationInput":{ "type":"structure", "required":[ - "text", - "type" + "type", + "text" ], "members":{ - "text":{ - "shape":"QueryGenerationInputTextString", - "documentation":"The text of the query.
" - }, "type":{ "shape":"InputQueryType", "documentation":"The type of the query.
" + }, + "text":{ + "shape":"QueryGenerationInputTextString", + "documentation":"The text of the query.
" } }, "documentation":"Contains information about a natural language query to transform into SQL.
", @@ -6171,13 +6539,13 @@ "Rationale":{ "type":"structure", "members":{ - "text":{ - "shape":"RationaleString", - "documentation":"The reasoning or thought process of the agent, based on the input.
" - }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace step.
" + }, + "text":{ + "shape":"RationaleString", + "documentation":"The reasoning or thought process of the agent, based on the input.
" } }, "documentation":"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.
", @@ -6218,13 +6586,13 @@ "type":"structure", "required":["text"], "members":{ - "signature":{ - "shape":"String", - "documentation":"A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent Converse
requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.
Text describing the reasoning that the model used to return the content in the content block.
" + }, + "signature":{ + "shape":"String", + "documentation":"A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent Converse
requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.
Contains information about the reasoning that the model used to return the content in the content block.
", @@ -6240,13 +6608,13 @@ "RepromptResponse":{ "type":"structure", "members":{ - "source":{ - "shape":"Source", - "documentation":"Specifies what output is prompting the agent to reprompt the input.
" - }, "text":{ "shape":"String", "documentation":"The text reprompting the input.
" + }, + "source":{ + "shape":"Source", + "documentation":"Specifies what output is prompting the agent to reprompt the input.
" } }, "documentation":"Contains details about the agent's response to reprompt the input.
", @@ -6273,17 +6641,17 @@ "type":"structure", "required":["type"], "members":{ - "jsonDocument":{ - "shape":"Document", - "documentation":"Contains a JSON document to rerank.
" + "type":{ + "shape":"RerankDocumentType", + "documentation":"The type of document to rerank.
" }, "textDocument":{ "shape":"RerankTextDocument", "documentation":"Contains information about a text document to rerank.
" }, - "type":{ - "shape":"RerankDocumentType", - "documentation":"The type of document to rerank.
" + "jsonDocument":{ + "shape":"Document", + "documentation":"Contains a JSON document to rerank.
" } }, "documentation":"Contains information about a document to rerank. Choose the type
to define and include the field that corresponds to the type.
Contains information about a text query.
" - }, "type":{ "shape":"RerankQueryContentType", "documentation":"The type of the query.
" + }, + "textQuery":{ + "shape":"RerankTextDocument", + "documentation":"Contains information about a text query.
" } }, "documentation":"Contains information about a query to submit to the reranker model.
", @@ -6330,25 +6698,25 @@ "type":"structure", "required":[ "queries", - "rerankingConfiguration", - "sources" + "sources", + "rerankingConfiguration" ], "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"If the total number of results was greater than could fit in a response, a token is returned in the nextToken
field. You can enter that token in this field to return the next batch of results.
An array of objects, each of which contains information about a query to submit to the reranker model.
" }, + "sources":{ + "shape":"RerankSourcesList", + "documentation":"An array of objects, each of which contains information about the sources to rerank.
" + }, "rerankingConfiguration":{ "shape":"RerankingConfiguration", "documentation":"Contains configurations for reranking.
" }, - "sources":{ - "shape":"RerankSourcesList", - "documentation":"An array of objects, each of which contains information about the sources to rerank.
" + "nextToken":{ + "shape":"NextToken", + "documentation":"If the total number of results was greater than could fit in a response, a token is returned in the nextToken
field. You can enter that token in this field to return the next batch of results.
If the total number of results is greater than can fit in the response, use this token in the nextToken
field when making another request to return the next batch of results.
An array of objects, each of which contains information about the results of reranking.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the total number of results is greater than can fit in the response, use this token in the nextToken
field when making another request to return the next batch of results.
Contains information about the document.
" - }, "index":{ "shape":"RerankResultIndexInteger", "documentation":"The ranking of the document. The lower a number, the higher the document is ranked.
" @@ -6384,6 +6748,10 @@ "relevanceScore":{ "shape":"Float", "documentation":"The relevance score of the document.
" + }, + "document":{ + "shape":"RerankDocument", + "documentation":"Contains information about the document.
" } }, "documentation":"Contains information about a document that was reranked.
" @@ -6401,17 +6769,17 @@ "RerankSource":{ "type":"structure", "required":[ - "inlineDocumentSource", - "type" + "type", + "inlineDocumentSource" ], "members":{ - "inlineDocumentSource":{ - "shape":"RerankDocument", - "documentation":"Contains an inline definition of a source for reranking.
" - }, "type":{ "shape":"RerankSourceType", "documentation":"The type of the source.
" + }, + "inlineDocumentSource":{ + "shape":"RerankDocument", + "documentation":"Contains an inline definition of a source for reranking.
" } }, "documentation":"Contains information about a source for reranking.
", @@ -6447,17 +6815,17 @@ "RerankingConfiguration":{ "type":"structure", "required":[ - "bedrockRerankingConfiguration", - "type" + "type", + "bedrockRerankingConfiguration" ], "members":{ - "bedrockRerankingConfiguration":{ - "shape":"BedrockRerankingConfiguration", - "documentation":"Contains configurations for an Amazon Bedrock reranker.
" - }, "type":{ "shape":"RerankingConfigurationType", "documentation":"The type of reranker that the configurations apply to.
" + }, + "bedrockRerankingConfiguration":{ + "shape":"BedrockRerankingConfiguration", + "documentation":"Contains configurations for an Amazon Bedrock reranker.
" } }, "documentation":"Contains configurations for reranking.
" @@ -6476,13 +6844,13 @@ "RerankingMetadataSelectiveModeConfiguration":{ "type":"structure", "members":{ - "fieldsToExclude":{ - "shape":"FieldsForReranking", - "documentation":"An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
" - }, "fieldsToInclude":{ "shape":"FieldsForReranking", "documentation":"An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
" + }, + "fieldsToExclude":{ + "shape":"FieldsForReranking", + "documentation":"An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
" } }, "documentation":"Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude
field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude
field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.
The request is denied because of missing access permissions. Check your permissions and retry your request.
" - }, - "badGatewayException":{ - "shape":"BadGatewayException", - "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" - }, "chunk":{ "shape":"PayloadPart", "documentation":"Contains a part of an agent response and citations for it.
" }, - "conflictException":{ - "shape":"ConflictException", - "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" - }, - "dependencyFailedException":{ - "shape":"DependencyFailedException", - "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" + "trace":{ + "shape":"TracePart", + "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" }, - "files":{ - "shape":"FilePart", - "documentation":"Contains intermediate response for code interpreter if any files have been generated.
" + "returnControl":{ + "shape":"ReturnControlPayload", + "documentation":"Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" }, "internalServerException":{ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, - "modelNotReadyException":{ - "shape":"ModelNotReadyException", - "documentation":"The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
" + "validationException":{ + "shape":"ValidationException", + "documentation":"Input validation failed. Check your request parameters and retry the request.
" }, "resourceNotFoundException":{ "shape":"ResourceNotFoundException", "documentation":"The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" }, - "returnControl":{ - "shape":"ReturnControlPayload", - "documentation":"Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" - }, "serviceQuotaExceededException":{ "shape":"ServiceQuotaExceededException", "documentation":"The number of requests exceeds the service quota. Resubmit your request later.
" @@ -6575,13 +6927,29 @@ "shape":"ThrottlingException", "documentation":"The number of requests exceeds the limit. Resubmit your request later.
" }, - "trace":{ - "shape":"TracePart", - "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" + "accessDeniedException":{ + "shape":"AccessDeniedException", + "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" }, - "validationException":{ - "shape":"ValidationException", - "documentation":"Input validation failed. Check your request parameters and retry the request.
" + "conflictException":{ + "shape":"ConflictException", + "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" + }, + "dependencyFailedException":{ + "shape":"DependencyFailedException", + "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" + }, + "badGatewayException":{ + "shape":"BadGatewayException", + "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" + }, + "modelNotReadyException":{ + "shape":"ModelNotReadyException", + "documentation":"The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
" + }, + "files":{ + "shape":"FilePart", + "documentation":"Contains intermediate response for code interpreter if any files have been generated.
" } }, "documentation":"The response from invoking the agent and associated citations and trace information.
", @@ -6590,14 +6958,14 @@ "RetrievalFilter":{ "type":"structure", "members":{ - "andAll":{ - "shape":"RetrievalFilterList", - "documentation":"Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
" - }, "equals":{ "shape":"FilterAttribute", "documentation":"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 when:
It contains a metadata attribute whose name matches the key
and whose value doesn't match the value
in this object.
The key is not present in the document.
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 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 are returned when:
It contains a metadata attribute whose name matches the key
and whose value doesn't match the value
in this object.
The key is not present in the document.
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 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 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 their metadata attributes fulfill at least one of the filter conditions inside this list.
" - }, "startsWith":{ "shape":"FilterAttribute", "documentation":"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 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 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\" }
Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
" + }, + "orAll":{ + "shape":"RetrievalFilterList", + "documentation":"Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
" } }, "documentation":"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
The type of content in the retrieval result.
" + }, + "text":{ + "shape":"String", + "documentation":"The cited text from the data source.
" + }, "byteContent":{ "shape":"String", "documentation":"A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}
.
Specifies information about the rows with the cells to return in retrieval.
" - }, - "text":{ - "shape":"String", - "documentation":"The cited text from the data source.
" - }, - "type":{ - "shape":"RetrievalResultContentType", - "documentation":"The type of content in the retrieval result.
" } }, "documentation":"Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.
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
The Confluence data source location.
" - }, - "customDocumentLocation":{ - "shape":"RetrievalResultCustomDocumentLocation", - "documentation":"Specifies the location of a document in a custom data source.
" - }, - "kendraDocumentLocation":{ - "shape":"RetrievalResultKendraDocumentLocation", - "documentation":"The location of a document in Amazon Kendra.
" + "type":{ + "shape":"RetrievalResultLocationType", + "documentation":"The type of data source location.
" }, "s3Location":{ "shape":"RetrievalResultS3Location", "documentation":"The S3 data source location.
" }, + "webLocation":{ + "shape":"RetrievalResultWebLocation", + "documentation":"The web URL/URLs data source location.
" + }, + "confluenceLocation":{ + "shape":"RetrievalResultConfluenceLocation", + "documentation":"The Confluence data source location.
" + }, "salesforceLocation":{ "shape":"RetrievalResultSalesforceLocation", "documentation":"The Salesforce data source location.
" @@ -6776,17 +7144,17 @@ "shape":"RetrievalResultSharePointLocation", "documentation":"The SharePoint data source location.
" }, + "customDocumentLocation":{ + "shape":"RetrievalResultCustomDocumentLocation", + "documentation":"Specifies the location of a document in a custom data source.
" + }, + "kendraDocumentLocation":{ + "shape":"RetrievalResultKendraDocumentLocation", + "documentation":"The location of a document in Amazon Kendra.
" + }, "sqlLocation":{ "shape":"RetrievalResultSqlLocation", "documentation":"Specifies information about the SQL query used to retrieve the result.
" - }, - "type":{ - "shape":"RetrievalResultLocationType", - "documentation":"The type of data source location.
" - }, - "webLocation":{ - "shape":"RetrievalResultWebLocation", - "documentation":"The web URL/URLs data source location.
" } }, "documentation":"Contains information about the data source location.
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 location
field
The configuration for the external source wrapper object in the retrieveAndGenerate
function.
The type of resource that contains your data for retrieving information and generating responses.
If you choose to use EXTERNAL_SOURCES
, then currently only Anthropic Claude 3 Sonnet models for knowledge bases are supported.
Contains details about the knowledge base for retrieving information and generating responses.
" }, - "type":{ - "shape":"RetrieveAndGenerateType", - "documentation":"The type of resource that contains your data for retrieving information and generating responses.
If you choose to use EXTERNAL_SOURCES
, then currently only Anthropic Claude 3 Sonnet models for knowledge bases are supported.
The configuration for the external source wrapper object in the retrieveAndGenerate
function.
Contains details about the resource being queried.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the retrieveAndGenerateConfiguration
field
The unique identifier of the session. When you first make a RetrieveAndGenerate
request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId
yourself.
Contains the query to be made to the knowledge base.
" @@ -6949,20 +7320,24 @@ "sessionConfiguration":{ "shape":"RetrieveAndGenerateSessionConfiguration", "documentation":"Contains details about the session with the knowledge base.
" - }, - "sessionId":{ - "shape":"SessionId", - "documentation":"The unique identifier of the session. When you first make a RetrieveAndGenerate
request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId
yourself.
The unique identifier of the session. When you first make a RetrieveAndGenerate
request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId
yourself.
Contains the response generated from querying the knowledge base.
" + }, "citations":{ "shape":"Citations", "documentation":"A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
" @@ -6970,14 +7345,6 @@ "guardrailAction":{ "shape":"GuadrailAction", "documentation":"Specifies if there is a guardrail intervention in the response.
" - }, - "output":{ - "shape":"RetrieveAndGenerateOutput", - "documentation":"Contains the response generated from querying the knowledge base.
" - }, - "sessionId":{ - "shape":"SessionId", - "documentation":"The unique identifier of the session. When you first make a RetrieveAndGenerate
request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId
yourself.
The unique identifier of the session. When you first make a RetrieveAndGenerate
request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId
yourself.
Contains the query to be made to the knowledge base.
" @@ -7007,29 +7378,25 @@ "sessionConfiguration":{ "shape":"RetrieveAndGenerateSessionConfiguration", "documentation":"Contains details about the session with the knowledge base.
" - }, - "sessionId":{ - "shape":"SessionId", - "documentation":"The unique identifier of the session. When you first make a RetrieveAndGenerate
request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId
yourself.
A stream of events from the model.
" + }, "sessionId":{ "shape":"SessionId", "documentation":"The session ID.
", "location":"header", "locationName":"x-amzn-bedrock-knowledge-base-session-id" - }, - "stream":{ - "shape":"RetrieveAndGenerateStreamResponseOutput", - "documentation":"A stream of events from the model.
" } }, "payload":"stream" @@ -7037,26 +7404,14 @@ "RetrieveAndGenerateStreamResponseOutput":{ "type":"structure", "members":{ - "accessDeniedException":{ - "shape":"AccessDeniedException", - "documentation":"The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide.
" - }, - "badGatewayException":{ - "shape":"BadGatewayException", - "documentation":"The request failed due to a bad gateway error.
" + "output":{ + "shape":"RetrieveAndGenerateOutputEvent", + "documentation":"An output event.
" }, "citation":{ "shape":"CitationEvent", "documentation":"A citation event.
" }, - "conflictException":{ - "shape":"ConflictException", - "documentation":"Error occurred because of a conflict while performing an operation.
" - }, - "dependencyFailedException":{ - "shape":"DependencyFailedException", - "documentation":"The request failed due to a dependency error.
" - }, "guardrail":{ "shape":"GuardrailEvent", "documentation":"A guardrail event.
" @@ -7065,9 +7420,9 @@ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, - "output":{ - "shape":"RetrieveAndGenerateOutputEvent", - "documentation":"An output event.
" + "validationException":{ + "shape":"ValidationException", + "documentation":"The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.
" }, "resourceNotFoundException":{ "shape":"ResourceNotFoundException", @@ -7081,9 +7436,21 @@ "shape":"ThrottlingException", "documentation":"Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide.
" }, - "validationException":{ - "shape":"ValidationException", - "documentation":"The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.
" + "accessDeniedException":{ + "shape":"AccessDeniedException", + "documentation":"The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide.
" + }, + "conflictException":{ + "shape":"ConflictException", + "documentation":"Error occurred because of a conflict while performing an operation.
" + }, + "dependencyFailedException":{ + "shape":"DependencyFailedException", + "documentation":"The request failed due to a dependency error.
" + }, + "badGatewayException":{ + "shape":"BadGatewayException", + "documentation":"The request failed due to a bad gateway error.
" } }, "documentation":"A retrieve and generate stream response output.
", @@ -7103,27 +7470,27 @@ "retrievalQuery" ], "members":{ - "guardrailConfiguration":{ - "shape":"GuardrailConfiguration", - "documentation":"Guardrail settings.
" - }, "knowledgeBaseId":{ "shape":"KnowledgeBaseId", "documentation":"The unique identifier of the knowledge base to query.
", "location":"uri", "locationName":"knowledgeBaseId" }, - "nextToken":{ - "shape":"NextToken", - "documentation":"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.
Contains the query to send the knowledge base.
" }, "retrievalConfiguration":{ "shape":"KnowledgeBaseRetrievalConfiguration", "documentation":"Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" }, - "retrievalQuery":{ - "shape":"KnowledgeBaseQuery", - "documentation":"Contains the query to send the knowledge base.
" + "guardrailConfiguration":{ + "shape":"GuardrailConfiguration", + "documentation":"Guardrail settings.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
A list of results from querying the knowledge base.
" + }, "guardrailAction":{ "shape":"GuadrailAction", "documentation":"Specifies if there is a guardrail intervention in the response.
" @@ -7138,10 +7509,6 @@ "nextToken":{ "shape":"NextToken", "documentation":"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.
A list of results from querying the knowledge base.
" } } }, @@ -7176,13 +7543,13 @@ "ReturnControlPayload":{ "type":"structure", "members":{ - "invocationId":{ - "shape":"String", - "documentation":"The identifier of the action group invocation.
" - }, "invocationInputs":{ "shape":"InvocationInputs", "documentation":"A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
" + }, + "invocationId":{ + "shape":"String", + "documentation":"The identifier of the action group invocation.
" } }, "documentation":"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:
", @@ -7206,17 +7573,17 @@ "RoutingClassifierModelInvocationOutput":{ "type":"structure", "members":{ - "metadata":{ - "shape":"Metadata", - "documentation":"The invocation's metadata.
" + "traceId":{ + "shape":"TraceId", + "documentation":"The invocation's trace ID.
" }, "rawResponse":{ "shape":"RawResponse", "documentation":"The invocation's raw response.
" }, - "traceId":{ - "shape":"TraceId", - "documentation":"The invocation's trace ID.
" + "metadata":{ + "shape":"Metadata", + "documentation":"The invocation's metadata.
" } }, "documentation":"Invocation output from a routing classifier model.
", @@ -7229,6 +7596,10 @@ "shape":"InvocationInput", "documentation":"The classifier's invocation input.
" }, + "observation":{ + "shape":"Observation", + "documentation":"The classifier's observation.
" + }, "modelInvocationInput":{ "shape":"ModelInvocationInput", "documentation":"The classifier's model invocation input.
" @@ -7236,10 +7607,6 @@ "modelInvocationOutput":{ "shape":"RoutingClassifierModelInvocationOutput", "documentation":"The classifier's model invocation output.
" - }, - "observation":{ - "shape":"Observation", - "documentation":"The classifier's observation.
" } }, "documentation":"A trace for a routing classifier.
", @@ -7250,7 +7617,7 @@ "type":"string", "max":63, "min":3, - "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + "pattern":"[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" }, "S3Identifier":{ "type":"structure", @@ -7303,13 +7670,13 @@ "type":"string", "max":1024, "min":1, - "pattern":"^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + "pattern":"[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*" }, "S3Uri":{ "type":"string", "max":1024, "min":1, - "pattern":"^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" + "pattern":"s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}" }, "SatisfiedCondition":{ "type":"structure", @@ -7350,7 +7717,7 @@ }, "SessionArn":{ "type":"string", - "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + "pattern":"arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "SessionAttributesMap":{ "type":"map", @@ -7361,11 +7728,11 @@ "type":"string", "max":100, "min":2, - "pattern":"^[0-9a-zA-Z._:-]+$" + "pattern":"[0-9a-zA-Z._:-]+" }, "SessionIdentifier":{ "type":"string", - "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})$" + "pattern":"(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})" }, "SessionMetadataKey":{ "type":"string", @@ -7387,33 +7754,33 @@ "SessionState":{ "type":"structure", "members":{ - "conversationHistory":{ - "shape":"ConversationHistory", - "documentation":"The state's conversation history.
" + "sessionAttributes":{ + "shape":"SessionAttributesMap", + "documentation":"Contains attributes that persist across a session and the values of those attributes. If sessionAttributes
are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.
Contains information about the files used by code interpreter.
" + "promptSessionAttributes":{ + "shape":"PromptSessionAttributesMap", + "documentation":"Contains attributes that persist across a prompt and the values of those attributes.
In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.
In multi-agent collaboration, the promptSessionAttributes
will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.
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.
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.
Contains information about the files used by code interpreter.
" + }, "knowledgeBaseConfigurations":{ "shape":"KnowledgeBaseConfigurations", "documentation":"An array of configurations, each of which applies to a knowledge base attached to the agent.
" }, - "promptSessionAttributes":{ - "shape":"PromptSessionAttributesMap", - "documentation":"Contains attributes that persist across a prompt and the values of those attributes.
In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.
In multi-agent collaboration, the promptSessionAttributes
will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.
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 attributes that persist across a session and the values of those attributes. If sessionAttributes
are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.
The state's conversation history.
" } }, "documentation":"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.
" @@ -7433,32 +7800,32 @@ "SessionSummary":{ "type":"structure", "required":[ - "createdAt", - "lastUpdatedAt", - "sessionArn", "sessionId", - "sessionStatus" + "sessionArn", + "sessionStatus", + "createdAt", + "lastUpdatedAt" ], "members":{ - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"The timestamp for when the session was created.
" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"The timestamp for when the session was last modified.
" + "sessionId":{ + "shape":"Uuid", + "documentation":"The unique identifier for the session.
" }, "sessionArn":{ "shape":"SessionArn", "documentation":"The Amazon Resource Name (ARN) of the session.
" }, - "sessionId":{ - "shape":"Uuid", - "documentation":"The unique identifier for the session.
" - }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"The current status of the session.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp for when the session was created.
" + }, + "lastUpdatedAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp for when the session was last modified.
" } }, "documentation":"Contains details about a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" @@ -7481,13 +7848,13 @@ "Span":{ "type":"structure", "members":{ - "end":{ - "shape":"SpanEndInteger", - "documentation":"Where the text with a citation ends in the generated output.
" - }, "start":{ "shape":"SpanStartInteger", "documentation":"Where the text with a citation starts in the generated output.
" + }, + "end":{ + "shape":"SpanEndInteger", + "documentation":"Where the text with a citation ends in the generated output.
" } }, "documentation":"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
The unique identifier of the flow to execute.
", + "location":"uri", + "locationName":"flowIdentifier" + }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias to use for the flow execution.
", @@ -7520,12 +7893,6 @@ "shape":"FlowExecutionName", "documentation":"The unique name for the flow execution. If you don't provide one, a system-generated name is used.
" }, - "flowIdentifier":{ - "shape":"FlowIdentifier", - "documentation":"The unique identifier of the flow to execute.
", - "location":"uri", - "locationName":"flowIdentifier" - }, "inputs":{ "shape":"FlowInputs", "documentation":"The input data required for the flow execution. This must match the input schema defined in the flow.
" @@ -7548,16 +7915,16 @@ "StopFlowExecutionRequest":{ "type":"structure", "required":[ - "executionIdentifier", + "flowIdentifier", "flowAliasIdentifier", - "flowIdentifier" + "executionIdentifier" ], "members":{ - "executionIdentifier":{ - "shape":"FlowExecutionIdentifier", - "documentation":"The unique identifier of the flow execution to stop.
", + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", "location":"uri", - "locationName":"executionIdentifier" + "locationName":"flowIdentifier" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", @@ -7565,11 +7932,11 @@ "location":"uri", "locationName":"flowAliasIdentifier" }, - "flowIdentifier":{ - "shape":"FlowIdentifier", - "documentation":"The unique identifier of the flow.
", + "executionIdentifier":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The unique identifier of the flow execution to stop.
", "location":"uri", - "locationName":"flowIdentifier" + "locationName":"executionIdentifier" } } }, @@ -7596,13 +7963,13 @@ "StreamingConfigurations":{ "type":"structure", "members":{ - "applyGuardrailInterval":{ - "shape":"StreamingConfigurationsApplyGuardrailIntervalInteger", - "documentation":" The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail
calls. The following examples show the response generated for Hello, I am an agent input string.
Example response in chunks: Interval set to 3 characters
'Hel', 'lo, ','I am', ' an', ' Age', 'nt'
Each chunk has at least 3 characters except for the last chunk
Example response in chunks: Interval set to 20 or more characters
Hello, I am an Agent
Specifies whether to enable streaming for the final response. This is set to false
by default.
The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail
calls. The following examples show the response generated for Hello, I am an agent input string.
Example response in chunks: Interval set to 3 characters
'Hel', 'lo, ','I am', ' an', ' Age', 'nt'
Each chunk has at least 3 characters except for the last chunk
Example response in chunks: Interval set to 20 or more characters
Hello, I am an Agent
Configurations for streaming.
" @@ -7627,7 +7994,7 @@ "documentation":"Key of a tag
", "max":128, "min":1, - "pattern":"^[a-zA-Z0-9\\s._:/=+@-]*$" + "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" }, "TagKeyList":{ "type":"list", @@ -7657,22 +8024,21 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", "documentation":"Value of a tag
", "max":256, "min":0, - "pattern":"^[a-zA-Z0-9\\s._:/=+@-]*$" + "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" }, "TaggableResourcesArn":{ "type":"string", "documentation":"ARN of Taggable resources: [session]
", "max":1011, "min":20, - "pattern":"(^arn:aws(-[^:]+)?:bedrock:[a-zA-Z0-9-]+:[0-9]{12}:(session)/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$)" + "pattern":".*(^arn:aws(-[^:]+)?:bedrock:[a-zA-Z0-9-]+:[0-9]{12}:(session)/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$).*" }, "TagsMap":{ "type":"map", @@ -7691,14 +8057,6 @@ "TextInferenceConfig":{ "type":"structure", "members":{ - "maxTokens":{ - "shape":"MaxTokens", - "documentation":"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.
" - }, - "stopSequences":{ - "shape":"RAGStopSequences", - "documentation":"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.
" - }, "temperature":{ "shape":"Temperature", "documentation":"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.
" @@ -7706,6 +8064,14 @@ "topP":{ "shape":"TopP", "documentation":"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.
" + }, + "maxTokens":{ + "shape":"MaxTokens", + "documentation":"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.
" + }, + "stopSequences":{ + "shape":"RAGStopSequences", + "documentation":"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.
" } }, "documentation":"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.
Contains information about where the text with a citation begins and ends in the generated output.
" - }, "text":{ "shape":"String", "documentation":"The part of the generated text that contains a citation.
" + }, + "span":{ + "shape":"Span", + "documentation":"Contains information about where the text with a citation begins and ends in the generated output.
" } }, "documentation":"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
Specifies configurations for a knowledge base to use in transformation.
" - }, "type":{ "shape":"TextToSqlConfigurationType", "documentation":"The type of resource to use in transformation.
" + }, + "knowledgeBaseConfiguration":{ + "shape":"TextToSqlKnowledgeBaseConfiguration", + "documentation":"Specifies configurations for a knowledge base to use in transformation.
" } }, "documentation":"Contains configurations for transforming text to SQL.
" @@ -7805,18 +8171,14 @@ "Trace":{ "type":"structure", "members":{ - "customOrchestrationTrace":{ - "shape":"CustomOrchestrationTrace", - "documentation":"Details about the custom orchestration step in which the agent determines the order in which actions are executed.
" - }, - "failureTrace":{ - "shape":"FailureTrace", - "documentation":"Contains information about the failure of the interaction.
" - }, "guardrailTrace":{ "shape":"GuardrailTrace", "documentation":"The trace details for a trace defined in the Guardrail filter.
" }, + "preProcessingTrace":{ + "shape":"PreProcessingTrace", + "documentation":"Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
" + }, "orchestrationTrace":{ "shape":"OrchestrationTrace", "documentation":"Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
" @@ -7825,19 +8187,35 @@ "shape":"PostProcessingTrace", "documentation":"Details about the post-processing step, in which the agent shapes the response..
" }, - "preProcessingTrace":{ - "shape":"PreProcessingTrace", - "documentation":"Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
" - }, "routingClassifierTrace":{ "shape":"RoutingClassifierTrace", "documentation":"A routing classifier's trace.
" + }, + "failureTrace":{ + "shape":"FailureTrace", + "documentation":"Contains information about the failure of the interaction.
" + }, + "customOrchestrationTrace":{ + "shape":"CustomOrchestrationTrace", + "documentation":"Details about the custom orchestration step in which the agent determines the order in which actions are executed.
" } }, "documentation":"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.
", "sensitive":true, "union":true }, + "TraceElements":{ + "type":"structure", + "members":{ + "agentTraces":{ + "shape":"AgentTraces", + "documentation":"Agent trace information for the flow execution.
" + } + }, + "documentation":"Contains trace elements for flow execution tracking.
", + "sensitive":true, + "union":true + }, "TraceId":{ "type":"string", "max":16, @@ -7850,37 +8228,37 @@ "TracePart":{ "type":"structure", "members":{ - "agentAliasId":{ - "shape":"AgentAliasId", - "documentation":"The unique identifier of the alias of the agent.
" - }, - "agentId":{ - "shape":"AgentId", - "documentation":"The unique identifier of the agent.
" + "sessionId":{ + "shape":"SessionId", + "documentation":"The unique identifier of the session with the agent.
" }, - "agentVersion":{ - "shape":"AgentVersion", - "documentation":"The version of the agent.
" + "trace":{ + "shape":"Trace", + "documentation":"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.
" }, "callerChain":{ "shape":"CallerChain", "documentation":"The part's caller chain.
" }, + "eventTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time of the trace.
" + }, "collaboratorName":{ "shape":"Name", "documentation":"The part's collaborator name.
" }, - "eventTime":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"The time of the trace.
" + "agentId":{ + "shape":"AgentId", + "documentation":"The unique identifier of the agent.
" }, - "sessionId":{ - "shape":"SessionId", - "documentation":"The unique identifier of the session with the agent.
" + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"The unique identifier of the alias of the agent.
" }, - "trace":{ - "shape":"Trace", - "documentation":"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.
" + "agentVersion":{ + "shape":"AgentVersion", + "documentation":"The version of the agent.
" } }, "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", @@ -7936,54 +8314,53 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateSessionRequest":{ "type":"structure", "required":["sessionIdentifier"], "members":{ + "sessionMetadata":{ + "shape":"SessionMetadataMap", + "documentation":"A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference, and the type of device they are using.
" + }, "sessionIdentifier":{ "shape":"SessionIdentifier", "documentation":"The unique identifier of the session to modify. You can specify either the session's sessionId
or its Amazon Resource Name (ARN).
A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference, and the type of device they are using.
" } } }, "UpdateSessionResponse":{ "type":"structure", "required":[ - "createdAt", - "lastUpdatedAt", - "sessionArn", "sessionId", - "sessionStatus" + "sessionArn", + "sessionStatus", + "createdAt", + "lastUpdatedAt" ], "members":{ - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"The timestamp for when the session was created.
" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"The timestamp for when the session was last modified.
" + "sessionId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the session you updated.
" }, "sessionArn":{ "shape":"SessionArn", "documentation":"The Amazon Resource Name (ARN) of the session that was updated.
" }, - "sessionId":{ - "shape":"Uuid", - "documentation":"The unique identifier of the session you updated.
" - }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"The status of the session you updated.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp for when the session was created.
" + }, + "lastUpdatedAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp for when the session was last modified.
" } } }, @@ -8004,7 +8381,7 @@ }, "Uuid":{ "type":"string", - "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "ValidationException":{ "type":"structure", @@ -8022,10 +8399,6 @@ "type":"structure", "required":["modelConfiguration"], "members":{ - "metadataConfiguration":{ - "shape":"MetadataConfigurationForReranking", - "documentation":"Contains configurations for the metadata to use in reranking.
" - }, "modelConfiguration":{ "shape":"VectorSearchBedrockRerankingModelConfiguration", "documentation":"Contains configurations for the reranker model.
" @@ -8033,6 +8406,10 @@ "numberOfRerankedResults":{ "shape":"VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger", "documentation":"The number of results to return after reranking.
" + }, + "metadataConfiguration":{ + "shape":"MetadataConfigurationForReranking", + "documentation":"Contains configurations for the metadata to use in reranking.
" } }, "documentation":"Contains configurations for reranking with an Amazon Bedrock reranker model.
" @@ -8047,13 +8424,13 @@ "type":"structure", "required":["modelArn"], "members":{ - "additionalModelRequestFields":{ - "shape":"AdditionalModelRequestFields", - "documentation":"A JSON object whose keys are request fields for the model and whose values are values for those fields.
" - }, "modelArn":{ "shape":"BedrockRerankingModelArn", "documentation":"The ARN of the reranker model to use.
" + }, + "additionalModelRequestFields":{ + "shape":"AdditionalModelRequestFields", + "documentation":"A JSON object whose keys are request fields for the model and whose values are values for those fields.
" } }, "documentation":"Contains configurations for an Amazon Bedrock reranker model.
" @@ -8062,13 +8439,13 @@ "type":"structure", "required":["type"], "members":{ - "bedrockRerankingConfiguration":{ - "shape":"VectorSearchBedrockRerankingConfiguration", - "documentation":"Contains configurations for an Amazon Bedrock reranker model.
" - }, "type":{ "shape":"VectorSearchRerankingConfigurationType", "documentation":"The type of reranker model.
" + }, + "bedrockRerankingConfiguration":{ + "shape":"VectorSearchBedrockRerankingConfiguration", + "documentation":"Contains configurations for an Amazon Bedrock reranker model.
" } }, "documentation":"Contains configurations for reranking the retrieved results.
" @@ -8085,7 +8462,7 @@ "type":"string", "max":5, "min":1, - "pattern":"^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + "pattern":"(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})" } }, "documentation":"Contains APIs related to model invocation and querying of knowledge bases.
" diff --git a/services/bedrockagentruntime/src/main/resources/codegen-resources/waiters-2.json b/services/bedrockagentruntime/src/main/resources/codegen-resources/waiters-2.json new file mode 100644 index 000000000000..13f60ee66be6 --- /dev/null +++ b/services/bedrockagentruntime/src/main/resources/codegen-resources/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/services/bedrockdataautomation/pom.xml b/services/bedrockdataautomation/pom.xml index a6114816ba19..a2b9a413fd18 100644 --- a/services/bedrockdataautomation/pom.xml +++ b/services/bedrockdataautomation/pom.xml @@ -17,7 +17,7 @@Category of Audio Extraction
" }, @@ -310,6 +311,13 @@ "TOPIC_CONTENT_MODERATION" ] }, + "AudioExtractionCategoryTypeConfiguration":{ + "type":"structure", + "members":{ + "transcript":{"shape":"TranscriptConfiguration"} + }, + "documentation":"Configuration for different audio extraction category types
" + }, "AudioExtractionCategoryTypes":{ "type":"list", "member":{"shape":"AudioExtractionCategoryType"}, @@ -476,6 +484,14 @@ "member":{"shape":"BlueprintSummary"}, "documentation":"List of Blueprints
" }, + "ChannelLabelingConfiguration":{ + "type":"structure", + "required":["state"], + "members":{ + "state":{"shape":"State"} + }, + "documentation":"Channel labeling configuration
" + }, "ClientToken":{ "type":"string", "documentation":"Client specified token used for idempotency checks
", @@ -715,8 +731,7 @@ }, "DeleteBlueprintResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Delete Blueprint Response
" }, "DeleteDataAutomationProjectRequest":{ @@ -1171,6 +1186,14 @@ }, "exception":true }, + "SpeakerLabelingConfiguration":{ + "type":"structure", + "required":["state"], + "members":{ + "state":{"shape":"State"} + }, + "documentation":"Speaker labeling configuration
" + }, "SplitterConfiguration":{ "type":"structure", "members":{ @@ -1241,8 +1264,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -1269,6 +1291,14 @@ }, "exception":true }, + "TranscriptConfiguration":{ + "type":"structure", + "members":{ + "speakerLabeling":{"shape":"SpeakerLabelingConfiguration"}, + "channelLabeling":{"shape":"ChannelLabelingConfiguration"} + }, + "documentation":"Configuration for transcript related features
" + }, "Type":{ "type":"string", "documentation":"Type
", @@ -1292,8 +1322,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateBlueprintRequest":{ "type":"structure", diff --git a/services/bedrockdataautomationruntime/pom.xml b/services/bedrockdataautomationruntime/pom.xml index f2e23cd8a3cd..08e6bb023938 100644 --- a/services/bedrockdataautomationruntime/pom.xml +++ b/services/bedrockdataautomationruntime/pom.xml @@ -17,7 +17,7 @@Associates one or more source billing views with an existing billing view. This allows creating aggregate billing views that combine data from multiple sources.
", + "idempotent":true + }, "CreateBillingView":{ "name":"CreateBillingView", "http":{ @@ -24,8 +45,10 @@ "input":{"shape":"CreateBillingViewRequest"}, "output":{"shape":"CreateBillingViewResponse"}, "errors":[ + {"shape":"BillingViewHealthStatusException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, @@ -52,6 +75,26 @@ "documentation":"Deletes the specified billing view.
", "idempotent":true }, + "DisassociateSourceViews":{ + "name":"DisassociateSourceViews", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSourceViewsRequest"}, + "output":{"shape":"DisassociateSourceViewsResponse"}, + "errors":[ + {"shape":"BillingViewHealthStatusException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes the association between one or more source billing views and an existing billing view. This allows modifying the composition of aggregate billing views.
", + "idempotent":true + }, "GetBillingView":{ "name":"GetBillingView", "http":{ @@ -67,7 +110,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns the metadata associated to the specified billing view ARN.
" + "documentation":"Returns the metadata associated to the specified billing view ARN.
", + "readonly":true }, "GetResourcePolicy":{ "name":"GetResourcePolicy", @@ -84,7 +128,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns the resource-based policy document attached to the resource in JSON
format.
Returns the resource-based policy document attached to the resource in JSON
format.
Lists the billing views available for a given time period.
Every Amazon Web Services account has a unique PRIMARY
billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP
billing views representing pro forma costs associated with each created billing group.
Lists the billing views available for a given time period.
Every Amazon Web Services account has a unique PRIMARY
billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP
billing views representing pro forma costs associated with each created billing group.
Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
" + "documentation":"Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
", + "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -134,7 +181,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Lists tags associated with the billing view resource.
" + "documentation":"Lists tags associated with the billing view resource.
", + "readonly":true }, "TagResource":{ "name":"TagResource", @@ -179,6 +227,7 @@ "input":{"shape":"UpdateBillingViewRequest"}, "output":{"shape":"UpdateBillingViewResponse"}, "errors":[ + {"shape":"BillingViewHealthStatusException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, @@ -223,9 +272,36 @@ }, "documentation":"A time range with a start and end time.
" }, + "AssociateSourceViewsRequest":{ + "type":"structure", + "required":[ + "arn", + "sourceViews" + ], + "members":{ + "arn":{ + "shape":"BillingViewArn", + "documentation":"The Amazon Resource Name (ARN) of the billing view to associate source views with.
" + }, + "sourceViews":{ + "shape":"BillingViewSourceViewsList", + "documentation":"A list of ARNs of the source billing views to associate.
" + } + } + }, + "AssociateSourceViewsResponse":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"BillingViewArn", + "documentation":"The ARN of the billing view that the source views were associated with.
" + } + } + }, "BillingViewArn":{ "type":"string", - "pattern":"arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9/:_\\+=\\.\\-@]{0,59}[a-zA-Z0-9]" + "pattern":"arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9/:_\\+=\\.\\-@]{0,75}[a-zA-Z0-9]" }, "BillingViewArnList":{ "type":"list", @@ -263,6 +339,10 @@ "shape":"AccountId", "documentation":"The account owner of the billing view.
" }, + "sourceAccountId":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.
" + }, "dataFilterExpression":{ "shape":"Expression", "documentation":" See Expression. Billing view only supports LINKED_ACCOUNT
and Tags
.
The time when the billing view was last updated.
" + }, + "derivedViewCount":{ + "shape":"Integer", + "documentation":"The number of billing views that use this billing view as a source.
" + }, + "sourceViewCount":{ + "shape":"Integer", + "documentation":"The number of source views associated with this billing view.
" + }, + "viewDefinitionLastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the billing view definition was last updated.
" + }, + "healthStatus":{ + "shape":"BillingViewHealthStatus", + "documentation":"The current health status of the billing view.
" } }, "documentation":"The metadata associated to the billing view.
" }, + "BillingViewHealthStatus":{ + "type":"structure", + "members":{ + "statusCode":{ + "shape":"BillingViewStatus", + "documentation":"The current health status code of the billing view.
" + }, + "statusReasons":{ + "shape":"BillingViewStatusReasons", + "documentation":"A list of reasons explaining the current health status, if applicable.
" + } + }, + "documentation":"Represents the health status of a billing view, including a status code and optional reasons for the status.
" + }, + "BillingViewHealthStatusException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":" Exception thrown when a billing view's health status prevents an operation from being performed. This may occur if the billing view is in a state other than HEALTHY
.
The list of owners of the Billing view.
" }, + "sourceAccountId":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.
" + }, "billingViewType":{ "shape":"BillingViewType", "documentation":"The type of billing view.
" + }, + "healthStatus":{ + "shape":"BillingViewHealthStatus", + "documentation":"The current health status of the billing view.
" } }, "documentation":"A representation of a billing view.
" @@ -318,9 +445,35 @@ "BillingViewSourceViewsList":{ "type":"list", "member":{"shape":"BillingViewArn"}, - "max":1, + "max":10, "min":1 }, + "BillingViewStatus":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY", + "CREATING", + "UPDATING" + ] + }, + "BillingViewStatusReason":{ + "type":"string", + "enum":[ + "SOURCE_VIEW_UNHEALTHY", + "SOURCE_VIEW_UPDATING", + "SOURCE_VIEW_ACCESS_DENIED", + "SOURCE_VIEW_NOT_FOUND", + "CYCLIC_DEPENDENCY", + "SOURCE_VIEW_DEPTH_EXCEEDED", + "AGGREGATE_SOURCE", + "VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT" + ] + }, + "BillingViewStatusReasons":{ + "type":"list", + "member":{"shape":"BillingViewStatusReason"} + }, "BillingViewType":{ "type":"string", "enum":[ @@ -339,6 +492,10 @@ "max":100, "min":1 }, + "Boolean":{ + "type":"boolean", + "box":true + }, "ClientToken":{ "type":"string", "pattern":"[a-zA-Z0-9-]+" @@ -419,6 +576,10 @@ "arn":{ "shape":"BillingViewArn", "documentation":"The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
" + }, + "force":{ + "shape":"Boolean", + "documentation":"If set to true, forces deletion of the billing view even if it has derived resources (e.g. other billing views or budgets). Use with caution as this may break dependent resources.
" } } }, @@ -454,6 +615,33 @@ }, "documentation":"The metadata that you can use to filter and group your results.
" }, + "DisassociateSourceViewsRequest":{ + "type":"structure", + "required":[ + "arn", + "sourceViews" + ], + "members":{ + "arn":{ + "shape":"BillingViewArn", + "documentation":"The Amazon Resource Name (ARN) of the billing view to disassociate source views from.
" + }, + "sourceViews":{ + "shape":"BillingViewSourceViewsList", + "documentation":"A list of ARNs of the source billing views to disassociate.
" + } + } + }, + "DisassociateSourceViewsResponse":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"BillingViewArn", + "documentation":"The ARN of the billing view that the source views were disassociated from.
" + } + } + }, "ErrorMessage":{ "type":"string", "max":1024, @@ -469,6 +657,10 @@ "tags":{ "shape":"TagValues", "documentation":" The specific Tag
to use for Expression
.
Specifies a time range filter for the billing view data.
" } }, "documentation":" See Expression. Billing view only supports LINKED_ACCOUNT
and Tags
.
The list of owners of the billing view.
" }, + "sourceAccountId":{ + "shape":"AccountId", + "documentation":"Filters the results to include only billing views that use the specified account as a source.
" + }, "maxResults":{ "shape":"BillingViewsMaxResults", "documentation":"The maximum number of billing views to retrieve. Default is 100.
" @@ -799,6 +999,20 @@ "documentation":"The request was denied due to request throttling.
", "exception":true }, + "TimeRange":{ + "type":"structure", + "members":{ + "beginDateInclusive":{ + "shape":"Timestamp", + "documentation":"The inclusive start date of the time range.
" + }, + "endDateInclusive":{ + "shape":"Timestamp", + "documentation":"The inclusive end date of the time range.
" + } + }, + "documentation":"Specifies a time range with inclusive begin and end dates.
" + }, "Timestamp":{"type":"timestamp"}, "UntagResourceRequest":{ "type":"structure", diff --git a/services/billingconductor/pom.xml b/services/billingconductor/pom.xml index bbdb27d35d91..22641ed778aa 100644 --- a/services/billingconductor/pom.xml +++ b/services/billingconductor/pom.xml @@ -21,7 +21,7 @@The billing view status must be HEALTHY to perform this action. Try again when the status is HEALTHY.
", + "exception":true }, "Budget":{ "type":"structure", @@ -741,7 +751,7 @@ }, "TimePeriod":{ "shape":"TimePeriod", - "documentation":"The period of time that's covered by a budget. You set the start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC
.
If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY
, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
. If you chose MONTHLY
, Amazon Web Services set your start date to 01/01/18 00:00 UTC
. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
You can change either date with the UpdateBudget
operation.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
" + "documentation":"The period of time that's covered by a budget. You set the start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC
.
If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, ANNUALLY, or CUSTOM). For example, if you created your budget on January 24, 2018, chose DAILY
, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
. If you chose MONTHLY
, Amazon Web Services set your start date to 01/01/18 00:00 UTC
. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
You can change either date with the UpdateBudget
operation.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
" }, "CalculatedSpend":{ "shape":"CalculatedSpend", @@ -1773,7 +1783,7 @@ }, "StatusReason":{ "shape":"HealthStatusReason", - "documentation":"The reason for the current status.
BILLING_VIEW_NO_ACCESS
: The billing view resource does not grant billing:GetBillingViewData
permission to this account.
BILLING_VIEW_UNHEALTHY
: The billing view associated with the budget is unhealthy.
FILTER_INVALID
: The filter contains reference to an account you do not have access to.
The reason for the current status.
BILLING_VIEW_NO_ACCESS
: The billing view resource does not grant billing:GetBillingViewData
permission to this account.
BILLING_VIEW_UNHEALTHY
: The billing view associated with the budget is unhealthy.
FILTER_INVALID
: The filter contains reference to an account you do not have access to.
MULTI_YEAR_HISTORICAL_DATA_DISABLED
: The budget is not being updated. Enable multi-year historical data in your Cost Management preferences.
The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY
, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
. If you chose MONTHLY
, Amazon Web Services set your start date to 01/01/18 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget
operation.
The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, ANNUALLY, or CUSTOM). For example, if you created your budget on January 24, 2018, chose DAILY
, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
. If you chose MONTHLY
, Amazon Web Services set your start date to 01/01/18 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget
operation.
Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
New and updated messages
Persistent and non-persistent messages
The Standard message type
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide.
Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
New and updated messages
Persistent and non-persistent messages
The Standard message type
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide.
Lists all channel memberships in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call as the value in the header.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
" + "documentation":"Lists all channel memberships in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call as the value in the header.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
" }, "ListChannelMembershipsForAppInstanceUser":{ "name":"ListChannelMembershipsForAppInstanceUser", @@ -849,7 +849,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], - "documentation":"Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call as the value in the header.
Redacts message content and metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call as the value in the header.
Allows the ChimeBearer
to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin
role can search across all channels.
The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call as the value in the header.
Allows the ChimeBearer
to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin
role can search across all channels.
The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call as the value in the header.
This operation isn't supported for AppInstanceUsers
with a large number of memberships.
The ID of the channel in the request.
" + "documentation":"An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.
" }, "MemberArns":{ "shape":"ChannelMemberArns", @@ -2741,7 +2741,14 @@ }, "GetMessagingSessionEndpointRequest":{ "type":"structure", - "members":{} + "members":{ + "NetworkType":{ + "shape":"NetworkType", + "documentation":"The type of network for the messaging session endpoint. Either IPv4 only or dual-stack (IPv4 and IPv6).
", + "location":"querystring", + "locationName":"network-type" + } + } }, "GetMessagingSessionEndpointResponse":{ "type":"structure", @@ -3426,6 +3433,13 @@ "max":40, "min":1 }, + "NetworkType":{ + "type":"string", + "enum":[ + "IPV4_ONLY", + "DUAL_STACK" + ] + }, "NextToken":{ "type":"string", "max":2048, @@ -3790,14 +3804,14 @@ }, "Values":{ "shape":"SearchFieldValues", - "documentation":"The values that you want to search for, a list of strings. The values must be AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with large number of memberships.
The values that you want to search for, a list of strings. The values must be AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with a large number of memberships.
The operator used to compare field values, currently EQUALS
or INCLUDES
. Use the EQUALS
operator to find channels whose memberships equal the specified values. Use the INCLUDES
operator to find channels whose memberships include the specified values.
A Field
of the channel that you want to search.
A Field
of the channel that you want to search.
This operation isn't supported for AppInstanceUsers
with a large number of memberships.
The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.
" + "documentation":"The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.
" } diff --git a/services/chimesdkvoice/pom.xml b/services/chimesdkvoice/pom.xml index 985faced8ea9..65a82c312d2b 100644 --- a/services/chimesdkvoice/pom.xml +++ b/services/chimesdkvoice/pom.xml @@ -21,7 +21,7 @@Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
" + "documentation":"Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
", + "readonly":true }, "BatchGetSchema":{ "name":"BatchGetSchema", @@ -47,7 +48,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves multiple schemas by their identifiers.
" + "documentation":"Retrieves multiple schemas by their identifiers.
", + "readonly":true }, "BatchGetSchemaAnalysisRule":{ "name":"BatchGetSchemaAnalysisRule", @@ -65,7 +67,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves multiple analysis rule schemas.
" + "documentation":"Retrieves multiple analysis rule schemas.
", + "readonly":true }, "CreateAnalysisTemplate":{ "name":"CreateAnalysisTemplate", @@ -298,6 +301,7 @@ "output":{"shape":"CreatePrivacyBudgetTemplateOutput"}, "errors":[ {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -555,7 +559,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves an analysis template.
" + "documentation":"Retrieves an analysis template.
", + "readonly":true }, "GetCollaboration":{ "name":"GetCollaboration", @@ -572,7 +577,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns metadata about a collaboration.
" + "documentation":"Returns metadata about a collaboration.
", + "readonly":true }, "GetCollaborationAnalysisTemplate":{ "name":"GetCollaborationAnalysisTemplate", @@ -590,7 +596,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves an analysis template within a collaboration.
" + "documentation":"Retrieves an analysis template within a collaboration.
", + "readonly":true }, "GetCollaborationChangeRequest":{ "name":"GetCollaborationChangeRequest", @@ -608,7 +615,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves detailed information about a specific collaboration change request.
" + "documentation":"Retrieves detailed information about a specific collaboration change request.
", + "readonly":true }, "GetCollaborationConfiguredAudienceModelAssociation":{ "name":"GetCollaborationConfiguredAudienceModelAssociation", @@ -626,7 +634,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves a configured audience model association within a collaboration.
" + "documentation":"Retrieves a configured audience model association within a collaboration.
", + "readonly":true }, "GetCollaborationIdNamespaceAssociation":{ "name":"GetCollaborationIdNamespaceAssociation", @@ -644,7 +653,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves an ID namespace association from a specific collaboration.
" + "documentation":"Retrieves an ID namespace association from a specific collaboration.
", + "readonly":true }, "GetCollaborationPrivacyBudgetTemplate":{ "name":"GetCollaborationPrivacyBudgetTemplate", @@ -662,7 +672,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns details about a specified privacy budget template.
" + "documentation":"Returns details about a specified privacy budget template.
", + "readonly":true }, "GetConfiguredAudienceModelAssociation":{ "name":"GetConfiguredAudienceModelAssociation", @@ -680,7 +691,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns information about a configured audience model association.
" + "documentation":"Returns information about a configured audience model association.
", + "readonly":true }, "GetConfiguredTable":{ "name":"GetConfiguredTable", @@ -698,7 +710,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves a configured table.
" + "documentation":"Retrieves a configured table.
", + "readonly":true }, "GetConfiguredTableAnalysisRule":{ "name":"GetConfiguredTableAnalysisRule", @@ -716,7 +729,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves a configured table analysis rule.
" + "documentation":"Retrieves a configured table analysis rule.
", + "readonly":true }, "GetConfiguredTableAssociation":{ "name":"GetConfiguredTableAssociation", @@ -734,7 +748,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves a configured table association.
" + "documentation":"Retrieves a configured table association.
", + "readonly":true }, "GetConfiguredTableAssociationAnalysisRule":{ "name":"GetConfiguredTableAssociationAnalysisRule", @@ -752,7 +767,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves the analysis rule for a configured table association.
" + "documentation":"Retrieves the analysis rule for a configured table association.
", + "readonly":true }, "GetIdMappingTable":{ "name":"GetIdMappingTable", @@ -770,7 +786,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves an ID mapping table.
" + "documentation":"Retrieves an ID mapping table.
", + "readonly":true }, "GetIdNamespaceAssociation":{ "name":"GetIdNamespaceAssociation", @@ -788,7 +805,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves an ID namespace association.
" + "documentation":"Retrieves an ID namespace association.
", + "readonly":true }, "GetMembership":{ "name":"GetMembership", @@ -806,7 +824,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves a specified membership for an identifier.
" + "documentation":"Retrieves a specified membership for an identifier.
", + "readonly":true }, "GetPrivacyBudgetTemplate":{ "name":"GetPrivacyBudgetTemplate", @@ -824,7 +843,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns details for a specified privacy budget template.
" + "documentation":"Returns details for a specified privacy budget template.
", + "readonly":true }, "GetProtectedJob":{ "name":"GetProtectedJob", @@ -842,7 +862,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns job processing metadata.
" + "documentation":"Returns job processing metadata.
", + "readonly":true }, "GetProtectedQuery":{ "name":"GetProtectedQuery", @@ -860,7 +881,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns query processing metadata.
" + "documentation":"Returns query processing metadata.
", + "readonly":true }, "GetSchema":{ "name":"GetSchema", @@ -878,7 +900,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves the schema for a relation within a collaboration.
" + "documentation":"Retrieves the schema for a relation within a collaboration.
", + "readonly":true }, "GetSchemaAnalysisRule":{ "name":"GetSchemaAnalysisRule", @@ -896,7 +919,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Retrieves a schema analysis rule.
" + "documentation":"Retrieves a schema analysis rule.
", + "readonly":true }, "ListAnalysisTemplates":{ "name":"ListAnalysisTemplates", @@ -914,7 +938,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists analysis templates that the caller owns.
" + "documentation":"Lists analysis templates that the caller owns.
", + "readonly":true }, "ListCollaborationAnalysisTemplates":{ "name":"ListCollaborationAnalysisTemplates", @@ -932,7 +957,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists analysis templates within a collaboration.
" + "documentation":"Lists analysis templates within a collaboration.
", + "readonly":true }, "ListCollaborationChangeRequests":{ "name":"ListCollaborationChangeRequests", @@ -950,7 +976,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.
" + "documentation":"Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.
", + "readonly":true }, "ListCollaborationConfiguredAudienceModelAssociations":{ "name":"ListCollaborationConfiguredAudienceModelAssociations", @@ -968,7 +995,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists configured audience model associations within a collaboration.
" + "documentation":"Lists configured audience model associations within a collaboration.
", + "readonly":true }, "ListCollaborationIdNamespaceAssociations":{ "name":"ListCollaborationIdNamespaceAssociations", @@ -986,7 +1014,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns a list of the ID namespace associations in a collaboration.
" + "documentation":"Returns a list of the ID namespace associations in a collaboration.
", + "readonly":true }, "ListCollaborationPrivacyBudgetTemplates":{ "name":"ListCollaborationPrivacyBudgetTemplates", @@ -1004,7 +1033,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns an array that summarizes each privacy budget template in a specified collaboration.
" + "documentation":"Returns an array that summarizes each privacy budget template in a specified collaboration.
", + "readonly":true }, "ListCollaborationPrivacyBudgets":{ "name":"ListCollaborationPrivacyBudgets", @@ -1022,7 +1052,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.
" + "documentation":"Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.
", + "readonly":true }, "ListCollaborations":{ "name":"ListCollaborations", @@ -1039,7 +1070,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists collaborations the caller owns, is active in, or has been invited to.
" + "documentation":"Lists collaborations the caller owns, is active in, or has been invited to.
", + "readonly":true }, "ListConfiguredAudienceModelAssociations":{ "name":"ListConfiguredAudienceModelAssociations", @@ -1057,7 +1089,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists information about requested configured audience model associations.
" + "documentation":"Lists information about requested configured audience model associations.
", + "readonly":true }, "ListConfiguredTableAssociations":{ "name":"ListConfiguredTableAssociations", @@ -1075,7 +1108,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists configured table associations for a membership.
" + "documentation":"Lists configured table associations for a membership.
", + "readonly":true }, "ListConfiguredTables":{ "name":"ListConfiguredTables", @@ -1092,7 +1126,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists configured tables.
" + "documentation":"Lists configured tables.
", + "readonly":true }, "ListIdMappingTables":{ "name":"ListIdMappingTables", @@ -1110,7 +1145,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns a list of ID mapping tables.
" + "documentation":"Returns a list of ID mapping tables.
", + "readonly":true }, "ListIdNamespaceAssociations":{ "name":"ListIdNamespaceAssociations", @@ -1128,7 +1164,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns a list of ID namespace associations.
" + "documentation":"Returns a list of ID namespace associations.
", + "readonly":true }, "ListMembers":{ "name":"ListMembers", @@ -1146,7 +1183,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists all members within a collaboration.
" + "documentation":"Lists all members within a collaboration.
", + "readonly":true }, "ListMemberships":{ "name":"ListMemberships", @@ -1163,7 +1201,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists all memberships resources within the caller's account.
" + "documentation":"Lists all memberships resources within the caller's account.
", + "readonly":true }, "ListPrivacyBudgetTemplates":{ "name":"ListPrivacyBudgetTemplates", @@ -1181,7 +1220,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns detailed information about the privacy budget templates in a specified membership.
" + "documentation":"Returns detailed information about the privacy budget templates in a specified membership.
", + "readonly":true }, "ListPrivacyBudgets":{ "name":"ListPrivacyBudgets", @@ -1199,7 +1239,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns detailed information about the privacy budgets in a specified membership.
" + "documentation":"Returns detailed information about the privacy budgets in a specified membership.
", + "readonly":true }, "ListProtectedJobs":{ "name":"ListProtectedJobs", @@ -1217,7 +1258,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists protected jobs, sorted by most recent job.
" + "documentation":"Lists protected jobs, sorted by most recent job.
", + "readonly":true }, "ListProtectedQueries":{ "name":"ListProtectedQueries", @@ -1235,7 +1277,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists protected queries, sorted by the most recent query.
" + "documentation":"Lists protected queries, sorted by the most recent query.
", + "readonly":true }, "ListSchemas":{ "name":"ListSchemas", @@ -1253,7 +1296,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Lists the schemas for relations within a collaboration.
" + "documentation":"Lists the schemas for relations within a collaboration.
", + "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -1268,7 +1312,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Lists all of the tags that have been added to a resource.
" + "documentation":"Lists all of the tags that have been added to a resource.
", + "readonly":true }, "PopulateIdMappingTable":{ "name":"PopulateIdMappingTable", @@ -6778,6 +6823,14 @@ }, "documentation":"An object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs.
" }, + "JobType":{ + "type":"string", + "enum":[ + "BATCH", + "INCREMENTAL", + "DELETE_ONLY" + ] + }, "JoinOperator":{ "type":"string", "enum":[ @@ -8237,6 +8290,10 @@ "documentation":"The unique identifier of the membership that contains the ID mapping table that you want to populate.
", "location":"uri", "locationName":"membershipIdentifier" + }, + "jobType":{ + "shape":"JobType", + "documentation":"The job type of the rule-based ID mapping job. Valid values include:
INCREMENTAL
: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in Entity Resolution with incrementalRunConfig
specified.
BATCH
: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in Entity Resolution but incrementalRunConfig
wasn't specified.
DELETE_ONLY
: Processes only deletion requests from BatchDeleteUniqueId
, which is set in Entity Resolution.
For more information about incrementalRunConfig
and BatchDeleteUniqueId
, see the Entity Resolution API Reference.
Returns a list of field indexes listed in the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.
" + "documentation":"Returns a list of custom and default field indexes which are discovered in log data. For more information about field index policies, see PutIndexPolicy.
" }, "DescribeIndexPolicies":{ "name":"DescribeIndexPolicies", @@ -549,7 +549,7 @@ {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Returns the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.
If a specified log group has a log-group level index policy, that policy is returned by this operation.
If a specified log group doesn't have a log-group level index policy, but an account-wide index policy applies to it, that account-wide policy is returned by this operation.
To find information about only account-level policies, use DescribeAccountPolicies instead.
" + "documentation":"Returns the field index policies of the specified log group. For more information about field index policies, see PutIndexPolicy.
If a specified log group has a log-group level index policy, that policy is returned by this operation.
If a specified log group doesn't have a log-group level index policy, but an account-wide index policy applies to it, that account-wide policy is returned by this operation.
To find information about only account-level policies, use DescribeAccountPolicies instead.
" }, "DescribeLogGroups":{ "name":"DescribeLogGroups", @@ -681,7 +681,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Lists log events from the specified log group. You can list all the log events or filter the results using one or more of the following:
A filter pattern
A time range
The log stream name, or a log stream name prefix that matches mutltiple log streams
You must have the logs:FilterLogEvents
permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier
or logGroupName
. You must include one of these two parameters, but you can't include both.
FilterLogEvents
is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.
Partially full or empty pages don't necessarily mean that pagination is finished. If the results include a nextToken
, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent FilterLogEvents
operation. If the results don't include a nextToken
, then pagination is finished.
Specifying the limit
parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents
request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
If you are using log transformation, the FilterLogEvents
operation returns only the original versions of log events, before they were transformed. To view the transformed versions, you must use a CloudWatch Logs query.
Lists log events from the specified log group. You can list all the log events or filter the results using one or more of the following:
A filter pattern
A time range
The log stream name, or a log stream name prefix that matches multiple log streams
You must have the logs:FilterLogEvents
permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier
or logGroupName
. You must include one of these two parameters, but you can't include both.
FilterLogEvents
is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.
Partially full or empty pages don't necessarily mean that pagination is finished. If the results include a nextToken
, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent FilterLogEvents
operation. If the results don't include a nextToken
, then pagination is finished.
Specifying the limit
parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents
request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
If you are using log transformation, the FilterLogEvents
operation returns only the original versions of log events, before they were transformed. To view the transformed versions, you must use a CloudWatch Logs query.
Creates an account-level data protection policy, subscription filter policy, field index policy, transformer policy, or metric extraction policy that applies to all log groups or a subset of log groups in the account.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are creating.
To create a data protection policy, you must have the logs:PutDataProtectionPolicy
and logs:PutAccountPolicy
permissions.
To create a subscription filter policy, you must have the logs:PutSubscriptionFilter
and logs:PutAccountPolicy
permissions.
To create a transformer policy, you must have the logs:PutTransformer
and logs:PutAccountPolicy
permissions.
To create a field index policy, you must have the logs:PutIndexPolicy
and logs:PutAccountPolicy
permissions.
To create a metric extraction policy, you must have the logs:PutMetricExtractionPolicy
and logs:PutAccountPolicy
permissions.
Data protection policy
A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use PutAccountPolicy
to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with the unmask
parameter set to true
to view the unmasked log events. Users with the logs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask
query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the PutAccountPolicy
operation for a data protection policy, you must be signed on with the logs:PutDataProtectionPolicy
and logs:PutAccountPolicy
permissions.
The PutAccountPolicy
operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.
Subscription filter policy
A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
A Lambda function in the same account as the subscription policy, for same-account delivery.
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in PolicyName
. To perform a PutAccountPolicy
subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole
permission.
Transformer policy
Creates or updates a log transformer policy for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters.
You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.
A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see Processors that you can use.
Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.
You can create transformers only for the log groups in the Standard log class.
You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the selectionCriteria
parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log
, you can't have another field index policy filtered to my-logpprod
or my-logging
.
You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with PutTransformer
and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.
Field index policy
You can use field index policies to create indexes on fields found in log events in the log group. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see Create field indexes to improve query performance and reduce costs
To find the fields that are in your log group events, use the GetLogGroupFields operation.
For example, suppose you have created a field index for requestId
. Then, any CloudWatch Logs Insights query on that log group that includes requestId = value
or requestId in [value, value, ...]
will attempt to process only the log events where the indexed field matches the specified value.
Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of RequestId
won't match a log event containing requestId
.
You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups with the selectionCriteria
parameter. If you have multiple account-level index policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log
, you can't have another field index policy filtered to my-logpprod
or my-logging
.
If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts.
If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of PutAccountPolicy
. If you do so, that log group will use only that log-group level policy, and will ignore the account-level policy that you create with PutAccountPolicy.
Metric extraction policy
A metric extraction policy controls whether CloudWatch Metrics can be created through the Embedded Metrics Format (EMF) for log groups in your account. By default, EMF metric creation is enabled for all log groups. You can use metric extraction policies to disable EMF metric creation for your entire account or specific log groups.
When a policy disables EMF metric creation for a log group, log events in the EMF format are still ingested, but no CloudWatch Metrics are created from them.
Creating a policy disables metrics for AWS features that use EMF to create metrics, such as CloudWatch Container Insights and CloudWatch Application Signals. To prevent turning off those features by accident, we recommend that you exclude the underlying log-groups through a selection-criteria such as LogGroupNamePrefix NOT IN [\"/aws/containerinsights\", \"/aws/ecs/containerinsights\", \"/aws/application-signals/data\"]
.
Each account can have either one account-level metric extraction policy that applies to all log groups, or up to 5 policies that are each scoped to a subset of log groups with the selectionCriteria
parameter. The selection criteria supports filtering by LogGroupName
and LogGroupNamePrefix
using the operators IN
and NOT IN
. You can specify up to 50 values in each IN
or NOT IN
list.
The selection criteria can be specified in these formats:
LogGroupName IN [\"log-group-1\", \"log-group-2\"]
LogGroupNamePrefix NOT IN [\"/aws/prefix1\", \"/aws/prefix2\"]
If you have multiple account-level metric extraction policies with selection criteria, no two of them can have overlapping criteria. For example, if you have one policy with selection criteria LogGroupNamePrefix IN [\"my-log\"]
, you can't have another metric extraction policy with selection criteria LogGroupNamePrefix IN [\"/my-log-prod\"]
or LogGroupNamePrefix IN [\"/my-logging\"]
, as the set of log groups matching these prefixes would be a subset of the log groups matching the first policy's prefix, creating an overlap.
When using NOT IN
, only one policy with this operator is allowed per account.
When combining policies with IN
and NOT IN
operators, the overlap check ensures that policies don't have conflicting effects. Two policies with IN
and NOT IN
operators do not overlap if and only if every value in the IN
policy is completely contained within some value in the NOT IN
policy. For example:
If you have a NOT IN
policy for prefix \"/aws/lambda\"
, you can create an IN
policy for the exact log group name \"/aws/lambda/function1\"
because the set of log groups matching \"/aws/lambda/function1\"
is a subset of the log groups matching \"/aws/lambda\"
.
If you have a NOT IN
policy for prefix \"/aws/lambda\"
, you cannot create an IN
policy for prefix \"/aws\"
because the set of log groups matching \"/aws\"
is not a subset of the log groups matching \"/aws/lambda\"
.
Creates an account-level data protection policy, subscription filter policy, field index policy, transformer policy, or metric extraction policy that applies to all log groups or a subset of log groups in the account.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are creating.
To create a data protection policy, you must have the logs:PutDataProtectionPolicy
and logs:PutAccountPolicy
permissions.
To create a subscription filter policy, you must have the logs:PutSubscriptionFilter
and logs:PutAccountPolicy
permissions.
To create a transformer policy, you must have the logs:PutTransformer
and logs:PutAccountPolicy
permissions.
To create a field index policy, you must have the logs:PutIndexPolicy
and logs:PutAccountPolicy
permissions.
To create a metric extraction policy, you must have the logs:PutMetricExtractionPolicy
and logs:PutAccountPolicy
permissions.
Data protection policy
A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use PutAccountPolicy
to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with the unmask
parameter set to true
to view the unmasked log events. Users with the logs:Unmask
can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask
query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the PutAccountPolicy
operation for a data protection policy, you must be signed on with the logs:PutDataProtectionPolicy
and logs:PutAccountPolicy
permissions.
The PutAccountPolicy
operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.
Subscription filter policy
A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
A Lambda function in the same account as the subscription policy, for same-account delivery.
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in PolicyName
. To perform a PutAccountPolicy
subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole
permission.
Transformer policy
Creates or updates a log transformer policy for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters.
You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.
A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see Processors that you can use.
Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.
You can create transformers only for the log groups in the Standard log class.
You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the selectionCriteria
parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log
, you can't have another field index policy filtered to my-logpprod
or my-logging
.
CloudWatch Logs provides default field indexes for all log groups in the Standard log class. Default field indexes are automatically available for the following fields:
@aws.region
@aws.account
@source.log
traceId
Default field indexes are in addition to any custom field indexes you define within your policy. Default field indexes are not counted towards your field index quota.
You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with PutTransformer
and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.
Field index policy
You can use field index policies to create indexes on fields found in log events in the log group. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see Create field indexes to improve query performance and reduce costs
To find the fields that are in your log group events, use the GetLogGroupFields operation.
For example, suppose you have created a field index for requestId
. Then, any CloudWatch Logs Insights query on that log group that includes requestId = value
or requestId in [value, value, ...]
will attempt to process only the log events where the indexed field matches the specified value.
Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of RequestId
won't match a log event containing requestId
.
You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups with the selectionCriteria
parameter. If you have multiple account-level index policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with my-log
, you can't have another field index policy filtered to my-logpprod
or my-logging
.
If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts.
If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of PutAccountPolicy
. If you do so, that log group will use only that log-group level policy, and will ignore the account-level policy that you create with PutAccountPolicy.
Metric extraction policy
A metric extraction policy controls whether CloudWatch Metrics can be created through the Embedded Metrics Format (EMF) for log groups in your account. By default, EMF metric creation is enabled for all log groups. You can use metric extraction policies to disable EMF metric creation for your entire account or specific log groups.
When a policy disables EMF metric creation for a log group, log events in the EMF format are still ingested, but no CloudWatch Metrics are created from them.
Creating a policy disables metrics for AWS features that use EMF to create metrics, such as CloudWatch Container Insights and CloudWatch Application Signals. To prevent turning off those features by accident, we recommend that you exclude the underlying log-groups through a selection-criteria such as LogGroupNamePrefix NOT IN [\"/aws/containerinsights\", \"/aws/ecs/containerinsights\", \"/aws/application-signals/data\"]
.
Each account can have either one account-level metric extraction policy that applies to all log groups, or up to 5 policies that are each scoped to a subset of log groups with the selectionCriteria
parameter. The selection criteria supports filtering by LogGroupName
and LogGroupNamePrefix
using the operators IN
and NOT IN
. You can specify up to 50 values in each IN
or NOT IN
list.
The selection criteria can be specified in these formats:
LogGroupName IN [\"log-group-1\", \"log-group-2\"]
LogGroupNamePrefix NOT IN [\"/aws/prefix1\", \"/aws/prefix2\"]
If you have multiple account-level metric extraction policies with selection criteria, no two of them can have overlapping criteria. For example, if you have one policy with selection criteria LogGroupNamePrefix IN [\"my-log\"]
, you can't have another metric extraction policy with selection criteria LogGroupNamePrefix IN [\"/my-log-prod\"]
or LogGroupNamePrefix IN [\"/my-logging\"]
, as the set of log groups matching these prefixes would be a subset of the log groups matching the first policy's prefix, creating an overlap.
When using NOT IN
, only one policy with this operator is allowed per account.
When combining policies with IN
and NOT IN
operators, the overlap check ensures that policies don't have conflicting effects. Two policies with IN
and NOT IN
operators do not overlap if and only if every value in the IN
policy is completely contained within some value in the NOT IN
policy. For example:
If you have a NOT IN
policy for prefix \"/aws/lambda\"
, you can create an IN
policy for the exact log group name \"/aws/lambda/function1\"
because the set of log groups matching \"/aws/lambda/function1\"
is a subset of the log groups matching \"/aws/lambda\"
.
If you have a NOT IN
policy for prefix \"/aws/lambda\"
, you cannot create an IN
policy for prefix \"/aws\"
because the set of log groups matching \"/aws\"
is not a subset of the log groups matching \"/aws/lambda\"
.
Creates or updates a field index policy for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes.
You can use field index policies to create field indexes on fields found in log events in the log group. Creating field indexes speeds up and lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs.
To find the fields that are in your log group events, use the GetLogGroupFields operation.
For example, suppose you have created a field index for requestId
. Then, any CloudWatch Logs Insights query on that log group that includes requestId = value
or requestId IN [value, value, ...]
will process fewer log events to reduce costs, and have improved performance.
Each index policy has the following quotas and restrictions:
As many as 20 fields can be included in the policy.
Each field name can include as many as 100 characters.
Matches of log events to the names of indexed fields are case-sensitive. For example, a field index of RequestId
won't match a log event containing requestId
.
Log group-level field index policies created with PutIndexPolicy
override account-level field index policies created with PutAccountPolicy. If you use PutIndexPolicy
to create a field index policy for a log group, that log group uses only that policy. The log group ignores any account-wide field index policy that you might have created.
Creates or updates a field index policy for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes.
You can use field index policies to create field indexes on fields found in log events in the log group. Creating field indexes speeds up and lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs.
To find the fields that are in your log group events, use the GetLogGroupFields operation.
For example, suppose you have created a field index for requestId
. Then, any CloudWatch Logs Insights query on that log group that includes requestId = value
or requestId IN [value, value, ...]
will process fewer log events to reduce costs, and have improved performance.
CloudWatch Logs provides default field indexes for all log groups in the Standard log class. Default field indexes are automatically available for the following fields:
@aws.region
@aws.account
@source.log
traceId
Default field indexes are in addition to any custom field indexes you define within your policy. Default field indexes are not counted towards your field index quota.
Each index policy has the following quotas and restrictions:
As many as 20 fields can be included in the policy.
Each field name can include as many as 100 characters.
Matches of log events to the names of indexed fields are case-sensitive. For example, a field index of RequestId
won't match a log event containing requestId
.
Log group-level field index policies created with PutIndexPolicy
override account-level field index policies created with PutAccountPolicy. If you use PutIndexPolicy
to create a field index policy for a log group, that log group uses only that policy. The log group ignores any account-wide field index policy that you might have created.
A stream of structured log data returned by the GetLogObject operation. This stream contains log events with their associated metadata and extracted fields.
" + } }, "documentation":"The response from the GetLogObject operation.
" }, @@ -3897,7 +3909,10 @@ "type":"structure", "members":{ "fields":{"shape":"FieldsData"}, - "InternalStreamingException":{"shape":"InternalStreamingException"} + "InternalStreamingException":{ + "shape":"InternalStreamingException", + "documentation":"An internal error occurred during the streaming of log data. This exception is thrown when there's an issue with the internal streaming mechanism used by the GetLogObject operation.
" + } }, "documentation":"A stream of structured log data returned by the GetLogObject operation. This stream contains log events with their associated metadata and extracted fields.
", "eventstream":true @@ -4001,10 +4016,10 @@ }, "match":{ "shape":"GrokMatch", - "documentation":"The grok pattern to match against the log event. For a list of supported grok patterns, see Supported grok patterns.
" + "documentation":"The grok pattern to match against the log event. For a list of supported grok patterns, see Supported grok patterns.
" } }, - "documentation":"This processor uses pattern matching to parse and structure unstructured data. This processor can also extract fields from log messages.
For more information about this processor including examples, see grok in the CloudWatch Logs User Guide.
" + "documentation":"This processor uses pattern matching to parse and structure unstructured data. This processor can also extract fields from log messages.
For more information about this processor including examples, see grok in the CloudWatch Logs User Guide.
" }, "GrokMatch":{ "type":"string", @@ -4831,6 +4846,14 @@ "applyOnTransformedLogs":{ "shape":"ApplyOnTransformedLogs", "documentation":"This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.
If this value is true
, the metric filter is applied on the transformed version of the log events instead of the original ingested log events.
The filter expression that specifies which log events are processed by this metric filter based on system fields. Returns the fieldSelectionCriteria
value if it was specified when the metric filter was created.
The list of system fields that are emitted as additional dimensions in the generated metrics. Returns the emitSystemFieldDimensions
value if it was specified when the metric filter was created.
Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.
" @@ -5947,6 +5970,14 @@ "applyOnTransformedLogs":{ "shape":"ApplyOnTransformedLogs", "documentation":"This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.
If the log group uses either a log-group level or account-level transformer, and you specify true
, the metric filter will be applied on the transformed version of the log events instead of the original ingested log events.
A filter expression that specifies which log events should be processed by this metric filter based on system fields such as source account and source region. Uses selection criteria syntax with operators like =
, !=
, AND
, OR
, IN
, NOT IN
. Example: @aws.region = \"us-east-1\"
or @aws.account IN [\"123456789012\", \"987654321098\"]
. Maximum length: 2000 characters.
A list of system fields to emit as additional dimensions in the generated metrics. Valid values are @aws.account
and @aws.region
. These dimensions help identify the source of centralized log data and count toward the total dimension limit for metric filters.
This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.
If the log group uses either a log-group level or account-level transformer, and you specify true
, the subscription filter will be applied on the transformed version of the log events instead of the original ingested log events.
A filter expression that specifies which log events should be processed by this subscription filter based on system fields such as source account and source region. Uses selection criteria syntax with operators like =
, !=
, AND
, OR
, IN
, NOT IN
. Example: @aws.region NOT IN [\"cn-north-1\"]
or @aws.account = \"123456789012\" AND @aws.region = \"us-east-1\"
. Maximum length: 2000 characters.
A list of system fields to include in the log events sent to the subscription destination. Valid values are @aws.account
and @aws.region
. These fields provide source information for centralized log data in the forwarded payload.
The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
The filter expression that specifies which log events are processed by this subscription filter based on system fields. Returns the fieldSelectionCriteria
value if it was specified when the subscription filter was created.
The list of system fields that are included in the log events sent to the subscription destination. Returns the emitSystemFields
value if it was specified when the subscription filter was created.
Represents a subscription filter.
" @@ -6897,6 +6944,7 @@ "HOURS" ] }, + "SystemField":{"type":"string"}, "TagKey":{ "type":"string", "max":128, diff --git a/services/codeartifact/pom.xml b/services/codeartifact/pom.xml index e0067f0e6fb7..63bc8bb06176 100644 --- a/services/codeartifact/pom.xml +++ b/services/codeartifact/pom.xml @@ -21,7 +21,7 @@This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
" }, + "AssociateContactWithUser":{ + "name":"AssociateContactWithUser", + "http":{ + "method":"POST", + "requestUri":"/contacts/{InstanceId}/{ContactId}/associate-user" + }, + "input":{"shape":"AssociateContactWithUserRequest"}, + "output":{"shape":"AssociateContactWithUserResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"Associates a queued contact with an agent.
Use cases
Following are common uses cases for this API:
Custom contact routing. You can build custom contact routing mechanisms beyond the default system routing in Amazon Connect. You can create tailored contact distribution logic that offers queued contacts directly to specific agents.
Manual contact assignment. You can programmatically assign queued contacts to available users. This provides flexibility to contact centers that require manual oversight or specialized routing workflows outside of standard queue management.
For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator Guide.
Important things to know
Use this API chat/SMS, email, and task contacts. It does not support voice contacts.
Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations.
It honors the IAM context key connect:PreferredUserArn
to prevent unauthorized contact associations.
It respects the IAM context key connect:PreferredUserArn
to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases.
Endpoints: See Amazon Connect endpoints and quotas.
" + }, "AssociateDefaultVocabulary":{ "name":"AssociateDefaultVocabulary", "http":{ @@ -2047,7 +2065,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"Disassociates a set of queues from a routing profile.
" + "documentation":"Disassociates a set of queues from a routing profile.
Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException.
" }, "DisassociateSecurityKey":{ "name":"DisassociateSecurityKey", @@ -2166,7 +2184,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], - "documentation":"Gets the real-time metrics of the specified contact.
Use cases
Following are common uses cases for this API:
You can use this API to retrieve the position of the contact in the queue.
Endpoints: See Amazon Connect endpoints and quotas.
" + "documentation":"Retrieves the position of the contact in the queue.
Use cases
Following are common uses cases for position in queue:
Understand the expected wait experience of a contact.
Inform customers of their position in queue and potentially offer a callback.
Make data-driven routing decisions between primary and alternative queues.
Enhance queue visibility and leverage agent proficiencies to streamline contact routing.
Important things to know
The only way to retrieve the position of the contact in queue is by using this API. You can't retrieve the position by using flows and attributes.
For more information, see the Position in queue metric in the Amazon Connect Administrator Guide.
Endpoints: See Amazon Connect endpoints and quotas.
" }, "GetCurrentMetricData":{ "name":"GetCurrentMetricData", @@ -2897,6 +2915,23 @@ ], "documentation":"Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only.
This API does not support VOICE. If you attempt to use it for VOICE, an InvalidRequestException
occurs.
Lists the manual assignment queues associated with a routing profile.
Use cases
Following are common uses cases for this API:
This API returns list of queues where contacts can be manually assigned or picked. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown).
For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator Guide.
Important things to know
This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile.
Endpoints: See Amazon Connect endpoints and quotas.
" + }, "ListRoutingProfileQueues":{ "name":"ListRoutingProfileQueues", "http":{ @@ -5679,6 +5714,36 @@ } } }, + "AssociateContactWithUserRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ContactId", + "UserId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "location":"uri", + "locationName":"InstanceId" + }, + "ContactId":{ + "shape":"ContactId", + "documentation":"The identifier of the contact in this instance of Amazon Connect.
", + "location":"uri", + "locationName":"ContactId" + }, + "UserId":{ + "shape":"AgentResourceId", + "documentation":"The identifier for the user. This can be the ID or the ARN of the user.
" + } + } + }, + "AssociateContactWithUserResponse":{ + "type":"structure", + "members":{} + }, "AssociateDefaultVocabularyRequest":{ "type":"structure", "required":[ @@ -5881,8 +5946,7 @@ "type":"structure", "required":[ "InstanceId", - "RoutingProfileId", - "QueueConfigs" + "RoutingProfileId" ], "members":{ "InstanceId":{ @@ -5900,6 +5964,10 @@ "QueueConfigs":{ "shape":"RoutingProfileQueueConfigList", "documentation":"The queues to associate with this routing profile.
" + }, + "ManualAssignmentQueueConfigs":{ + "shape":"RoutingProfileManualAssignmentQueueConfigList", + "documentation":"The manual assignment queues to associate with this routing profile.
" } } }, @@ -7824,7 +7892,7 @@ "documentation":"The message.
" } }, - "documentation":"The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.
", + "documentation":"The contact with the specified ID is not active or does not exist.
", "error":{"httpStatusCode":410}, "exception":true }, @@ -7891,7 +7959,12 @@ "SegmentAttributes":{ "shape":"ContactSearchSummarySegmentAttributes", "documentation":"Set of segment attributes for a contact.
" - } + }, + "Name":{ + "shape":"Name", + "documentation":"Indicates name of the contact.
" + }, + "RoutingCriteria":{"shape":"RoutingCriteria"} }, "documentation":"Information of returned contact.
" }, @@ -7929,6 +8002,10 @@ "ValueString":{ "shape":"SegmentAttributeValueString", "documentation":"The value of a segment attribute represented as a string.
" + }, + "ValueMap":{ + "shape":"SegmentAttributeValueMap", + "documentation":"The key and value of a segment attribute.
" } }, "documentation":"The value of a segment attribute. This is structured as a map with a single key-value pair. The key 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value of the segment attribute.
" @@ -9014,6 +9091,10 @@ "shape":"RoutingProfileQueueConfigList", "documentation":"The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig
objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.
The manual assignment queues associated with the routing profile. If no queue is added, agents and supervisors can't pick or assign any contacts from this routing profile. The limit of 10 array members applies to the maximum number of RoutingProfileManualAssignmentQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.
" + }, "MediaConcurrencies":{ "shape":"MediaConcurrencies", "documentation":"The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
" @@ -11783,8 +11864,7 @@ "type":"structure", "required":[ "InstanceId", - "RoutingProfileId", - "QueueReferences" + "RoutingProfileId" ], "members":{ "InstanceId":{ @@ -11802,6 +11882,10 @@ "QueueReferences":{ "shape":"RoutingProfileQueueReferenceList", "documentation":"The queues to disassociate from this routing profile.
" + }, + "ManualAssignmentQueueReferences":{ + "shape":"RoutingProfileQueueReferenceList", + "documentation":"The manual assignment queues to disassociate with this routing profile.
" } } }, @@ -13970,7 +14054,7 @@ }, "Metrics":{ "shape":"MetricsV2", - "documentation":"The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. For now, this metric only supports the following as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate
key in metric-level filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation time
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation turns
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average conversation close time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
UI name: Average dials per minute
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average evaluation score
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent first response time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent message length
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer message length
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average messages
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent messages
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average bot messages
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer messages
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent response time
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer response time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Seconds
Valid groupings and filters: Campaign
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average weighted evaluation score
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot conversations completed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot intents completed
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter GT
(for Greater than).
UI name: Campaign contacts abandoned after X
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Percent
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter GT
(for Greater than).
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Percent
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Campaign progress rate
This metric is available only for outbound campaigns.
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
UI name: Campaign send attempts
This metric is available only for outbound campaigns.
Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE
Unit: Count
Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp
UI name: Campaign send exclusions
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Conversations abandoned
This metric is available only for outbound campaigns.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS
, CAMPAIGN_DELIVERY_EVENT_TYPE
, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempts
Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS
, CAMPAIGN_DELIVERY_EVENT_TYPE
, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempt disposition rate
Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Evaluations performed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Count
Valid groupings and filters: Agent, Campaign
UI name: Human answered
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Automatic fails percent
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot conversations outcome
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot intents outcome
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE
is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Count
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Recipients attempted
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp
UI name: Recipients interacted
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Count
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Recipients targeted
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate
key in metric-level filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API
| Incoming
| Outbound
| Transfer
| Callback
| Queue_Transfer
| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-productive time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
Valid metric filter key: INITIATION_METHOD
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. For now, this metric only supports the following as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate
key in metric-level filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation time
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation turns
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average conversation close time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
UI name: Average dials per minute
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average evaluation score
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent first response time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent message length
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer message length
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average messages
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent messages
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average bot messages
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer messages
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Valid metric level filters: INITIATION_METHOD
, FEATURE
, DISCONNECT_REASON
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent response time
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer response time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Seconds
Valid groupings and filters: Campaign
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy
UI name: Avg. wait time after customer connection - customer first callback
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average weighted evaluation score
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot conversations completed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot intents completed
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter GT
(for Greater than).
UI name: Campaign contacts abandoned after X
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Percent
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter GT
(for Greater than).
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Percent
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Campaign progress rate
This metric is available only for outbound campaigns.
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
UI name: Campaign send attempts
This metric is available only for outbound campaigns.
Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE
Unit: Count
Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp
UI name: Campaign send exclusions
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Conversations abandoned
This metric is available only for outbound campaigns.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS
, CAMPAIGN_DELIVERY_EVENT_TYPE
, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempts
Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS
, CAMPAIGN_DELIVERY_EVENT_TYPE
, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempt disposition rate
Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Evaluations performed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Count
Valid groupings and filters: Agent, Campaign
UI name: Human answered
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Automatic fails percent
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot conversations outcome
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot intents outcome
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE
is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Count
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Recipients attempted
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp
UI name: Recipients interacted
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Count
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Recipients targeted
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
| CALLBACK_CUSTOMER_FIRST_DIALED
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate
key in metric-level filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API
| INCOMING
| OUTBOUND
| TRANSFER
| CALLBACK
| QUEUE_TRANSFER
| Disconnect
| CALLBACK_CUSTOMER_FIRST_DIALED
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you can use LT
(for \"Less than\") or LTE
(for \"Less than equal\").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-productive time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The date till which the hours of operation override would be effective.
" + "documentation":"The date until the hours of operation override is effective.
" } }, "documentation":"Information about the hours of operations override.
" @@ -17016,6 +17100,61 @@ } } }, + "ListRoutingProfileManualAssignmentQueuesRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "RoutingProfileId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "location":"uri", + "locationName":"InstanceId" + }, + "RoutingProfileId":{ + "shape":"RoutingProfileId", + "documentation":"The identifier of the routing profile.
", + "location":"uri", + "locationName":"RoutingProfileId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult100", + "documentation":"The maximum number of results to return per page.
", + "box":true, + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListRoutingProfileManualAssignmentQueuesResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + }, + "RoutingProfileManualAssignmentQueueConfigSummaryList":{ + "shape":"RoutingProfileManualAssignmentQueueConfigSummaryList", + "documentation":"Information about the manual assignment queues associated with the routing profile.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when this resource was last modified.
" + }, + "LastModifiedRegion":{ + "shape":"RegionName", + "documentation":"The Amazon Web Services Region where this resource was last modified.
" + } + } + }, "ListRoutingProfileQueuesRequest":{ "type":"structure", "required":[ @@ -18121,6 +18260,24 @@ "min":1, "pattern":"(^[\\S].*[\\S]$)|(^[\\S]$)" }, + "NameCriteria":{ + "type":"structure", + "required":[ + "SearchText", + "MatchType" + ], + "members":{ + "SearchText":{ + "shape":"SearchTextList", + "documentation":"The words or phrases used to match the contact name.
" + }, + "MatchType":{ + "shape":"SearchContactsMatchType", + "documentation":"The match type combining name search criteria using multiple search texts in a name criteria.
" + } + }, + "documentation":"The search criteria based on the contact name
" + }, "Namespace":{ "type":"string", "max":128, @@ -18697,6 +18854,7 @@ }, "documentation":"Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
" }, + "PersistentConnection":{"type":"boolean"}, "PhoneNumber":{ "type":"string", "pattern":"\\\\+[1-9]\\\\d{1,14}$" @@ -20921,6 +21079,10 @@ "shape":"Long", "documentation":"The number of associated queues in routing profile.
" }, + "NumberOfAssociatedManualAssignmentQueues":{ + "shape":"Long", + "documentation":"The number of associated manual assignment queues in routing profile.
" + }, "NumberOfAssociatedUsers":{ "shape":"Long", "documentation":"The number of associated users in routing profile.
" @@ -20944,6 +21106,10 @@ "AssociatedQueueIds":{ "shape":"AssociatedQueueIdList", "documentation":"The IDs of the associated queue.
" + }, + "AssociatedManualAssignmentQueueIds":{ + "shape":"AssociatedQueueIdList", + "documentation":"The IDs of the associated manual assignment queues.
" } }, "documentation":"Contains information about a routing profile.
" @@ -20958,6 +21124,52 @@ "type":"list", "member":{"shape":"RoutingProfile"} }, + "RoutingProfileManualAssignmentQueueConfig":{ + "type":"structure", + "required":["QueueReference"], + "members":{ + "QueueReference":{"shape":"RoutingProfileQueueReference"} + }, + "documentation":"Contains information about the queue and channel for manual assignment behaviour can be enabled.
" + }, + "RoutingProfileManualAssignmentQueueConfigList":{ + "type":"list", + "member":{"shape":"RoutingProfileManualAssignmentQueueConfig"}, + "max":10, + "min":1 + }, + "RoutingProfileManualAssignmentQueueConfigSummary":{ + "type":"structure", + "required":[ + "QueueId", + "QueueArn", + "QueueName", + "Channel" + ], + "members":{ + "QueueId":{ + "shape":"QueueId", + "documentation":"The identifier for the queue.
" + }, + "QueueArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the queue.
" + }, + "QueueName":{ + "shape":"QueueName", + "documentation":"The name of the queue.
" + }, + "Channel":{ + "shape":"Channel", + "documentation":"The channels this queue supports. Valid Values: CHAT | TASK | EMAIL
" + } + }, + "documentation":"Contains summary information about a routing profile manual assignment queue.
" + }, + "RoutingProfileManualAssignmentQueueConfigSummaryList":{ + "type":"list", + "member":{"shape":"RoutingProfileManualAssignmentQueueConfigSummary"} + }, "RoutingProfileName":{ "type":"string", "max":127, @@ -21551,11 +21763,46 @@ } } }, + "SearchContactsAdditionalTimeRange":{ + "type":"structure", + "required":[ + "Criteria", + "MatchType" + ], + "members":{ + "Criteria":{ + "shape":"SearchContactsAdditionalTimeRangeCriteriaList", + "documentation":"List of criteria of the time range to additionally filter on.
" + }, + "MatchType":{ + "shape":"SearchContactsMatchType", + "documentation":"The match type combining multiple time range filters.
" + } + }, + "documentation":"Time range that you additionally want to filter on.
" + }, + "SearchContactsAdditionalTimeRangeCriteria":{ + "type":"structure", + "members":{ + "TimeRange":{"shape":"SearchContactsTimeRange"}, + "TimestampCondition":{ + "shape":"SearchContactsTimestampCondition", + "documentation":"List of the timestamp conditions.
" + } + }, + "documentation":"The criteria of the time range to additionally filter on.
" + }, + "SearchContactsAdditionalTimeRangeCriteriaList":{ + "type":"list", + "member":{"shape":"SearchContactsAdditionalTimeRangeCriteria"} + }, "SearchContactsMatchType":{ "type":"string", "enum":[ "MATCH_ALL", - "MATCH_ANY" + "MATCH_ANY", + "MATCH_EXACT", + "MATCH_NONE" ] }, "SearchContactsRequest":{ @@ -21633,18 +21880,45 @@ }, "documentation":"A structure of time range that you want to search results.
" }, + "SearchContactsTimeRangeConditionType":{ + "type":"string", + "enum":["NOT_EXISTS"] + }, "SearchContactsTimeRangeType":{ "type":"string", "enum":[ "INITIATION_TIMESTAMP", "SCHEDULED_TIMESTAMP", "CONNECTED_TO_AGENT_TIMESTAMP", - "DISCONNECT_TIMESTAMP" + "DISCONNECT_TIMESTAMP", + "ENQUEUE_TIMESTAMP" ] }, + "SearchContactsTimestampCondition":{ + "type":"structure", + "required":[ + "Type", + "ConditionType" + ], + "members":{ + "Type":{ + "shape":"SearchContactsTimeRangeType", + "documentation":"Type of the timestamps to use for the filter.
" + }, + "ConditionType":{ + "shape":"SearchContactsTimeRangeConditionType", + "documentation":"Condition of the timestamp on the contact.
" + } + }, + "documentation":"The timestamp condition indicating which timestamp should be used and how it should be filtered.
" + }, "SearchCriteria":{ "type":"structure", "members":{ + "Name":{ + "shape":"NameCriteria", + "documentation":"Name of the contact.
" + }, "AgentIds":{ "shape":"AgentResourceIdList", "documentation":"The identifiers of agents who handled the contacts.
" @@ -21669,6 +21943,14 @@ "shape":"QueueIdList", "documentation":"The list of queue IDs associated with contacts.
" }, + "RoutingCriteria":{ + "shape":"SearchableRoutingCriteria", + "documentation":"Routing criteria for the contact.
" + }, + "AdditionalTimeRange":{ + "shape":"SearchContactsAdditionalTimeRange", + "documentation":"Additional TimeRange used to filter contacts.
" + }, "SearchableContactAttributes":{ "shape":"SearchableContactAttributes", "documentation":"The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes
in a search request, the GetContactAttributes
action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
The identifiers of agents used in preferred agents matching.
" + }, + "MatchType":{ + "shape":"SearchContactsMatchType", + "documentation":"The match type combining multiple agent criteria steps.
" + } + }, + "documentation":"The agent criteria to search for preferred agents on the routing criteria.
" + }, "SearchableContactAttributeKey":{ "type":"string", "max":100, @@ -22310,6 +22606,30 @@ "type":"string", "enum":["STANDARD"] }, + "SearchableRoutingCriteria":{ + "type":"structure", + "members":{ + "Steps":{ + "shape":"SearchableRoutingCriteriaStepList", + "documentation":"The list of Routing criteria steps of the contact routing.
" + } + }, + "documentation":"Routing criteria of the contact to match on.
" + }, + "SearchableRoutingCriteriaStep":{ + "type":"structure", + "members":{ + "AgentCriteria":{ + "shape":"SearchableAgentCriteriaStep", + "documentation":"Agent matching the routing step of the routing criteria
" + } + }, + "documentation":"Routing criteria of the contact to match on.
" + }, + "SearchableRoutingCriteriaStepList":{ + "type":"list", + "member":{"shape":"SearchableRoutingCriteriaStep"} + }, "SearchableSegmentAttributeKey":{ "type":"string", "max":64, @@ -22887,7 +23207,8 @@ "CONNECTED_TO_AGENT_TIMESTAMP", "DISCONNECT_TIMESTAMP", "INITIATION_METHOD", - "CHANNEL" + "CHANNEL", + "EXPIRY_TIMESTAMP" ] }, "SourceApplicationName":{ @@ -25363,7 +25684,7 @@ }, "EffectiveTill":{ "shape":"HoursOfOperationOverrideYearMonthDayDateFormat", - "documentation":"The date till when the hours of operation override would be effective.
" + "documentation":"The date until the hours of operation override is effective.
" } } }, @@ -26868,6 +27189,11 @@ "DeskPhoneNumber":{ "shape":"PhoneNumber", "documentation":"The phone number for the user's desk phone.
" + }, + "PersistentConnection":{ + "shape":"PersistentConnection", + "documentation":"The persistent connection setting for the user.
", + "box":true } }, "documentation":"Contains information about the phone configuration settings for a user.
" diff --git a/services/connectcampaigns/pom.xml b/services/connectcampaigns/pom.xml index cf8efd0197c8..3655ca49cff2 100644 --- a/services/connectcampaigns/pom.xml +++ b/services/connectcampaigns/pom.xml @@ -21,7 +21,7 @@Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you want the request to return. For example, you can specify BlendedCosts
or UsageQuantity
. You can also filter and group your data by various dimensions, such as SERVICE
or AZ
, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.
For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
" }, @@ -216,7 +217,8 @@ {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"}, {"shape":"LimitExceededException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"BillingViewHealthStatusException"} ], "documentation":"Retrieves cost and usage comparisons for your account between two periods within the last 13 months. If you have enabled multi-year data at monthly granularity, you can go back up to 38 months.
" }, @@ -234,7 +236,8 @@ {"shape":"BillExpirationException"}, {"shape":"InvalidNextTokenException"}, {"shape":"RequestChangedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"BillingViewHealthStatusException"} ], "documentation":"Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as BlendedCosts
or UsageQuantity
, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE
or AZ
, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.
Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) resource-level data. All other resource-level data is available at daily granularity.
This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information about how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.
Retrieves an array of Cost Category names and values incurred cost.
If some Cost Category names and values are not associated with any cost, they will not be returned by this API.
Retrieves key factors driving cost changes between two time periods within the last 13 months, such as usage changes, discount changes, and commitment-based savings. If you have enabled multi-year data at monthly granularity, you can go back up to 38 months.
" }, @@ -283,7 +288,8 @@ "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"BillingViewHealthStatusException"} ], "documentation":"Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
" }, @@ -301,7 +307,8 @@ {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"}, {"shape":"RequestChangedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"BillingViewHealthStatusException"} ], "documentation":"Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
" }, @@ -450,7 +457,8 @@ {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"}, {"shape":"RequestChangedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"BillingViewHealthStatusException"} ], "documentation":"Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
" }, @@ -466,7 +474,8 @@ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"}, {"shape":"UnresolvableUsageUnitException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"BillingViewHealthStatusException"} ], "documentation":"Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.
" }, @@ -1045,6 +1054,14 @@ "min":20, "pattern":"^arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[-a-zA-Z0-9/:_+=.-@]{1,43}$" }, + "BillingViewHealthStatusException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":" The billing view status must be HEALTHY
to perform this action. Try again when the status is HEALTHY
.
The category or classification of the cost driver.
Values include: BUNDLED_DISCOUNT, CREDIT, OUT_OF_CYCLE_CHARGE, REFUND, RECURRING_RESERVATION_FEE, RESERVATION_USAGE, RI_VOLUME_DISCOUNT, SAVINGS_PLAN_USAGE, SAVINGS_PLAN_NEGATION, SAVINGS_PLAN_RECURRING_FEE, SUPPORT_FEE, TAX, UPFRONT_RESERVATION_FEE, USAGE_CHANGE, COMMITMENT
" + "documentation":"The category or classification of the cost driver.
Values include: BUNDLED_DISCOUNT, CREDIT, OUT_OF_CYCLE_CHARGE, REFUND, RECURRING_RESERVATION_FEE, RESERVATION_USAGE, RI_VOLUME_DISCOUNT, SAVINGS_PLAN_USAGE, SAVINGS_PLAN_RECURRING_FEE, SUPPORT_FEE, TAX, UPFRONT_RESERVATION_FEE, USAGE_CHANGE, COMMITMENT
" }, "Name":{ "shape":"GenericString", @@ -1909,6 +1926,7 @@ "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", + "PAYER_ACCOUNT", "LINKED_ACCOUNT_NAME", "OPERATION", "PURCHASE_TYPE", diff --git a/services/costoptimizationhub/pom.xml b/services/costoptimizationhub/pom.xml index f24ffdb16d2c..e406a1382f15 100644 --- a/services/costoptimizationhub/pom.xml +++ b/services/costoptimizationhub/pom.xml @@ -17,7 +17,7 @@The ARN of an IAM user profile in Amazon DataZone.
" + }, + "principalId":{ + "shape":"String", + "documentation":"Principal ID of the IAM user.
" } }, "documentation":"The details of an IAM user profile in Amazon DataZone.
" diff --git a/services/dax/pom.xml b/services/dax/pom.xml index 2ec2785c285b..4c0004cddca4 100644 --- a/services/dax/pom.xml +++ b/services/dax/pom.xml @@ -21,7 +21,7 @@Creates a new subnet group.
" }, @@ -291,7 +292,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.
RebootNode
restarts the DAX engine process and does not remove the contents of the cache.
Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.
RebootNode
restarts the DAX engine process and does not remove the contents of the cache.
Modifies an existing subnet group.
" } @@ -472,6 +474,10 @@ "ClusterEndpointEncryptionType":{ "shape":"ClusterEndpointEncryptionType", "documentation":"The type of encryption supported by the cluster's endpoint. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
The IP address type of the cluster. Values are:
ipv4
- IPv4 addresses only
ipv6
- IPv6 addresses only
dual_stack
- Both IPv4 and IPv6 addresses
Contains all of the attributes of a specific DAX cluster.
" @@ -506,7 +512,7 @@ "ClusterQuotaForCustomerExceededFault":{ "type":"structure", "members":{}, - "documentation":"You have attempted to exceed the maximum number of DAX clusters for your AWS account.
", + "documentation":"You have attempted to exceed the maximum number of DAX clusters for your Amazon Web Services account.
", "exception":true }, "CreateClusterRequest":{ @@ -532,7 +538,7 @@ }, "ReplicationFactor":{ "shape":"Integer", - "documentation":"The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor
to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones
parameter is provided, its length must equal the ReplicationFactor
.
AWS recommends that you have at least two read replicas per cluster.
The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor
to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones
parameter is provided, its length must equal the ReplicationFactor
.
Amazon Web Services recommends that you have at least two read replicas per cluster.
The type of encryption the cluster's endpoint should support. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
Specifies the IP protocol(s) the cluster uses for network communications. Values are:
ipv4
- The cluster is accessible only through IPv4 addresses
ipv6
- The cluster is accessible only through IPv6 addresses
dual_stack
- The cluster is accessible through both IPv4 and IPv6 addresses.
If no explicit NetworkType
is provided, the network type is derived based on the subnet group's configuration.
A description of the DAX cluster. with its new replication factor.
" + "documentation":"A description of the DAX cluster, with its new replication factor.
" } } }, @@ -1095,6 +1105,18 @@ } } }, + "NetworkType":{ + "type":"string", + "enum":[ + "ipv4", + "ipv6", + "dual_stack" + ] + }, + "NetworkTypeList":{ + "type":"list", + "member":{"shape":"NetworkType"} + }, "Node":{ "type":"structure", "members":{ @@ -1148,7 +1170,7 @@ "NodeQuotaForCustomerExceededFault":{ "type":"structure", "members":{}, - "documentation":"You have attempted to exceed the maximum number of nodes for your AWS account.
", + "documentation":"You have attempted to exceed the maximum number of nodes for your Amazon Web Services account.
", "exception":true }, "NodeTypeSpecificValue":{ @@ -1174,7 +1196,7 @@ "members":{ "TopicArn":{ "shape":"String", - "documentation":"The Amazon Resource Name (ARN) that identifies the topic.
" + "documentation":"The Amazon Resource Name (ARN) that identifies the topic.
" }, "TopicStatus":{ "shape":"String", @@ -1404,7 +1426,7 @@ "ServiceQuotaExceededException":{ "type":"structure", "members":{}, - "documentation":"You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted clusters.
", + "documentation":"You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact Amazon Web Services customer support to discuss options for continuing to create encrypted clusters.
", "exception":true }, "SourceType":{ @@ -1426,6 +1448,10 @@ "SubnetAvailabilityZone":{ "shape":"String", "documentation":"The Availability Zone (AZ) for the subnet.
" + }, + "SupportedNetworkTypes":{ + "shape":"NetworkTypeList", + "documentation":"The network types supported by this subnet. Returns an array of strings that can include ipv4
, ipv6
, or both, indicating whether the subnet supports IPv4 only, IPv6 only, or dual-stack deployments.
Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.
" @@ -1448,6 +1474,10 @@ "Subnets":{ "shape":"SubnetList", "documentation":"A list of subnets associated with the subnet group.
" + }, + "SupportedNetworkTypes":{ + "shape":"NetworkTypeList", + "documentation":"The network types supported by this subnet. Returns an array of strings that can include ipv4
, ipv6
, or both, indicating whether the subnet group supports IPv4 only, IPv6 only, or dual-stack deployments.
Represents the output of one of the following actions:
CreateSubnetGroup
ModifySubnetGroup
The specified subnet can't be used for the requested network type. This error occurs when either there aren't enough subnets of the required network type to create the cluster, or when you try to use a subnet that doesn't support the requested network type (for example, trying to create a dual-stack cluster with a subnet that doesn't have IPv6 CIDR).
", + "exception":true + }, "SubnetQuotaExceededFault":{ "type":"structure", "members":{}, @@ -1514,10 +1550,10 @@ }, "Value":{ "shape":"String", - "documentation":"The value of the tag. Tag values are case-sensitive and can be null.
" + "documentation":"The value of the tag. Tag values are case-sensitive and can be null.
" } }, - "documentation":"A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.
AWS-assigned tag names and values are automatically assigned the aws:
prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user:
.
You cannot backdate the application of a tag.
" + "documentation":"A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.
Amazon Web Services-assigned tag names and values are automatically assigned the aws:
prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user:
.
You cannot backdate the application of a tag.
" }, "TagList":{ "type":"list", @@ -1684,5 +1720,5 @@ } } }, - "documentation":"DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.
" + "documentation":"DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the Amazon Web Services Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.
" } diff --git a/services/deadline/pom.xml b/services/deadline/pom.xml index 7be61abe9475..365b386d9ddf 100644 --- a/services/deadline/pom.xml +++ b/services/deadline/pom.xml @@ -17,7 +17,7 @@Creates an exact copy of an Amazon EBS snapshot.
The location of the source snapshot determines whether you can copy it or not, and the allowed destinations for the snapshot copy.
If the source snapshot is in a Region, you can copy it within that Region, to another Region, to an Outpost associated with that Region, or to a Local Zone in that Region.
If the source snapshot is in a Local Zone, you can copy it within that Local Zone, to another Local Zone in the same zone group, or to the parent Region of the Local Zone.
If the source snapshot is on an Outpost, you can't copy it.
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
Snapshots copies have an arbitrary source volume ID. Do not use this volume ID for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon EBS User Guide.
" + "documentation":"Creates an exact copy of an Amazon EBS snapshot.
The location of the source snapshot determines whether you can copy it or not, and the allowed destinations for the snapshot copy.
If the source snapshot is in a Region, you can copy it within that Region, to another Region, to an Outpost associated with that Region, or to a Local Zone in that Region.
If the source snapshot is in a Local Zone, you can copy it within that Local Zone, to another Local Zone in the same zone group, or to the parent Region of the Local Zone.
If the source snapshot is on an Outpost, you can't copy it.
When copying snapshots to a Region, the encryption outcome for the snapshot copy depends on the Amazon EBS encryption by default setting for the destination Region, the encryption status of the source snapshot, and the encryption parameters you specify in the request. For more information, see Encryption and snapshot copying.
Snapshots copied to an Outpost must be encrypted. Unencrypted snapshots are not supported on Outposts. For more information, Amazon EBS local snapshots on Outposts.
Snapshots copies have an arbitrary source volume ID. Do not use this volume ID for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon EBS User Guide.
" }, "CreateCapacityReservation":{ "name":"CreateCapacityReservation", @@ -778,7 +778,7 @@ }, "input":{"shape":"CreateFpgaImageRequest"}, "output":{"shape":"CreateFpgaImageResult"}, - "documentation":"Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
" + "documentation":"Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI was successfully created and is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
" }, "CreateImage":{ "name":"CreateImage", @@ -4274,7 +4274,7 @@ }, "input":{"shape":"DisableImageBlockPublicAccessRequest"}, "output":{"shape":"DisableImageBlockPublicAccessResult"}, - "documentation":"Disables block public access for AMIs at the account level in the specified Amazon Web Services Region. This removes the block public access restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified Amazon Web Services Region.
The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be block-new-sharing
. When the API has completed the configuration, the response will be unblocked
.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
" + "documentation":"Disables block public access for AMIs at the account level in the specified Amazon Web Services Region. This removes the block public access restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified Amazon Web Services Region.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
" }, "DisableImageDeprecation":{ "name":"DisableImageDeprecation", @@ -13664,7 +13664,7 @@ }, "Encrypted":{ "shape":"Boolean", - "documentation":"To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
", + "documentation":"To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Copies of encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
", "locationName":"encrypted" }, "KmsKeyId":{ @@ -18306,7 +18306,7 @@ }, "Iops":{ "shape":"Integer", - "documentation":"The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3
: 3,000 - 16,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS. This parameter is not supported for gp2
, st1
, sc1
, or standard
volumes.
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3
: 3,000 - 80,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS. This parameter is not supported for gp2
, st1
, sc1
, or standard
volumes.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2
and gp3
: 1 - 16,384 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2
: 1 - 16,384 GiB
gp3
: 1 - 65,536 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3
volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
" + "documentation":"The throughput to provision for a volume, with a maximum of 2,000 MiB/s.
This parameter is valid only for gp3
volumes.
Valid Range: Minimum value of 125. Maximum value of 2,000.
" }, "ClientToken":{ "shape":"String", @@ -18827,6 +18827,27 @@ }, "documentation":"Contains the output of CreateVpnGateway.
" }, + "CreationDateCondition":{ + "type":"structure", + "members":{ + "MaximumDaysSinceCreated":{ + "shape":"MaximumDaysSinceCreatedValue", + "documentation":"The maximum number of days that have elapsed since the image was created. For example, a value of 300
allows images that were created within the last 300 days.
The maximum age for allowed images.
" + }, + "CreationDateConditionRequest":{ + "type":"structure", + "members":{ + "MaximumDaysSinceCreated":{ + "shape":"MaximumDaysSinceCreatedValue", + "documentation":"The maximum number of days that have elapsed since the image was created. For example, a value of 300
allows images that were created within the last 300 days.
The maximum age for allowed images.
" + }, "CreditSpecification":{ "type":"structure", "members":{ @@ -21314,6 +21335,27 @@ }, "documentation":"Contains the parameters for DeleteVpnGateway.
" }, + "DeprecationTimeCondition":{ + "type":"structure", + "members":{ + "MaximumDaysSinceDeprecated":{ + "shape":"MaximumDaysSinceDeprecatedValue", + "documentation":"The maximum number of days that have elapsed since the image was deprecated. When set to 0
, no deprecated images are allowed.
The maximum period since deprecation for allowed images.
" + }, + "DeprecationTimeConditionRequest":{ + "type":"structure", + "members":{ + "MaximumDaysSinceDeprecated":{ + "shape":"MaximumDaysSinceDeprecatedValue", + "documentation":"The maximum number of days that have elapsed since the image was deprecated. Set to 0
to exclude all deprecated images.
The maximum period since deprecation for allowed images.
" + }, "DeprovisionByoipCidrRequest":{ "type":"structure", "required":["Cidr"], @@ -23801,7 +23843,7 @@ }, "IncludeAllResourceTypes":{ "shape":"Boolean", - "documentation":"Specifies whether to check all supported Amazon Web Services resource types for image references. When specified, default values are applied for ResourceTypeOptions
. For the default values, see How AMI reference checks work in the Amazon EC2 User Guide. If you also specify ResourceTypes
with ResourceTypeOptions
, your specified values override the default values.
Supported resource types: ec2:Instance
| ec2:LaunchTemplate
| ssm:Parameter
| imagebuilder:ImageRecipe
| imagebuilder:ContainerRecipe
Either IncludeAllResourceTypes
or ResourceTypes
must be specified.
Specifies whether to check all supported Amazon Web Services resource types for image references. When specified, default values are applied for ResourceTypeOptions
. For the default values, see How AMI reference checks work in the Amazon EC2 User Guide. If you also specify ResourceTypes
with ResourceTypeOptions
, your specified values override the default values.
Supported resource types: ec2:Instance
| ec2:LaunchTemplate
| ssm:Parameter
| imagebuilder:ImageRecipe
| imagebuilder:ContainerRecipe
Either IncludeAllResourceTypes
or ResourceTypes
must be specified.
The filters.
affinity
- The affinity setting for an instance running on a Dedicated Host (default
| host
).
architecture
- The instance architecture (i386
| x86_64
| arm64
).
availability-zone
- The Availability Zone of the instance.
availability-zone-id
- The ID of the Availability Zone of the instance.
block-device-mapping.attach-time
- The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z
.
block-device-mapping.delete-on-termination
- A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name
- The device name specified in the block device mapping (for example, /dev/sdh
or xvdh
).
block-device-mapping.status
- The status for the EBS volume (attaching
| attached
| detaching
| detached
).
block-device-mapping.volume-id
- The volume ID of the EBS volume.
boot-mode
- The boot mode that was specified by the AMI (legacy-bios
| uefi
| uefi-preferred
).
capacity-reservation-id
- The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference
- The instance's Capacity Reservation preference (open
| none
).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id
- The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
- The ARN of the targeted Capacity Reservation group.
client-token
- The idempotency token you provided when you launched the instance.
current-instance-boot-mode
- The boot mode that is used to launch the instance at launch or start (legacy-bios
| uefi
).
dns-name
- The public DNS name of the instance.
ebs-optimized
- A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support
- A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled
- A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured
- A Boolean that indicates whether the instance is enabled for hibernation. A value of true
means that the instance is enabled for hibernation.
host-id
- The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor
- The hypervisor type of the instance (ovm
| xen
). The value xen
is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn
- The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id
- The instance profile associated with the instance. Specified as an ID.
image-id
- The ID of the image used to launch the instance.
instance-id
- The ID of the instance.
instance-lifecycle
- Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot
| scheduled
| capacity-block
).
instance-state-code
- The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the instance (pending
| running
| shutting-down
| terminated
| stopping
| stopped
).
instance-type
- The type of instance (for example, t2.micro
).
instance.group-id
- The ID of the security group for the instance.
instance.group-name
- The name of the security group for the instance.
ip-address
- The public IPv4 address of the instance.
ipv6-address
- The IPv6 address of the instance.
kernel-id
- The kernel ID.
key-name
- The name of the key pair used when the instance was launched.
launch-index
- When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time
- The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z
. You can use a wildcard (*
), for example, 2021-09-29T*
, which matches an entire day.
maintenance-options.auto-recovery
- The current automatic recovery behavior of the instance (disabled
| default
).
metadata-options.http-endpoint
- The status of access to the HTTP metadata endpoint on your instance (enabled
| disabled
)
metadata-options.http-protocol-ipv4
- Indicates whether the IPv4 endpoint is enabled (disabled
| enabled
).
metadata-options.http-protocol-ipv6
- Indicates whether the IPv6 endpoint is enabled (disabled
| enabled
).
metadata-options.http-put-response-hop-limit
- The HTTP metadata request put response hop limit (integer, possible values 1
to 64
)
metadata-options.http-tokens
- The metadata request authorization state (optional
| required
)
metadata-options.instance-metadata-tags
- The status of access to instance tags from the instance metadata (enabled
| disabled
)
metadata-options.state
- The state of the metadata option changes (pending
| applied
).
monitoring-state
- Indicates whether detailed monitoring is enabled (disabled
| enabled
).
network-interface.addresses.association.allocation-id
- The allocation ID.
network-interface.addresses.association.association-id
- The association ID.
network-interface.addresses.association.carrier-ip
- The carrier IP address.
network-interface.addresses.association.customer-owned-ip
- The customer-owned IP address.
network-interface.addresses.association.ip-owner-id
- The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name
- The public DNS name.
network-interface.addresses.association.public-ip
- The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary
- Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name
- The private DNS name.
network-interface.addresses.private-ip-address
- The private IPv4 address associated with the network interface.
network-interface.association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id
- The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip
- The customer-owned IP address.
network-interface.association.customer-owned-ip
- The customer-owned IP address.
network-interface.association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name
- The public DNS name.
network-interface.association.public-ip
- The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time
- The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id
- The ID of the interface attachment.
network-interface.attachment.delete-on-termination
- Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index
- The device index to which the network interface is attached.
network-interface.attachment.instance-id
- The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id
- The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index
- The index of the network card.
network-interface.attachment.status
- The status of the attachment (attaching
| attached
| detaching
| detached
).
network-interface.availability-zone
- The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic
- A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description
- The description of the network interface.
network-interface.group-id
- The ID of a security group associated with the network interface.
network-interface.group-name
- The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix
- The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address
- The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address
- The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6
- A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native
- A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix
- The IPv6 prefix assigned to the network interface.
network-interface.mac-address
- The MAC address of the network interface.
network-interface.network-interface-id
- The ID of the network interface.
network-interface.operator.managed
- A Boolean that indicates whether the instance has a managed network interface.
network-interface.operator.principal
- The principal that manages the network interface. Only valid for instances with managed network interfaces, where managed
is true
.
network-interface.outpost-arn
- The ARN of the Outpost.
network-interface.owner-id
- The ID of the owner of the network interface.
network-interface.private-dns-name
- The private DNS name of the network interface.
network-interface.private-ip-address
- The private IPv4 address.
network-interface.public-dns-name
- The public DNS name.
network-interface.requester-id
- The requester ID for the network interface.
network-interface.requester-managed
- Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status
- The status of the network interface (available
) | in-use
).
network-interface.source-dest-check
- Whether the network interface performs source/destination checking. A value of true
means that checking is enabled, and false
means that checking is disabled. The value must be false
for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id
- The ID of the subnet for the network interface.
network-interface.tag-key
- The key of a tag assigned to the network interface.
network-interface.tag-value
- The value of a tag assigned to the network interface.
network-interface.vpc-id
- The ID of the VPC for the network interface.
network-performance-options.bandwidth-weighting
- Where the performance boost is applied, if applicable. Valid values: default
, vpc-1
, ebs-1
.
operator.managed
- A Boolean that indicates whether this is a managed instance.
operator.principal
- The principal that manages the instance. Only valid for managed instances, where managed
is true
.
outpost-arn
- The Amazon Resource Name (ARN) of the Outpost.
owner-id
- The Amazon Web Services account ID of the instance owner.
placement-group-name
- The name of the placement group for the instance.
placement-partition-number
- The partition in which the instance is located.
platform
- The platform. To list only Windows instances, use windows
.
platform-details
- The platform (Linux/UNIX
| Red Hat BYOL Linux
| Red Hat Enterprise Linux
| Red Hat Enterprise Linux with HA
| Red Hat Enterprise Linux with SQL Server Standard and HA
| Red Hat Enterprise Linux with SQL Server Enterprise and HA
| Red Hat Enterprise Linux with SQL Server Standard
| Red Hat Enterprise Linux with SQL Server Web
| Red Hat Enterprise Linux with SQL Server Enterprise
| SQL Server Enterprise
| SQL Server Standard
| SQL Server Web
| SUSE Linux
| Ubuntu Pro
| Windows
| Windows BYOL
| Windows with SQL Server Enterprise
| Windows with SQL Server Standard
| Windows with SQL Server Web
).
private-dns-name
- The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record
- A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record
- A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type
- The type of hostname (ip-name
| resource-name
).
private-ip-address
- The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address
.
product-code
- The product code associated with the AMI used to launch the instance.
product-code.type
- The type of product code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
reason
- The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id
- The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id
- The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name
- The device name of the root device volume (for example, /dev/sda1
).
root-device-type
- The type of the root device volume (ebs
| instance-store
).
source-dest-check
- Indicates whether the instance performs source/destination checking. A value of true
means that checking is enabled, and false
means that checking is disabled. The value must be false
for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id
- The ID of the Spot Instance request.
state-reason-code
- The reason code for the state change.
state-reason-message
- A message that describes the state change.
subnet-id
- The ID of the subnet for the instance.
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy
- The tenancy of an instance (dedicated
| default
| host
).
tpm-support
- Indicates if the instance is configured for NitroTPM support (v2.0
).
usage-operation
- The usage operation value for the instance (RunInstances
| RunInstances:00g0
| RunInstances:0010
| RunInstances:1010
| RunInstances:1014
| RunInstances:1110
| RunInstances:0014
| RunInstances:0210
| RunInstances:0110
| RunInstances:0100
| RunInstances:0004
| RunInstances:0200
| RunInstances:000g
| RunInstances:0g00
| RunInstances:0002
| RunInstances:0800
| RunInstances:0102
| RunInstances:0006
| RunInstances:0202
).
usage-operation-update-time
- The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z
.
virtualization-type
- The virtualization type of the instance (paravirtual
| hvm
).
vpc-id
- The ID of the VPC that the instance is running in.
The filters.
affinity
- The affinity setting for an instance running on a Dedicated Host (default
| host
).
architecture
- The instance architecture (i386
| x86_64
| arm64
).
availability-zone
- The Availability Zone of the instance.
availability-zone-id
- The ID of the Availability Zone of the instance.
block-device-mapping.attach-time
- The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z
.
block-device-mapping.delete-on-termination
- A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name
- The device name specified in the block device mapping (for example, /dev/sdh
or xvdh
).
block-device-mapping.status
- The status for the EBS volume (attaching
| attached
| detaching
| detached
).
block-device-mapping.volume-id
- The volume ID of the EBS volume.
boot-mode
- The boot mode that was specified by the AMI (legacy-bios
| uefi
| uefi-preferred
).
capacity-reservation-id
- The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference
- The instance's Capacity Reservation preference (open
| none
).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id
- The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
- The ARN of the targeted Capacity Reservation group.
client-token
- The idempotency token you provided when you launched the instance.
current-instance-boot-mode
- The boot mode that is used to launch the instance at launch or start (legacy-bios
| uefi
).
dns-name
- The public DNS name of the instance.
ebs-optimized
- A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support
- A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled
- A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured
- A Boolean that indicates whether the instance is enabled for hibernation. A value of true
means that the instance is enabled for hibernation.
host-id
- The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor
- The hypervisor type of the instance (ovm
| xen
). The value xen
is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn
- The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id
- The instance profile associated with the instance. Specified as an ID.
image-id
- The ID of the image used to launch the instance.
instance-id
- The ID of the instance.
instance-lifecycle
- Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot
| scheduled
| capacity-block
).
instance-state-code
- The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the instance (pending
| running
| shutting-down
| terminated
| stopping
| stopped
).
instance-type
- The type of instance (for example, t2.micro
).
instance.group-id
- The ID of the security group for the instance.
instance.group-name
- The name of the security group for the instance.
ip-address
- The public IPv4 address of the instance.
ipv6-address
- The IPv6 address of the instance.
kernel-id
- The kernel ID.
key-name
- The name of the key pair used when the instance was launched.
launch-index
- When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time
- The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z
. You can use a wildcard (*
), for example, 2021-09-29T*
, which matches an entire day.
maintenance-options.auto-recovery
- The current automatic recovery behavior of the instance (disabled
| default
).
metadata-options.http-endpoint
- The status of access to the HTTP metadata endpoint on your instance (enabled
| disabled
)
metadata-options.http-protocol-ipv4
- Indicates whether the IPv4 endpoint is enabled (disabled
| enabled
).
metadata-options.http-protocol-ipv6
- Indicates whether the IPv6 endpoint is enabled (disabled
| enabled
).
metadata-options.http-put-response-hop-limit
- The HTTP metadata request put response hop limit (integer, possible values 1
to 64
)
metadata-options.http-tokens
- The metadata request authorization state (optional
| required
)
metadata-options.instance-metadata-tags
- The status of access to instance tags from the instance metadata (enabled
| disabled
)
metadata-options.state
- The state of the metadata option changes (pending
| applied
).
monitoring-state
- Indicates whether detailed monitoring is enabled (disabled
| enabled
).
network-interface.addresses.association.allocation-id
- The allocation ID.
network-interface.addresses.association.association-id
- The association ID.
network-interface.addresses.association.carrier-ip
- The carrier IP address.
network-interface.addresses.association.customer-owned-ip
- The customer-owned IP address.
network-interface.addresses.association.ip-owner-id
- The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name
- The public DNS name.
network-interface.addresses.association.public-ip
- The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary
- Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name
- The private DNS name.
network-interface.addresses.private-ip-address
- The private IPv4 address associated with the network interface.
network-interface.association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id
- The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip
- The customer-owned IP address.
network-interface.association.customer-owned-ip
- The customer-owned IP address.
network-interface.association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name
- The public DNS name.
network-interface.association.public-ip
- The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time
- The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id
- The ID of the interface attachment.
network-interface.attachment.delete-on-termination
- Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index
- The device index to which the network interface is attached.
network-interface.attachment.instance-id
- The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id
- The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index
- The index of the network card.
network-interface.attachment.status
- The status of the attachment (attaching
| attached
| detaching
| detached
).
network-interface.availability-zone
- The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic
- A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description
- The description of the network interface.
network-interface.group-id
- The ID of a security group associated with the network interface.
network-interface.group-name
- The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix
- The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address
- The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address
- The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6
- A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native
- A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix
- The IPv6 prefix assigned to the network interface.
network-interface.mac-address
- The MAC address of the network interface.
network-interface.network-interface-id
- The ID of the network interface.
network-interface.operator.managed
- A Boolean that indicates whether the instance has a managed network interface.
network-interface.operator.principal
- The principal that manages the network interface. Only valid for instances with managed network interfaces, where managed
is true
.
network-interface.outpost-arn
- The ARN of the Outpost.
network-interface.owner-id
- The ID of the owner of the network interface.
network-interface.private-dns-name
- The private DNS name of the network interface.
network-interface.private-ip-address
- The private IPv4 address.
network-interface.public-dns-name
- The public DNS name.
network-interface.requester-id
- The requester ID for the network interface.
network-interface.requester-managed
- Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status
- The status of the network interface (available
) | in-use
).
network-interface.source-dest-check
- Whether the network interface performs source/destination checking. A value of true
means that checking is enabled, and false
means that checking is disabled. The value must be false
for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id
- The ID of the subnet for the network interface.
network-interface.tag-key
- The key of a tag assigned to the network interface.
network-interface.tag-value
- The value of a tag assigned to the network interface.
network-interface.vpc-id
- The ID of the VPC for the network interface.
network-performance-options.bandwidth-weighting
- Where the performance boost is applied, if applicable. Valid values: default
, vpc-1
, ebs-1
.
operator.managed
- A Boolean that indicates whether this is a managed instance.
operator.principal
- The principal that manages the instance. Only valid for managed instances, where managed
is true
.
outpost-arn
- The Amazon Resource Name (ARN) of the Outpost.
owner-id
- The Amazon Web Services account ID of the instance owner.
placement-group-name
- The name of the placement group for the instance.
placement-partition-number
- The partition in which the instance is located.
platform
- The platform. To list only Windows instances, use windows
.
platform-details
- The platform (Linux/UNIX
| Red Hat BYOL Linux
| Red Hat Enterprise Linux
| Red Hat Enterprise Linux with HA
| Red Hat Enterprise Linux with High Availability
| Red Hat Enterprise Linux with SQL Server Standard and HA
| Red Hat Enterprise Linux with SQL Server Enterprise and HA
| Red Hat Enterprise Linux with SQL Server Standard
| Red Hat Enterprise Linux with SQL Server Web
| Red Hat Enterprise Linux with SQL Server Enterprise
| SQL Server Enterprise
| SQL Server Standard
| SQL Server Web
| SUSE Linux
| Ubuntu Pro
| Windows
| Windows BYOL
| Windows with SQL Server Enterprise
| Windows with SQL Server Standard
| Windows with SQL Server Web
).
private-dns-name
- The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record
- A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record
- A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type
- The type of hostname (ip-name
| resource-name
).
private-ip-address
- The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address
.
product-code
- The product code associated with the AMI used to launch the instance.
product-code.type
- The type of product code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
reason
- The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id
- The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id
- The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name
- The device name of the root device volume (for example, /dev/sda1
).
root-device-type
- The type of the root device volume (ebs
| instance-store
).
source-dest-check
- Indicates whether the instance performs source/destination checking. A value of true
means that checking is enabled, and false
means that checking is disabled. The value must be false
for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id
- The ID of the Spot Instance request.
state-reason-code
- The reason code for the state change.
state-reason-message
- A message that describes the state change.
subnet-id
- The ID of the subnet for the instance.
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy
- The tenancy of an instance (dedicated
| default
| host
).
tpm-support
- Indicates if the instance is configured for NitroTPM support (v2.0
).
usage-operation
- The usage operation value for the instance (RunInstances
| RunInstances:00g0
| RunInstances:0010
| RunInstances:1010
| RunInstances:1014
| RunInstances:1110
| RunInstances:0014
| RunInstances:0210
| RunInstances:0110
| RunInstances:0100
| RunInstances:0004
| RunInstances:0200
| RunInstances:000g
| RunInstances:0g00
| RunInstances:0002
| RunInstances:0800
| RunInstances:0102
| RunInstances:0006
| RunInstances:0202
).
usage-operation-update-time
- The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z
.
virtualization-type
- The virtualization type of the instance (paravirtual
| hvm
).
vpc-id
- The ID of the VPC that the instance is running in.
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3
: 3,000 - 16,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS.
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3
: 3,000 - 80,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported sizes for each volume type:
gp2
and gp3
: 1 - 16,384 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported sizes for each volume type:
gp2
: 1 - 16,384 GiB
gp3
: 1 - 65,536 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3
volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
", + "documentation":"The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3
volumes.
Valid Range: Minimum value of 125. Maximum value of 2,000.
", "locationName":"throughput" }, "OutpostArn":{ @@ -33900,11 +33942,11 @@ }, "Iops":{ "shape":"Integer", - "documentation":"The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3
: 3,000 - 16,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS.
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3
: 3,000 - 80,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS.
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3
volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
" + "documentation":"The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3
volumes.
Valid Range: Minimum value of 125. Maximum value of 2,000.
" }, "KmsKeyId":{ "shape":"KmsKeyId", @@ -33916,7 +33958,7 @@ }, "VolumeSize":{ "shape":"Integer", - "documentation":"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported sizes for each volume type:
gp2
and gp3
: 1 - 16,384 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported sizes for each volume type:
gp2
: 1 - 16,384 GiB
gp3
: 1 - 65,536 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
A list of AMI providers whose AMIs are discoverable and useable in the account. Up to a total of 200 values can be specified.
Possible values:
amazon
: Allow AMIs created by Amazon Web Services.
aws-marketplace
: Allow AMIs created by verified providers in the Amazon Web Services Marketplace.
aws-backup-vault
: Allow AMIs created by Amazon Web Services Backup.
12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified.
none
: Allow AMIs created by your own account only.
The image providers whose images are allowed.
Possible values:
amazon
: Allow AMIs created by Amazon or verified providers.
aws-marketplace
: Allow AMIs created by verified providers in the Amazon Web Services Marketplace.
aws-backup-vault
: Allow AMIs created by Amazon Web Services Backup.
12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified.
none
: Allow AMIs created by your own account only.
Maximum: 200 values
", "locationName":"imageProviderSet" + }, + "MarketplaceProductCodes":{ + "shape":"MarketplaceProductCodeList", + "documentation":"The Amazon Web Services Marketplace product codes for allowed images.
Length: 1-25 characters
Valid characters: Letters (A–Z, a–z
) and numbers (0–9
)
Maximum: 50 values
", + "locationName":"marketplaceProductCodeSet" + }, + "ImageNames":{ + "shape":"ImageNameList", + "documentation":"The names of allowed images. Names can include wildcards (?
and *
).
Length: 1–128 characters. With ?
, the minimum is 3 characters.
Valid characters:
Letters: A–Z, a–z
Numbers: 0–9
Special characters: ( ) [ ] . / - ' @ _ * ?
Spaces
Maximum: 50 values
", + "locationName":"imageNameSet" + }, + "DeprecationTimeCondition":{ + "shape":"DeprecationTimeCondition", + "documentation":"The maximum period since deprecation for allowed images.
", + "locationName":"deprecationTimeCondition" + }, + "CreationDateCondition":{ + "shape":"CreationDateCondition", + "documentation":"The maximum age for allowed images.
", + "locationName":"creationDateCondition" } }, - "documentation":"The list of criteria that are evaluated to determine whch AMIs are discoverable and usable in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be specified are AMI providers.
Up to 10 imageCriteria
objects can be specified, and up to a total of 200 values for all imageProviders
. For more information, see JSON configuration for the Allowed AMIs criteria in the Amazon EC2 User Guide.
The criteria that are evaluated to determine which AMIs are discoverable and usable in your account for the specified Amazon Web Services Region.
For more information, see How Allowed AMIs works in the Amazon EC2 User Guide.
" }, "ImageCriterionList":{ "type":"list", @@ -37913,11 +37975,29 @@ "members":{ "ImageProviders":{ "shape":"ImageProviderRequestList", - "documentation":"A list of image providers whose AMIs are discoverable and useable in the account. Up to a total of 200 values can be specified.
Possible values:
amazon
: Allow AMIs created by Amazon Web Services.
aws-marketplace
: Allow AMIs created by verified providers in the Amazon Web Services Marketplace.
aws-backup-vault
: Allow AMIs created by Amazon Web Services Backup.
12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified.
none
: Allow AMIs created by your own account only. When none
is specified, no other values can be specified.
The image providers whose images are allowed.
Possible values:
amazon
: Allow AMIs created by Amazon or verified providers.
aws-marketplace
: Allow AMIs created by verified providers in the Amazon Web Services Marketplace.
aws-backup-vault
: Allow AMIs created by Amazon Web Services Backup.
12-digit account ID: Allow AMIs created by the specified accounts. One or more account IDs can be specified.
none
: Allow AMIs created by your own account only. When none
is specified, no other values can be specified.
Maximum: 200 values
", "locationName":"ImageProvider" + }, + "MarketplaceProductCodes":{ + "shape":"MarketplaceProductCodeRequestList", + "documentation":"The Amazon Web Services Marketplace product codes for allowed images.
Length: 1-25 characters
Valid characters: Letters (A–Z, a–z
) and numbers (0–9
)
Maximum: 50 values
", + "locationName":"MarketplaceProductCode" + }, + "ImageNames":{ + "shape":"ImageNameRequestList", + "documentation":"The names of allowed images. Names can include wildcards (?
and *
).
Length: 1–128 characters. With ?
, the minimum is 3 characters.
Valid characters:
Letters: A–Z, a–z
Numbers: 0–9
Special characters: ( ) [ ] . / - ' @ _ * ?
Spaces
Maximum: 50 values
", + "locationName":"ImageName" + }, + "DeprecationTimeCondition":{ + "shape":"DeprecationTimeConditionRequest", + "documentation":"The maximum period since deprecation for allowed images.
" + }, + "CreationDateCondition":{ + "shape":"CreationDateConditionRequest", + "documentation":"The maximum age for allowed images.
" } }, - "documentation":"The list of criteria that are evaluated to determine whch AMIs are discoverable and usable in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be specified are AMI providers.
Up to 10 imageCriteria
objects can be specified, and up to a total of 200 values for all imageProviders
. For more information, see JSON configuration for the Allowed AMIs criteria in the Amazon EC2 User Guide.
The criteria that are evaluated to determine which AMIs are discoverable and usable in your account for the specified Amazon Web Services Region.
The ImageCriteria
can include up to:
10 ImageCriterion
Each ImageCriterion
can include up to:
200 values for ImageProviders
50 values for ImageNames
50 values for MarketplaceProductCodes
For more information, see How Allowed AMIs works in the Amazon EC2 User Guide.
" }, "ImageCriterionRequestList":{ "type":"list", @@ -38036,6 +38116,22 @@ }, "documentation":"Information about the AMI.
" }, + "ImageName":{"type":"string"}, + "ImageNameList":{ + "type":"list", + "member":{ + "shape":"ImageName", + "locationName":"item" + } + }, + "ImageNameRequest":{"type":"string"}, + "ImageNameRequestList":{ + "type":"list", + "member":{ + "shape":"ImageNameRequest", + "locationName":"item" + } + }, "ImageProvider":{"type":"string"}, "ImageProviderList":{ "type":"list", @@ -42529,7 +42625,21 @@ "i8ge.24xlarge", "i8ge.48xlarge", "i8ge.metal-24xl", - "i8ge.metal-48xl" + "i8ge.metal-48xl", + "mac-m4.metal", + "mac-m4pro.metal", + "r8gn.medium", + "r8gn.large", + "r8gn.xlarge", + "r8gn.2xlarge", + "r8gn.4xlarge", + "r8gn.8xlarge", + "r8gn.12xlarge", + "r8gn.16xlarge", + "r8gn.24xlarge", + "r8gn.48xlarge", + "r8gn.metal-24xl", + "r8gn.metal-48xl" ] }, "InstanceTypeHypervisor":{ @@ -45313,7 +45423,7 @@ }, "Iops":{ "shape":"Integer", - "documentation":"The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3
: 3,000 - 16,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is supported for io1
, io2
, and gp3
volumes only.
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3
: 3,000 - 80,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is supported for io1
, io2
, and gp3
volumes only.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
gp2
and gp3
: 1 - 16,384 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
gp2
: 1 - 16,384 GiB
gp3
: 1 - 65,536 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
The throughput to provision for a gp3
volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
" + "documentation":"The throughput to provision for a gp3
volume, with a maximum of 2,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 2,000.
" }, "VolumeInitializationRate":{ "shape":"Integer", @@ -45352,7 +45462,7 @@ }, "Count":{ "shape":"LaunchTemplateElasticInferenceAcceleratorCount", - "documentation":"The number of elastic inference accelerators to attach to the instance.
Default: 1
" + "documentation":"The number of elastic inference accelerators to attach to the instance.
" } }, "documentation":"Amazon Elastic Inference is no longer available.
Describes an elastic inference accelerator.
" @@ -45373,12 +45483,12 @@ "members":{ "Type":{ "shape":"String", - "documentation":"The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
", + "documentation":"The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
", "locationName":"type" }, "Count":{ "shape":"Integer", - "documentation":"The number of elastic inference accelerators to attach to the instance.
Default: 1
", + "documentation":"The number of elastic inference accelerators to attach to the instance.
", "locationName":"count" } }, @@ -45589,7 +45699,7 @@ }, "HttpPutResponseHopLimit":{ "shape":"Integer", - "documentation":"The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
", + "documentation":"The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Possible values: Integers from 1 to 64
", "locationName":"httpPutResponseHopLimit" }, "HttpEndpoint":{ @@ -47556,6 +47666,22 @@ "capacity-block" ] }, + "MarketplaceProductCode":{"type":"string"}, + "MarketplaceProductCodeList":{ + "type":"list", + "member":{ + "shape":"MarketplaceProductCode", + "locationName":"item" + } + }, + "MarketplaceProductCodeRequest":{"type":"string"}, + "MarketplaceProductCodeRequestList":{ + "type":"list", + "member":{ + "shape":"MarketplaceProductCodeRequest", + "locationName":"item" + } + }, "MaxIpv4AddrPerInterface":{"type":"integer"}, "MaxIpv6AddrPerInterface":{"type":"integer"}, "MaxNetworkInterfaces":{"type":"integer"}, @@ -47566,6 +47692,16 @@ "min":0 }, "MaximumBandwidthInMbps":{"type":"integer"}, + "MaximumDaysSinceCreatedValue":{ + "type":"integer", + "max":2147483647, + "min":0 + }, + "MaximumDaysSinceDeprecatedValue":{ + "type":"integer", + "max":2147483647, + "min":0 + }, "MaximumEbsAttachments":{"type":"integer"}, "MaximumEfaInterfaces":{"type":"integer"}, "MaximumEnaQueueCount":{"type":"integer"}, @@ -50440,7 +50576,7 @@ }, "Size":{ "shape":"Integer", - "documentation":"The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
gp2
and gp3
: 1 - 16,384 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
Default: The existing size is retained.
" + "documentation":"The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
gp2
: 1 - 16,384 GiB
gp3
: 1 - 65,536 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
Default: The existing size is retained.
" }, "VolumeType":{ "shape":"VolumeType", @@ -50448,11 +50584,11 @@ }, "Iops":{ "shape":"Integer", - "documentation":"The target IOPS rate of the volume. This parameter is valid only for gp3
, io1
, and io2
volumes.
The following are the supported values for each volume type:
gp3
: 3,000 - 16,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1
, io2
, or gp3
, the default is 3,000.
The target IOPS rate of the volume. This parameter is valid only for gp3
, io1
, and io2
volumes.
The following are the supported values for each volume type:
gp3
: 3,000 - 80,000 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1
, io2
, or gp3
, the default is 3,000.
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3
volumes. The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3
. Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
" + "documentation":"The target throughput of the volume, in MiB/s. This parameter is valid only for gp3
volumes. The maximum value is 2,000.
Default: The existing value is retained if the source and target volume type is gp3
. Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 2,000.
" }, "MultiAttachEnabled":{ "shape":"Boolean", @@ -58507,7 +58643,7 @@ }, "Origin":{ "shape":"RouteOrigin", - "documentation":"Describes how the route was created.
CreateRouteTable
- The route was automatically created when the route table was created.
CreateRoute
- The route was manually added to the route table.
EnableVgwRoutePropagation
- The route was propagated by route propagation.
Describes how the route was created.
CreateRouteTable
- The route was automatically created when the route table was created.
CreateRoute
- The route was manually added to the route table.
EnableVgwRoutePropagation
- The route was propagated by route propagation.
Advertisement
- The route was created dynamically by Amazon VPC Route Server.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, only specify the containerPort
. The hostPort
can be left blank or it must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the the docker container create command and the --publish
option to docker run. If the network mode of a task definition is set to none
, then you can't specify port mappings. If the network mode of a task definition is set to host
, then host ports must either be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, only specify the containerPort
. The hostPort
can be left blank or it must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the docker container create command and the --publish
option to docker run. If the network mode of a task definition is set to none
, then you can't specify port mappings. If the network mode of a task definition is set to host
, then host ports must either be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
Indicates whether to use Availability Zone rebalancing for the service.
For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .
The default behavior of AvailabilityZoneRebalancing
differs between create and update requests:
For create service requests, when when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults the value to to ENABLED
.
For update service requests, when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing
value. If the service never had an AvailabilityZoneRebalancing
value set, Amazon ECS treats this as DISABLED
.
Indicates whether to use Availability Zone rebalancing for the service.
For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .
The default behavior of AvailabilityZoneRebalancing
differs between create and update requests:
For create service requests, when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults the value to ENABLED
.
For update service requests, when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing
value. If the service never had an AvailabilityZoneRebalancing
value set, Amazon ECS treats this as DISABLED
.
The lifecycle stages at which to run the hook. Choose from these valid values:
RECONCILE_SERVICE
The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.
You can use a lifecycle hook for this stage.
PRE_SCALE_UP
The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.
You can use a lifecycle hook for this stage.
POST_SCALE_UP
The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.
You can use a lifecycle hook for this stage.
TEST_TRAFFIC_SHIFT
The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.
You can use a lifecycle hook for this stage.
POST_TEST_TRAFFIC_SHIFT
The test traffic shift is complete. The green service revision handles 100% of the test traffic.
You can use a lifecycle hook for this stage.
PRODUCTION_TRAFFIC_SHIFT
Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.
You can use a lifecycle hook for this stage.
POST_PRODUCTION_TRAFFIC_SHIFT
The production traffic shift is complete.
You can use a lifecycle hook for this stage.
You must provide this parameter when configuring a deployment lifecycle hook.
" + }, + "hookDetails":{ + "shape":"HookDetails", + "documentation":"Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).
" } }, "documentation":"A deployment lifecycle hook runs custom logic at specific stages of the deployment process. Currently, you can use Lambda functions as hook targets.
For more information, see Lifecycle hooks for Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide.
" @@ -3609,6 +3613,11 @@ "UNKNOWN" ] }, + "HookDetails":{ + "type":"structure", + "members":{}, + "document":true + }, "HostEntry":{ "type":"structure", "required":[ @@ -5205,7 +5214,7 @@ }, "volumeConfigurations":{ "shape":"TaskVolumeConfigurations", - "documentation":"The details of the volume that was configuredAtLaunch
. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name
of the volume must match the name
from the task definition.
The details of the volume that was configuredAtLaunch
. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name
of the volume must match the name
from the task definition.
Indicates whether to use Availability Zone rebalancing for the service.
For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .
The default behavior of AvailabilityZoneRebalancing
differs between create and update requests:
For create service requests, when when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults the value to to ENABLED
.
For update service requests, when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing
value. If the service never had an AvailabilityZoneRebalancing
value set, Amazon ECS treats this as DISABLED
.
Indicates whether to use Availability Zone rebalancing for the service.
For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .
The default behavior of AvailabilityZoneRebalancing
differs between create and update requests:
For create service requests, when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults the value to ENABLED
.
For update service requests, when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing
value. If the service never had an AvailabilityZoneRebalancing
value set, Amazon ECS treats this as DISABLED
.
Details on a service within a cluster.
" @@ -7437,7 +7446,7 @@ }, "availabilityZoneRebalancing":{ "shape":"AvailabilityZoneRebalancing", - "documentation":"Indicates whether to use Availability Zone rebalancing for the service.
For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .
The default behavior of AvailabilityZoneRebalancing
differs between create and update requests:
For create service requests, when when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults the value to to ENABLED
.
For update service requests, when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing
value. If the service never had an AvailabilityZoneRebalancing
value set, Amazon ECS treats this as DISABLED
.
This parameter doesn't trigger a new service deployment.
" + "documentation":"Indicates whether to use Availability Zone rebalancing for the service.
For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .
The default behavior of AvailabilityZoneRebalancing
differs between create and update requests:
For create service requests, when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults the value to ENABLED
.
For update service requests, when no value is specified for AvailabilityZoneRebalancing
, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing
value. If the service never had an AvailabilityZoneRebalancing
value set, Amazon ECS treats this as DISABLED
.
This parameter doesn't trigger a new service deployment.
" }, "networkConfiguration":{ "shape":"NetworkConfiguration", diff --git a/services/efs/pom.xml b/services/efs/pom.xml index fa93703aa1b2..33635531be76 100644 --- a/services/efs/pom.xml +++ b/services/efs/pom.xml @@ -21,7 +21,7 @@Specifies whether to enable node auto repair for the node group. Node auto repair is disabled by default.
" + }, + "maxUnhealthyNodeThresholdCount":{ + "shape":"NonZeroInteger", + "documentation":"Specify a count threshold of unhealthy nodes, above which node auto repair actions will stop. When using this, you cannot also set maxUnhealthyNodeThresholdPercentage
at the same time.
Specify a percentage threshold of unhealthy nodes, above which node auto repair actions will stop. When using this, you cannot also set maxUnhealthyNodeThresholdCount
at the same time.
Specify the maximum number of nodes that can be repaired concurrently or in parallel, expressed as a count of unhealthy nodes. This gives you finer-grained control over the pace of node replacements. When using this, you cannot also set maxParallelNodesRepairedPercentage
at the same time.
Specify the maximum number of nodes that can be repaired concurrently or in parallel, expressed as a percentage of unhealthy nodes. This gives you finer-grained control over the pace of node replacements. When using this, you cannot also set maxParallelNodesRepairedCount
at the same time.
Specify granular overrides for specific repair actions. These overrides control the repair action and the repair delay time before a node is considered eligible for repair. If you use this, you must specify all the values.
" } }, "documentation":"The node auto repair configuration for the node group.
" }, + "NodeRepairConfigOverrides":{ + "type":"structure", + "members":{ + "nodeMonitoringCondition":{ + "shape":"String", + "documentation":"Specify an unhealthy condition reported by the node monitoring agent that this override would apply to.
" + }, + "nodeUnhealthyReason":{ + "shape":"String", + "documentation":"Specify a reason reported by the node monitoring agent that this override would apply to.
" + }, + "minRepairWaitTimeMins":{ + "shape":"NonZeroInteger", + "documentation":"Specify the minimum time in minutes to wait before attempting to repair a node with this specific nodeMonitoringCondition
and nodeUnhealthyReason
.
Specify the repair action to take for nodes when all of the specified conditions are met.
" + } + }, + "documentation":"Specify granular overrides for specific repair actions. These overrides control the repair action and the repair delay time before a node is considered eligible for repair. If you use this, you must specify all the values.
" + }, + "NodeRepairConfigOverridesList":{ + "type":"list", + "member":{"shape":"NodeRepairConfigOverrides"} + }, "Nodegroup":{ "type":"structure", "members":{ @@ -5294,6 +5340,14 @@ "member":{"shape":"RemotePodNetwork"}, "max":1 }, + "RepairAction":{ + "type":"string", + "enum":[ + "Replace", + "Reboot", + "NoAction" + ] + }, "ResolveConflicts":{ "type":"string", "enum":[ @@ -6061,7 +6115,8 @@ "StorageConfig", "KubernetesNetworkConfig", "RemoteNetworkConfig", - "DeletionProtection" + "DeletionProtection", + "NodeRepairConfig" ] }, "UpdateParams":{ diff --git a/services/eksauth/pom.xml b/services/eksauth/pom.xml index 719c692ca496..169470d6e0a4 100644 --- a/services/eksauth/pom.xml +++ b/services/eksauth/pom.xml @@ -17,7 +17,7 @@The name of the security configuration.
" }, + "containerProvider":{ + "shape":"ContainerProvider", + "documentation":"The container provider associated with the security configuration.
" + }, "securityConfigurationData":{ "shape":"SecurityConfigurationData", "documentation":"Security configuration input for the request.
" @@ -1012,6 +1016,10 @@ "namespace":{ "shape":"KubernetesNamespace", "documentation":"The namespaces of the Amazon EKS cluster.
" + }, + "nodeLabel":{ + "shape":"ResourceNameString", + "documentation":"The nodeLabel of the nodes where the resources of this virtual cluster can get scheduled. It requires relevant scaling and policy engine addons.
" } }, "documentation":"The information about the Amazon EKS cluster.
" diff --git a/services/emrserverless/pom.xml b/services/emrserverless/pom.xml index b0f49c474e96..7a965e7da491 100644 --- a/services/emrserverless/pom.xml +++ b/services/emrserverless/pom.xml @@ -21,7 +21,7 @@Creates an IdMappingWorkflow
object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow
must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.
Creates an IdMappingWorkflow
object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow
must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.
Incremental processing is not supported for ID mapping workflows.
Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow
.
For workflows where resolutionType
is ML_MATCHING, incremental processing is not supported.
Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow
.
For workflows where resolutionType
is ML_MATCHING
or PROVIDER
, incremental processing is not supported.
Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow or ML matching workflow.
You can call this API as a dry run of an incremental load on the rule-based matching workflow.
" + "documentation":"Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow.
You can call this API as a dry run of an incremental load on the rule-based matching workflow.
" }, "GetMatchingJob":{ "name":"GetMatchingJob", @@ -647,7 +647,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Updates an existing IdMappingWorkflow
. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT
request instead of a POST
request, and the IdMappingWorkflow
must already exist for the method to succeed.
Updates an existing IdMappingWorkflow
. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT
request instead of a POST
request, and the IdMappingWorkflow
must already exist for the method to succeed.
Incremental processing is not supported for ID mapping workflows.
Updates an existing matching workflow. The workflow must already exist for this operation to succeed.
For workflows where resolutionType
is ML_MATCHING, incremental processing is not supported.
Updates an existing matching workflow. The workflow must already exist for this operation to succeed.
For workflows where resolutionType
is ML_MATCHING
or PROVIDER
, incremental processing is not supported.
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.
", + "documentation":"The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.
", "error":{ "httpStatusCode":400, "senderFault":true @@ -906,6 +906,10 @@ "shape":"IdMappingTechniques", "documentation":"An object which defines the ID mapping technique and any additional configurations.
" }, + "incrementalRunConfig":{ + "shape":"IdMappingIncrementalRunConfig", + "documentation":"The incremental run configuration for the ID mapping workflow.
" + }, "roleArn":{ "shape":"IdMappingRoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" @@ -949,6 +953,10 @@ "shape":"IdMappingTechniques", "documentation":"An object which defines the ID mapping technique and any additional configurations.
" }, + "incrementalRunConfig":{ + "shape":"IdMappingIncrementalRunConfig", + "documentation":"The incremental run configuration for the ID mapping workflow.
" + }, "roleArn":{ "shape":"IdMappingRoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" @@ -1076,7 +1084,7 @@ }, "incrementalRunConfig":{ "shape":"IncrementalRunConfig", - "documentation":"Optional. An object that defines the incremental run type. This object contains only the incrementalRunType
field, which appears as \"Automatic\" in the console.
For workflows where resolutionType
is ML_MATCHING
, incremental processing is not supported.
Optional. An object that defines the incremental run type. This object contains only the incrementalRunType
field, which appears as \"Automatic\" in the console.
For workflows where resolutionType
is ML_MATCHING
or PROVIDER
, incremental processing is not supported.
The unique ID that could not be deleted.
" + "documentation":"The unique ID that couldn't be deleted.
" }, "errorType":{ "shape":"DeleteUniqueIdErrorType", - "documentation":"The error type for the batch delete unique ID operation.
" + "documentation":"The error type for the delete unique ID operation.
The SERVICE_ERROR
value indicates that an internal service-side problem occurred during the deletion operation.
The VALIDATION_ERROR
value indicates that the deletion operation couldn't complete because of invalid input parameters or data.
The Delete Unique Id error.
" + "documentation":"The error information provided when the delete unique ID operation doesn't complete.
" }, "DeleteUniqueIdErrorType":{ "type":"string", @@ -1438,7 +1446,7 @@ ], "members":{ "inputSourceARN":{ - "shape":"FailedRecordInputSourceARNString", + "shape":"InputSourceARN", "documentation":"The input source ARN of the record that didn't generate a Match ID.
" }, "uniqueId":{ @@ -1452,10 +1460,6 @@ }, "documentation":"The record that didn't generate a Match ID.
" }, - "FailedRecordInputSourceARNString":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})" - }, "FailedRecordsList":{ "type":"list", "member":{"shape":"FailedRecord"} @@ -1559,6 +1563,10 @@ "outputSourceConfig":{ "shape":"IdMappingJobOutputSourceConfig", "documentation":"A list of OutputSource
objects.
The job type of the ID mapping job.
A value of INCREMENTAL
indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an incrementalRunConfig
.
A value of BATCH
indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn't created with an incrementalRunConfig
.
A value of DELETE_ONLY
indicates that only deletion requests from BatchDeleteUniqueIds
were processed.
The timestamp of when the workflow was last updated.
" }, + "incrementalRunConfig":{ + "shape":"IdMappingIncrementalRunConfig", + "documentation":"The incremental run configuration for the ID mapping workflow.
" + }, "roleArn":{ "shape":"IdMappingRoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
" @@ -2041,6 +2053,20 @@ "min":1, "pattern":"[a-zA-Z_0-9-+=/,]*" }, + "IdMappingIncrementalRunConfig":{ + "type":"structure", + "members":{ + "incrementalRunType":{ + "shape":"IdMappingIncrementalRunType", + "documentation":"The incremental run type for an ID mapping workflow.
It takes only one value: ON_DEMAND
. This setting runs the ID mapping workflow when it's manually triggered through the StartIdMappingJob
API.
Incremental run configuration for an ID mapping workflow.
" + }, + "IdMappingIncrementalRunType":{ + "type":"string", + "enum":["ON_DEMAND"] + }, "IdMappingJobMetrics":{ "type":"structure", "members":{ @@ -2056,6 +2082,10 @@ "shape":"Integer", "documentation":"The total number of records that did not get processed.
" }, + "deleteRecordsProcessed":{ + "shape":"Integer", + "documentation":"The number of records processed that were marked for deletion in the input file using the DELETE schema mapping field. These are the records to be removed from the ID mapping table.
" + }, "totalMappedRecords":{ "shape":"Integer", "documentation":"The total number of records that were mapped.
" @@ -2070,7 +2100,35 @@ }, "uniqueRecordsLoaded":{ "shape":"Integer", - "documentation":"The number of records remaining after loading and aggregating duplicate records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the same value in this field are considered duplicates. For example, if you specified \"customer_id\" as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric.
" + "documentation":"The number of de-duplicated processed records across all runs, excluding deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if you specified \"customer_id\" as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric.
" + }, + "newMappedRecords":{ + "shape":"Integer", + "documentation":"The number of new mapped records.
" + }, + "newMappedSourceRecords":{ + "shape":"Integer", + "documentation":"The number of new source records mapped.
" + }, + "newMappedTargetRecords":{ + "shape":"Integer", + "documentation":"The number of new mapped target records.
" + }, + "newUniqueRecordsLoaded":{ + "shape":"Integer", + "documentation":"The number of new unique records processed in the current job run, after removing duplicates. This metric excludes deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if your current run processes five new records with the same UNIQUE_ID value, they would count as one new unique record in this metric.
" + }, + "mappedRecordsRemoved":{ + "shape":"Integer", + "documentation":"The number of mapped records removed.
" + }, + "mappedSourceRecordsRemoved":{ + "shape":"Integer", + "documentation":"The number of source records removed due to ID mapping.
" + }, + "mappedTargetRecordsRemoved":{ + "shape":"Integer", + "documentation":"The number of mapped target records removed.
" } }, "documentation":"An object that contains metrics about an ID mapping job, including counts of input records, processed records, and mapped records between source and target identifiers.
" @@ -2177,7 +2235,7 @@ "required":["inputSourceARN"], "members":{ "inputSourceARN":{ - "shape":"IdMappingWorkflowInputSourceInputSourceARNString", + "shape":"InputSourceARN", "documentation":"An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
" }, "schemaName":{ @@ -2197,10 +2255,6 @@ "max":20, "min":1 }, - "IdMappingWorkflowInputSourceInputSourceARNString":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})" - }, "IdMappingWorkflowList":{ "type":"list", "member":{"shape":"IdMappingWorkflowSummary"} @@ -2316,7 +2370,7 @@ "required":["inputSourceARN"], "members":{ "inputSourceARN":{ - "shape":"IdNamespaceInputSourceInputSourceARNString", + "shape":"InputSourceARN", "documentation":"An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
" }, "schemaName":{ @@ -2332,10 +2386,6 @@ "max":20, "min":0 }, - "IdNamespaceInputSourceInputSourceARNString":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})" - }, "IdNamespaceList":{ "type":"list", "member":{"shape":"IdNamespaceSummary"} @@ -2393,10 +2443,10 @@ "members":{ "incrementalRunType":{ "shape":"IncrementalRunType", - "documentation":"The type of incremental run. The only valid value is IMMEDIATE
. This appears as \"Automatic\" in the console.
For workflows where resolutionType
is ML_MATCHING
, incremental processing is not supported.
The type of incremental run. The only valid value is IMMEDIATE
. This appears as \"Automatic\" in the console.
For workflows where resolutionType
is ML_MATCHING
or PROVIDER
, incremental processing is not supported.
Optional. An object that defines the incremental run type. This object contains only the incrementalRunType
field, which appears as \"Automatic\" in the console.
For workflows where resolutionType
is ML_MATCHING
, incremental processing is not supported.
Optional. An object that defines the incremental run type. This object contains only the incrementalRunType
field, which appears as \"Automatic\" in the console.
For workflows where resolutionType
is ML_MATCHING
or PROVIDER
, incremental processing is not supported.
An Glue table Amazon Resource Name (ARN) for the input source table.
" }, "schemaName":{ @@ -2424,16 +2474,16 @@ }, "documentation":"An object containing inputSourceARN
, schemaName
, and applyNormalization
.
The total number of records that did not get processed.
" }, + "deleteRecordsProcessed":{ + "shape":"Integer", + "documentation":"The number of records processed that were marked for deletion (DELETE
= True) in the input file. This metric tracks records flagged for removal during the job execution.
The total number of matchID
s generated.
An object containing the jobId
, status
, startTime
, and endTime
of a job.
The input source ARN of the matched record.
" }, "recordId":{ @@ -2900,10 +2962,6 @@ }, "documentation":"The matched record.
" }, - "MatchedRecordInputSourceARNString":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})" - }, "MatchedRecordsList":{ "type":"list", "member":{"shape":"MatchedRecord"} @@ -3305,7 +3363,7 @@ ], "members":{ "inputSourceARN":{ - "shape":"RecordInputSourceARNString", + "shape":"InputSourceARN", "documentation":"The input source ARN of the record.
" }, "uniqueId":{ @@ -3353,10 +3411,6 @@ "min":0, "pattern":"[a-zA-Z_0-9-./@ ()+\\t]*" }, - "RecordInputSourceARNString":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})" - }, "RecordMatchingModel":{ "type":"string", "enum":[ @@ -3378,7 +3432,7 @@ "members":{ "resolutionType":{ "shape":"ResolutionType", - "documentation":"The type of matching. There are three types of matching: RULE_MATCHING
, ML_MATCHING
, and PROVIDER
.
The type of matching workflow to create. Specify one of the following types:
RULE_MATCHING
: Match records using configurable rule-based criteria
ML_MATCHING
: Match records using machine learning models
PROVIDER
: Match records using a third-party matching provider
The resource could not be found.
", + "documentation":"The resource couldn't be found.
", "error":{ "httpStatusCode":404, "senderFault":true @@ -3668,6 +3722,10 @@ "outputSourceConfig":{ "shape":"IdMappingJobOutputSourceConfig", "documentation":"A list of OutputSource
objects.
The job type for the ID mapping job.
If the jobType
value is set to INCREMENTAL
, only new or changed data is processed since the last job run. This is the default value if the CreateIdMappingWorkflow
API is configured with an incrementalRunConfig
.
If the jobType
value is set to BATCH
, all data is processed from the input source, regardless of previous job runs. This is the default value if the CreateIdMappingWorkflow
API isn't configured with an incrementalRunConfig
.
If the jobType
value is set to DELETE_ONLY
, only deletion requests from BatchDeleteUniqueIds
are processed.
A list of OutputSource
objects.
The job type for the started ID mapping job.
A value of INCREMENTAL
indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an incrementalRunConfig
.
A value of BATCH
indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn't created with an incrementalRunConfig
.
A value of DELETE_ONLY
indicates that only deletion requests from BatchDeleteUniqueIds
were processed.
An object which defines the ID mapping technique and any additional configurations.
" }, + "incrementalRunConfig":{ + "shape":"IdMappingIncrementalRunConfig", + "documentation":"The incremental run configuration for the update ID mapping workflow.
" + }, "roleArn":{ "shape":"IdMappingRoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
" @@ -3912,6 +3978,10 @@ "shape":"IdMappingTechniques", "documentation":"An object which defines the ID mapping technique and any additional configurations.
" }, + "incrementalRunConfig":{ + "shape":"IdMappingIncrementalRunConfig", + "documentation":"The incremental run configuration for the update ID mapping workflow output.
" + }, "roleArn":{ "shape":"IdMappingRoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
" @@ -4028,7 +4098,7 @@ }, "incrementalRunConfig":{ "shape":"IncrementalRunConfig", - "documentation":"Optional. An object that defines the incremental run type. This object contains only the incrementalRunType
field, which appears as \"Automatic\" in the console.
For workflows where resolutionType
is ML_MATCHING
, incremental processing is not supported.
Optional. An object that defines the incremental run type. This object contains only the incrementalRunType
field, which appears as \"Automatic\" in the console.
For workflows where resolutionType
is ML_MATCHING
or PROVIDER
, incremental processing is not supported.
Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.
", + "idempotent":true + }, "CreateEnvironment":{ "name":"CreateEnvironment", "http":{ @@ -75,6 +91,22 @@ "documentation":"Deletes a host from an Amazon EVS environment.
Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.
Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.
", + "idempotent":true + }, "GetEnvironment":{ "name":"GetEnvironment", "http":{ @@ -177,12 +209,62 @@ } }, "shapes":{ + "AllocationId":{ + "type":"string", + "max":26, + "min":9, + "pattern":"eipalloc-[a-zA-Z0-9_-]+" + }, "Arn":{ "type":"string", "max":1011, "min":1, "pattern":"arn:aws:evs:[a-z]{2}-[a-z]+-[0-9]:[0-9]{12}:environment/[a-zA-Z0-9_-]+" }, + "AssociateEipToVlanRequest":{ + "type":"structure", + "required":[ + "environmentId", + "vlanName", + "allocationId" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + }, + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"A unique ID for the environment containing the VLAN that the Elastic IP address associates with.
" + }, + "vlanName":{ + "shape":"AssociateEipToVlanRequestVlanNameString", + "documentation":"The name of the VLAN. hcx
is the only accepted VLAN name at this time.
The Elastic IP address allocation ID.
" + } + } + }, + "AssociateEipToVlanRequestVlanNameString":{ + "type":"string", + "max":200, + "min":1 + }, + "AssociateEipToVlanResponse":{ + "type":"structure", + "members":{ + "vlan":{"shape":"Vlan"} + } + }, + "AssociationId":{ + "type":"string", + "max":26, + "min":9, + "pattern":"eipassoc-[a-zA-Z0-9_-]+" + }, "Boolean":{ "type":"boolean", "box":true @@ -434,6 +516,66 @@ } } }, + "DisassociateEipFromVlanRequest":{ + "type":"structure", + "required":[ + "environmentId", + "vlanName", + "associationId" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + }, + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"A unique ID for the environment containing the VLAN that the Elastic IP address disassociates from.
" + }, + "vlanName":{ + "shape":"DisassociateEipFromVlanRequestVlanNameString", + "documentation":"The name of the VLAN. hcx
is the only accepted VLAN name at this time.
A unique ID for the Elastic IP address association.
" + } + } + }, + "DisassociateEipFromVlanRequestVlanNameString":{ + "type":"string", + "max":200, + "min":1 + }, + "DisassociateEipFromVlanResponse":{ + "type":"structure", + "members":{ + "vlan":{"shape":"Vlan"} + } + }, + "EipAssociation":{ + "type":"structure", + "members":{ + "associationId":{ + "shape":"AssociationId", + "documentation":"A unique ID for the elastic IP address association with the VLAN subnet.
" + }, + "allocationId":{ + "shape":"AllocationId", + "documentation":"The Elastic IP address allocation ID.
" + }, + "ipAddress":{ + "shape":"IpAddress", + "documentation":"The Elastic IP address.
" + } + }, + "documentation":"An Elastic IP address association with the elastic network interface in the VLAN subnet.
" + }, + "EipAssociationList":{ + "type":"list", + "member":{"shape":"EipAssociation"} + }, "Environment":{ "type":"structure", "members":{ @@ -772,7 +914,7 @@ }, "hcx":{ "shape":"InitialVlanInfo", - "documentation":"The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.
" + "documentation":"The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.
If you plan to use a public HCX VLAN subnet, the following requirements must be met:
Must have a /28 netmask and be allocated from the IPAM public pool. Required for HCX internet access configuration.
The HCX public VLAN CIDR block must be added to the VPC as a secondary CIDR block.
Must have at least three Elastic IP addresses to be allocated from the public IPAM pool for HCX components.
An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.
" + }, + "isHcxPublic":{ + "shape":"Boolean", + "documentation":"Determines if the HCX VLAN that Amazon EVS provisions is public or private.
" + }, + "hcxNetworkAclId":{ + "shape":"NetworkAclId", + "documentation":"A unique ID for a network access control list that the HCX VLAN uses. Required when isHcxPublic
is set to true
.
The initial VLAN subnets for the environment. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
" @@ -944,6 +1094,12 @@ "max":100, "min":1 }, + "NetworkAclId":{ + "type":"string", + "max":21, + "min":4, + "pattern":"acl-[a-zA-Z0-9_-]+" + }, "NetworkInterface":{ "type":"structure", "members":{ @@ -1143,7 +1299,7 @@ "documentation":"The seconds to wait to retry.
" } }, - "documentation":"The CreateEnvironmentHost
operation couldn't be performed because the service is throttling requests. This exception is thrown when the CreateEnvironmentHost
request exceeds concurrency of 1 transaction per second (TPS).
The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.
", "exception":true, "retryable":{"throttling":false} }, @@ -1334,6 +1490,18 @@ "stateDetails":{ "shape":"StateDetails", "documentation":"The state details of the VLAN.
" + }, + "eipAssociations":{ + "shape":"EipAssociationList", + "documentation":"An array of Elastic IP address associations.
" + }, + "isPublic":{ + "shape":"Boolean", + "documentation":"Determines if the VLAN that Amazon EVS provisions is public or private.
" + }, + "networkAclId":{ + "shape":"NetworkAclId", + "documentation":"A unique ID for a network access control list.
" } }, "documentation":"The VLANs that Amazon EVS creates during environment creation.
" diff --git a/services/finspace/pom.xml b/services/finspace/pom.xml index e10d4587eb0e..244976049c66 100644 --- a/services/finspace/pom.xml +++ b/services/finspace/pom.xml @@ -21,7 +21,7 @@The secret manager ARN to store credentials.
" }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive authentication information. This key is used to protect credentials and other sensitive data stored within the authentication configuration.
" + }, "OAuth2Properties":{ "shape":"OAuth2Properties", "documentation":"The properties for OAuth2 authentication.
" @@ -7840,7 +7844,7 @@ }, "ConnectionProperties":{ "shape":"ConnectionProperties", - "documentation":"These key-value pairs define parameters for the connection when using the version 1 Connection schema:
HOST
- The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT
- The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME
- The name under which to log in to the database. The value string for USER_NAME
is \"USERNAME
\".
PASSWORD
- A password, if one is used, for the user name.
ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
JDBC_ENGINE
- The name of the JDBC engine to use.
JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
CONFIG_FILES
- (Reserved for future use.)
INSTANCE_ID
- The instance ID to use.
JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
SECRET_ID
- The secret ID used for the secret manager of credentials.
CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection.
CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection.
CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection.
KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".
KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".
KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional).
KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_MECHANISM
- \"SCRAM-SHA-512\"
, \"GSSAPI\"
, \"AWS_MSK_IAM\"
, or \"PLAIN\"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the \"PLAIN\" mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the \"PLAIN\" mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with sasl.kerberos.service.name
in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
ROLE_ARN
- The role to be used for running queries.
REGION
- The Amazon Web Services Region where queries will be run.
WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run.
CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run.
DATABASE
- The Amazon Redshift database that you are connecting to.
These key-value pairs define parameters for the connection when using the version 1 Connection schema:
HOST
- The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT
- The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME
- The name under which to log in to the database. The value string for USER_NAME
is \"USERNAME
\".
PASSWORD
- A password, if one is used, for the user name.
ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
JDBC_ENGINE
- The name of the JDBC engine to use.
JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
CONFIG_FILES
- (Reserved for future use.)
INSTANCE_ID
- The instance ID to use.
JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL
- A case-insensitive Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
SECRET_ID
- The secret ID used for the secret manager of credentials.
CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection.
CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection.
CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection.
KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".
KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".
KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional).
KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_MECHANISM
- \"SCRAM-SHA-512\"
, \"GSSAPI\"
, \"AWS_MSK_IAM\"
, or \"PLAIN\"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the \"PLAIN\" mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the \"PLAIN\" mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with sasl.kerberos.service.name
in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
ROLE_ARN
- The role to be used for running queries.
REGION
- The Amazon Web Services Region where queries will be run.
WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run.
CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run.
DATABASE
- The Amazon Redshift database that you are connecting to.
The email address of the member account.
The rules for a valid email address:
The email address must be a minimum of 6 and a maximum of 64 characters long.
All characters must be 7-bit ASCII characters.
There must be one and only one @ symbol, which separates the local name from the domain name.
The local name can't contain any of the following characters:
whitespace, \" ' ( ) < > [ ] : ' , \\ | % &
The local name can't begin with a dot (.).
The domain name can consist of only the characters [a-z], [A-Z], [0-9], hyphen (-), or dot (.).
The domain name can't begin or end with a dot (.) or hyphen (-).
The domain name must contain at least one dot.
The email address of the member account. The following list includes the rules for a valid email address:
The email address must be a minimum of 6 and a maximum of 64 characters long.
All characters must be 7-bit ASCII characters.
There must be one and only one @ symbol, which separates the local name from the domain name.
The local name can't contain any of the following characters:
whitespace, \" ' ( ) < > [ ] : ' , \\ | % &
The local name can't begin with a dot (.).
The domain name can consist of only the characters [a-z], [A-Z], [0-9], hyphen (-), or dot (.).
The domain name can't begin or end with a dot (.) or hyphen (-).
The domain name must contain at least one dot.
If true, this indicates the participantId
is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId
.
If true, this indicates the participantId
is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId
. Default: false
.
An occurrence during a stage session.
" @@ -1777,6 +1777,10 @@ "gridGap":{ "shape":"GridGap", "documentation":"Specifies the spacing between participant tiles in pixels. Default: 2
.
Attribute name in ParticipantTokenConfiguration identifying the participant ordering key. Participants with participantOrderAttribute
set to \"\"
or not specified are ordered based on their arrival time into the stage.
Configuration information specific to Grid layout, for server-side composition. See \"Layouts\" in Server-Side Composition.
" @@ -2732,7 +2736,7 @@ }, "sourceStageArn":{ "shape":"StageArn", - "documentation":"ARN of the stage from which this participant is replicated.
" + "documentation":"Source stage ARN from which this participant is replicated, if replicationType
is REPLICA
.
Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight
’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
Attribute name in ParticipantTokenConfiguration identifying the participant ordering key. Participants with participantOrderAttribute
set to \"\"
or not specified are ordered based on their arrival time into the stage.
Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition.
" diff --git a/services/kafka/pom.xml b/services/kafka/pom.xml index 72e788d5dd99..68cc6928f0e2 100644 --- a/services/kafka/pom.xml +++ b/services/kafka/pom.xml @@ -21,7 +21,7 @@If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
" }, "TagValue":{ @@ -721,8 +722,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
" }, "UpdateRescoreExecutionPlanRequest":{ diff --git a/services/keyspaces/pom.xml b/services/keyspaces/pom.xml index 1c152961150d..1595c45f8bcb 100644 --- a/services/keyspaces/pom.xml +++ b/services/keyspaces/pom.xml @@ -21,7 +21,7 @@Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:
You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
The Decrypt
operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.
If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId
parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId
parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt
operation fails. This practice ensures that you use the KMS key that you intend.
Whenever possible, use key policies to give users permission to call the Decrypt
operation on a particular KMS key, instead of using IAM policies. Otherwise, you might create an IAM policy that gives the user Decrypt
permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt
permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide.
Decrypt
also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call Decrypt
for a Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient
parameter to provide the attestation document for the enclave. Instead of the plaintext data, the response includes the plaintext data encrypted with the public key from the attestation document (CiphertextForRecipient
). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. If you use the KeyId
parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias ARN of the KMS key.
Required permissions: kms:Decrypt (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
" + "documentation":"Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:
You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
The Decrypt
operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.
If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId
parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId
parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt
operation fails. This practice ensures that you use the KMS key that you intend.
Whenever possible, use key policies to give users permission to call the Decrypt
operation on a particular KMS key, instead of using IAM policies. Otherwise, you might create an IAM policy that gives the user Decrypt
permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt
permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide.
Decrypt
also supports Amazon Web Services Nitro Enclaves and NitroTPM, which provide attested environments in Amazon EC2. To call Decrypt
for a Nitro enclave or NitroTPM, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient
parameter to provide the attestation document for the attested environment. Instead of the plaintext data, the response includes the plaintext data encrypted with the public key from the attestation document (CiphertextForRecipient
). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. If you use the KeyId
parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias ARN of the KMS key.
Required permissions: kms:Decrypt (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
" }, "DeleteAlias":{ "name":"DeleteAlias", @@ -390,7 +390,7 @@ {"shape":"KMSInvalidStateException"}, {"shape":"DryRunOperationException"} ], - "documentation":"Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.
To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the DescribeKey operation.
You must also specify the length of the data key. Use either the KeySpec
or NumberOfBytes
parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec
parameter.
To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec
value of AES_128
or a NumberOfBytes
value of 16
. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the Key Management Service Developer Guide.
GenerateDataKey
also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateDataKey
for an Amazon Web Services Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient
parameter to provide the attestation document for the enclave. GenerateDataKey
returns a copy of the data key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the data key, the response includes a copy of the data key encrypted under the public key from the attestation document (CiphertextForRecipient
). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide..
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of KMS:
Use the GenerateDataKey
operation to get a data key.
Use the plaintext data key (in the Plaintext
field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory.
Store the encrypted data key (in the CiphertextBlob
field of the response) with the encrypted data.
To decrypt data outside of KMS:
Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext data key from memory.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId
parameter.
Required permissions: kms:GenerateDataKey (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
" + "documentation":"Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.
To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the DescribeKey operation.
You must also specify the length of the data key. Use either the KeySpec
or NumberOfBytes
parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec
parameter.
To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec
value of AES_128
or a NumberOfBytes
value of 16
. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the Key Management Service Developer Guide.
GenerateDataKey
also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateDataKey
for an Amazon Web Services Nitro enclave or NitroTPM, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient
parameter to provide the attestation document for the attested environment. GenerateDataKey
returns a copy of the data key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the data key, the response includes a copy of the data key encrypted under the public key from the attestation document (CiphertextForRecipient
). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of KMS:
Use the GenerateDataKey
operation to get a data key.
Use the plaintext data key (in the Plaintext
field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory.
Store the encrypted data key (in the CiphertextBlob
field of the response) with the encrypted data.
To decrypt data outside of KMS:
Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext data key from memory.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId
parameter.
Required permissions: kms:GenerateDataKey (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
" }, "GenerateDataKeyPair":{ "name":"GenerateDataKeyPair", @@ -412,7 +412,7 @@ {"shape":"UnsupportedOperationException"}, {"shape":"DryRunOperationException"} ], - "documentation":"Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key.
You can use the public key that GenerateDataKeyPair
returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
Use the KeyPairSpec
parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.
If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext
returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.
GenerateDataKeyPair
returns a unique data key pair for each request. The bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280. The private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.
GenerateDataKeyPair
also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateDataKeyPair
for an Amazon Web Services Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient
parameter to provide the attestation document for the enclave. GenerateDataKeyPair
returns the public data key and a copy of the private data key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the private data key (PrivateKeyPlaintext
), the response includes a copy of the private data key encrypted under the public key from the attestation document (CiphertextForRecipient
). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide..
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId
parameter.
Required permissions: kms:GenerateDataKeyPair (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
" + "documentation":"Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key.
You can use the public key that GenerateDataKeyPair
returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
Use the KeyPairSpec
parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.
If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext
returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.
GenerateDataKeyPair
returns a unique data key pair for each request. The bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280. The private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.
GenerateDataKeyPair
also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateDataKeyPair
for an Amazon Web Services Nitro enclave or NitroTPM, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient
parameter to provide the attestation document for the attested environment. GenerateDataKeyPair
returns the public data key and a copy of the private data key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the private data key (PrivateKeyPlaintext
), the response includes a copy of the private data key encrypted under the public key from the attestation document (CiphertextForRecipient
). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId
parameter.
Required permissions: kms:GenerateDataKeyPair (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
" }, "GenerateDataKeyPairWithoutPlaintext":{ "name":"GenerateDataKeyPairWithoutPlaintext", @@ -492,7 +492,7 @@ {"shape":"CustomKeyStoreNotFoundException"}, {"shape":"CustomKeyStoreInvalidStateException"} ], - "documentation":"Returns a random byte string that is cryptographically secure.
You must use the NumberOfBytes
parameter to specify the length of the random byte string. There is no default value for string length.
By default, the random byte string is generated in KMS. To generate the byte string in the CloudHSM cluster associated with an CloudHSM key store, use the CustomKeyStoreId
parameter.
GenerateRandom
also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateRandom
for a Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient
parameter to provide the attestation document for the enclave. Instead of plaintext bytes, the response includes the plaintext bytes encrypted under the public key from the attestation document (CiphertextForRecipient
).For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
For more information about entropy and random number generation, see Entropy and random number generation in the Key Management Service Developer Guide.
Cross-account use: Not applicable. GenerateRandom
does not use any account-specific resources, such as KMS keys.
Required permissions: kms:GenerateRandom (IAM policy)
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
" + "documentation":"Returns a random byte string that is cryptographically secure.
You must use the NumberOfBytes
parameter to specify the length of the random byte string. There is no default value for string length.
By default, the random byte string is generated in KMS. To generate the byte string in the CloudHSM cluster associated with an CloudHSM key store, use the CustomKeyStoreId
parameter.
GenerateRandom
also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateRandom
for a Nitro enclave or NitroTPM, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient
parameter to provide the attestation document for the attested environment. Instead of plaintext bytes, the response includes the plaintext bytes encrypted under the public key from the attestation document (CiphertextForRecipient
). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
For more information about entropy and random number generation, see Entropy and random number generation in the Key Management Service Developer Guide.
Cross-account use: Not applicable. GenerateRandom
does not use any account-specific resources, such as KMS keys.
Required permissions: kms:GenerateRandom (IAM policy)
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
" }, "GetKeyPolicy":{ "name":"GetKeyPolicy", @@ -1370,7 +1370,7 @@ }, "KeyUsage":{ "shape":"KeyUsageType", - "documentation":"Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT
. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage
value after the KMS key is created.
Select only one valid value.
For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT
.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC
.
For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT
or SIGN_VERIFY
.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY
or KEY_AGREEMENT
.
For asymmetric KMS keys with ECC_SECG_P256K1
key pairs, specify SIGN_VERIFY
.
For asymmetric KMS keys with ML-DSA key pairs, specify SIGN_VERIFY
.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT
, SIGN_VERIFY
, or KEY_AGREEMENT
.
Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT
. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage
value after the KMS key is created. Each KMS key can have only one key usage. This follows key usage best practices according to NIST SP 800-57 Recommendations for Key Management, section 5.2, Key usage.
Select only one valid value.
For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT
.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC
.
For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT
or SIGN_VERIFY
.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY
or KEY_AGREEMENT
.
For asymmetric KMS keys with ECC_SECG_P256K1
key pairs, specify SIGN_VERIFY
.
For asymmetric KMS keys with ML-DSA key pairs, specify SIGN_VERIFY
.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT
, SIGN_VERIFY
, or KEY_AGREEMENT
.
A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.
When you use this parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
" + "documentation":"A signed attestation document from an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter supports the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK for Amazon Web Services Nitro Enclaves. It supports any Amazon Web Services SDK for Amazon Web Services NitroTPM.
When you use this parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the attested environment. The Plaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
" }, "DryRun":{ "shape":"NullableBooleanType", @@ -1604,7 +1604,7 @@ }, "CiphertextForRecipient":{ "shape":"CiphertextType", - "documentation":"The plaintext data encrypted with the public key in the attestation document.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
The plaintext data encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter from any Amazon Web Services SDK to provide the attestation document for the enclave.
When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the plaintext shared secret under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob
field in the response contains the encrypted shared secret derived from the KMS key specified by the KeyId
parameter and public key specified by the PublicKey
parameter. The SharedSecret
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
" + "documentation":"A signed attestation document from an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM. To call DeriveSharedSecret generate an attestation document use either Amazon Web Services Nitro Enclaves SDK for an Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM tools for Amazon Web Services NitroTPM. Then use the Recipient parameter from any Amazon Web Services SDK to provide the attestation document for the attested environment.
When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the plaintext shared secret under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the attested environment. The CiphertextBlob
field in the response contains the encrypted shared secret derived from the KMS key specified by the KeyId
parameter and public key specified by the PublicKey
parameter. The SharedSecret
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
" } } }, @@ -1719,7 +1719,7 @@ }, "CiphertextForRecipient":{ "shape":"CiphertextType", - "documentation":"The plaintext shared secret encrypted with the public key in the attestation document.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
The plaintext shared secret encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter from any Amazon Web Services SDK to provide the attestation document for the enclave.
When you use this parameter, instead of returning a plaintext copy of the private data key, KMS encrypts the plaintext private data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob
field in the response contains a copy of the private data key encrypted under the KMS key specified by the KeyId
parameter. The PrivateKeyPlaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
" + "documentation":"A signed attestation document from an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM. To call GenerateDataKeyPair generate an attestation document use either Amazon Web Services Nitro Enclaves SDK for an Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM tools for Amazon Web Services NitroTPM. Then use the Recipient parameter from any Amazon Web Services SDK to provide the attestation document for the attested environment.
When you use this parameter, instead of returning a plaintext copy of the private data key, KMS encrypts the plaintext private data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the attested environment. The CiphertextBlob
field in the response contains a copy of the private data key encrypted under the KMS key specified by the KeyId
parameter. The PrivateKeyPlaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
" }, "DryRun":{ "shape":"NullableBooleanType", @@ -2015,7 +2015,7 @@ }, "CiphertextForRecipient":{ "shape":"CiphertextType", - "documentation":"The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
The plaintext private data key encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.
When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob
field in the response contains a copy of the data key encrypted under the KMS key specified by the KeyId
parameter. The Plaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
" + "documentation":"A signed attestation document from an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter supports the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK for Amazon Web Services Nitro Enclaves. It supports any Amazon Web Services SDK for Amazon Web Services NitroTPM.
When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob
field in the response contains a copy of the data key encrypted under the KMS key specified by the KeyId
parameter. The Plaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
" }, "DryRun":{ "shape":"NullableBooleanType", @@ -2128,7 +2128,7 @@ }, "CiphertextForRecipient":{ "shape":"CiphertextType", - "documentation":"The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
The plaintext data key encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.
When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
" + "documentation":"A signed attestation document from an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The only valid encryption algorithm is RSAES_OAEP_SHA_256
.
This parameter supports the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK for Amazon Web Services Nitro Enclaves. It supports any Amazon Web Services SDK for Amazon Web Services NitroTPM.
When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the attested environment. The Plaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
" } } }, @@ -2256,7 +2256,7 @@ }, "CiphertextForRecipient":{ "shape":"CiphertextType", - "documentation":"The plaintext random bytes encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
The plaintext random bytes encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.
This field is included in the response only when the Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256
.
The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave or NitroTPM to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256
.
The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.
" + "documentation":"The attestation document for an Amazon Web Services Nitro Enclave or a NitroTPM. This document includes the enclave's public key.
" } }, - "documentation":"Contains information about the party that receives the response from the API operation.
This data type is designed to support Amazon Web Services Nitro Enclaves, which lets you create an isolated compute environment in Amazon EC2. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
" + "documentation":"Contains information about the party that receives the response from the API operation.
This data type is designed to support Amazon Web Services Nitro Enclaves and Amazon Web Services NitroTPM, which lets you create an attested environment in Amazon EC2. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
" }, "RegionType":{ "type":"string", diff --git a/services/lakeformation/pom.xml b/services/lakeformation/pom.xml index f51a1553f353..ad478ecad71b 100644 --- a/services/lakeformation/pom.xml +++ b/services/lakeformation/pom.xml @@ -21,7 +21,7 @@The directory ID for an Active Directory identity provider.
" + }, "ActiveDirectorySettings":{ "shape":"ActiveDirectorySettings", "documentation":"The ActiveDirectorySettings
resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
" }, - "DirectoryId":{ - "shape":"Directory", - "documentation":"The directory ID for an Active Directory identity provider.
" + "IsSharedActiveDirectory":{ + "shape":"Boolean", + "documentation":"Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
" } }, "documentation":"Details about an Active Directory identity provider.
" @@ -377,17 +380,17 @@ "ActiveDirectorySettings":{ "type":"structure", "members":{ - "DomainCredentialsProvider":{ - "shape":"CredentialsProvider", - "documentation":"Points to the CredentialsProvider
resource that contains information about the credential provider for user administration.
The domain name for the Active Directory.
" }, "DomainIpv4List":{ "shape":"ActiveDirectorySettingsDomainIpv4ListList", "documentation":"A list of domain IPv4 addresses that are used for the Active Directory.
" }, - "DomainName":{ - "shape":"String", - "documentation":"The domain name for the Active Directory.
" + "DomainCredentialsProvider":{ + "shape":"CredentialsProvider", + "documentation":"Points to the CredentialsProvider
resource that contains information about the credential provider for user administration.
The domain name of the Active Directory that contains information for the user to associate.
" + "documentation":"The user name from the identity provider.
" + }, + "InstanceId":{ + "shape":"String", + "documentation":"The ID of the EC2 instance that provides the user-based subscription.
" }, "IdentityProvider":{ "shape":"IdentityProvider", "documentation":"The identity provider for the user.
" }, - "InstanceId":{ + "Domain":{ "shape":"String", - "documentation":"The ID of the EC2 instance that provides the user-based subscription.
" + "documentation":"The domain name of the Active Directory that contains information for the user to associate.
" }, "Tags":{ "shape":"Tags", "documentation":"The tags that apply for the user association.
" - }, - "Username":{ - "shape":"String", - "documentation":"The user name from the identity provider.
" } } }, @@ -453,6 +456,10 @@ } } }, + "Boolean":{ + "type":"boolean", + "box":true + }, "BoxInteger":{ "type":"integer", "box":true @@ -544,13 +551,13 @@ "shape":"IdentityProvider", "documentation":"An object that specifies details for the Active Directory identity provider.
" }, - "IdentityProviderArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) that identifies the identity provider to deregister.
" - }, "Product":{ "shape":"String", "documentation":"The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE
| VISUAL_STUDIO_PROFESSIONAL
| OFFICE_PROFESSIONAL_PLUS
| REMOTE_DESKTOP_SERVICES
The Amazon Resource Name (ARN) that identifies the identity provider to deregister.
" } } }, @@ -566,30 +573,30 @@ }, "Directory":{ "type":"string", - "pattern":"^(d|sd)-[0-9a-f]{10}$" + "pattern":"(d|sd)-[0-9a-f]{10}" }, "DisassociateUserRequest":{ "type":"structure", "members":{ - "Domain":{ + "Username":{ "shape":"String", - "documentation":"The domain name of the Active Directory that contains information for the user to disassociate.
" - }, - "IdentityProvider":{ - "shape":"IdentityProvider", - "documentation":"An object that specifies details for the Active Directory identity provider.
" + "documentation":"The user name from the Active Directory identity provider for the user.
" }, "InstanceId":{ "shape":"String", "documentation":"The ID of the EC2 instance which provides user-based subscriptions.
" }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the Active Directory identity provider.
" + }, "InstanceUserArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the user to disassociate from the EC2 instance.
" }, - "Username":{ + "Domain":{ "shape":"String", - "documentation":"The user name from the Active Directory identity provider for the user.
" + "documentation":"The domain name of the Active Directory that contains information for the user to disassociate.
" } } }, @@ -656,34 +663,38 @@ "type":"structure", "required":[ "IdentityProvider", - "Product", "Settings", + "Product", "Status" ], "members":{ - "FailureMessage":{ - "shape":"String", - "documentation":"The failure message associated with an identity provider.
" - }, "IdentityProvider":{ "shape":"IdentityProvider", "documentation":"The IdentityProvider
resource contains information about an identity provider.
The Amazon Resource Name (ARN) of the identity provider.
" + "Settings":{ + "shape":"Settings", + "documentation":"The Settings
resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.
The name of the user-based subscription product.
" }, - "Settings":{ - "shape":"Settings", - "documentation":"The Settings
resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.
The status of the identity provider.
" + }, + "IdentityProviderArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the identity provider.
" + }, + "FailureMessage":{ + "shape":"String", + "documentation":"The failure message associated with an identity provider.
" + }, + "OwnerAccountId":{ + "shape":"String", + "documentation":"The AWS Account ID of the owner of this resource.
" } }, "documentation":"Describes an identity provider.
" @@ -696,29 +707,37 @@ "type":"structure", "required":[ "InstanceId", - "Products", - "Status" + "Status", + "Products" ], "members":{ "InstanceId":{ "shape":"String", "documentation":"The ID of the EC2 instance, which provides user-based subscriptions.
" }, - "LastStatusCheckDate":{ + "Status":{ "shape":"String", - "documentation":"The date of the last status check.
" + "documentation":"The status of an EC2 instance resource.
" }, "Products":{ "shape":"StringList", "documentation":"A list of provided user-based subscription products.
" }, - "Status":{ + "LastStatusCheckDate":{ "shape":"String", - "documentation":"The status of an EC2 instance resource.
" + "documentation":"The date of the last status check.
" }, "StatusMessage":{ "shape":"String", "documentation":"The status message for an EC2 instance.
" + }, + "OwnerAccountId":{ + "shape":"String", + "documentation":"The AWS Account ID of the owner of this resource.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"The IdentityProvider
resource specifies details about the identity provider.
Describes an EC2 instance providing user-based subscriptions.
" @@ -730,47 +749,47 @@ "InstanceUserSummary":{ "type":"structure", "required":[ - "IdentityProvider", + "Username", "InstanceId", - "Status", - "Username" + "IdentityProvider", + "Status" ], "members":{ - "AssociationDate":{ - "shape":"String", - "documentation":"The date a user was associated with an EC2 instance.
" - }, - "DisassociationDate":{ + "Username":{ "shape":"String", - "documentation":"The date a user was disassociated from an EC2 instance.
" + "documentation":"The user name from the identity provider for the user.
" }, - "Domain":{ + "InstanceId":{ "shape":"String", - "documentation":"The domain name of the Active Directory that contains the user information for the product subscription.
" + "documentation":"The ID of the EC2 instance that provides user-based subscriptions.
" }, "IdentityProvider":{ "shape":"IdentityProvider", "documentation":"The IdentityProvider
resource specifies details about the identity provider.
The ID of the EC2 instance that provides user-based subscriptions.
" + "documentation":"The status of a user associated with an EC2 instance.
" }, "InstanceUserArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) that identifies the instance user.
" }, - "Status":{ - "shape":"String", - "documentation":"The status of a user associated with an EC2 instance.
" - }, "StatusMessage":{ "shape":"String", "documentation":"The status message for users of an EC2 instance.
" }, - "Username":{ + "Domain":{ "shape":"String", - "documentation":"The user name from the identity provider for the user.
" + "documentation":"The domain name of the Active Directory that contains the user information for the product subscription.
" + }, + "AssociationDate":{ + "shape":"String", + "documentation":"The date a user was associated with an EC2 instance.
" + }, + "DisassociationDate":{ + "shape":"String", + "documentation":"The date a user was disassociated from an EC2 instance.
" } }, "documentation":"Describes users of an EC2 instance providing user-based subscriptions.
" @@ -791,11 +810,15 @@ }, "IpV4":{ "type":"string", - "pattern":"^(?:(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])(\\.(?!$)|$)){4}$" + "pattern":"(?:(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])(\\.(?!$)|$)){4}" }, "LicenseServer":{ "type":"structure", "members":{ + "ProvisioningStatus":{ + "shape":"LicenseServerEndpointProvisioningStatus", + "documentation":"The current state of the provisioning process for the RDS license server.
" + }, "HealthStatus":{ "shape":"LicenseServerHealthStatus", "documentation":"The health status of the RDS license server.
" @@ -803,10 +826,6 @@ "Ipv4Address":{ "shape":"String", "documentation":"A list of domain IPv4 addresses that are used for the RDS license server.
" - }, - "ProvisioningStatus":{ - "shape":"LicenseServerEndpointProvisioningStatus", - "documentation":"The current state of the provisioning process for the RDS license server.
" } }, "documentation":"Information about a Remote Desktop Services (RDS) license server.
" @@ -814,22 +833,30 @@ "LicenseServerEndpoint":{ "type":"structure", "members":{ - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The timestamp when License Manager created the license server endpoint.
" - }, "IdentityProviderArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the identity provider that's associated with the RDS license server endpoint.
" }, - "LicenseServerEndpointArn":{ - "shape":"Arn", - "documentation":"The ARN of the ServerEndpoint
resource for the RDS license server.
The type of license server.
" + }, + "ServerEndpoint":{ + "shape":"ServerEndpoint", + "documentation":"The ServerEndpoint
resource contains the network address of the RDS license server endpoint.
The message associated with the provisioning status, if there is one.
" }, "LicenseServerEndpointId":{ "shape":"LicenseServerEndpointId", "documentation":"The ID of the license server endpoint.
" }, + "LicenseServerEndpointArn":{ + "shape":"Arn", + "documentation":"The ARN of the ServerEndpoint
resource for the RDS license server.
The current state of the provisioning process for the RDS license server endpoint
" @@ -838,17 +865,9 @@ "shape":"LicenseServerList", "documentation":"An array of LicenseServer
resources that represent the license servers that are accessed through this endpoint.
The ServerEndpoint
resource contains the network address of the RDS license server endpoint.
The type of license server.
" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The message associated with the provisioning status, if there is one.
" + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when License Manager created the license server endpoint.
" } }, "documentation":"Contains details about a network endpoint for a Remote Desktop Services (RDS) license server.
" @@ -884,17 +903,17 @@ "LicenseServerSettings":{ "type":"structure", "required":[ - "ServerSettings", - "ServerType" + "ServerType", + "ServerSettings" ], "members":{ - "ServerSettings":{ - "shape":"ServerSettings", - "documentation":"The ServerSettings
resource contains the settings for your server.
The type of license server.
" + }, + "ServerSettings":{ + "shape":"ServerSettings", + "documentation":"The ServerSettings
resource contains the settings for your server.
The settings to configure your license server.
" @@ -902,14 +921,14 @@ "ListIdentityProvidersRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"You can use the following filters to streamline results:
Product
DirectoryId
The maximum number of results to return from a single request.
" }, + "Filters":{ + "shape":"FilterList", + "documentation":"You can use the following filters to streamline results:
Product
DirectoryId
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" @@ -933,10 +952,6 @@ "ListInstancesRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"You can use the following filters to streamline results:
Status
InstanceId
The maximum number of results to return from a single request.
" @@ -944,6 +959,10 @@ "NextToken":{ "shape":"String", "documentation":"A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"You can use the following filters to streamline results:
Status
InstanceId
You can use the following filters to streamline results:
IdentityProviderArn
The maximum number of results to return from a single request.
" }, + "Filters":{ + "shape":"FilterList", + "documentation":"You can use the following filters to streamline results:
IdentityProviderArn
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" @@ -1000,9 +1019,9 @@ "type":"structure", "required":["IdentityProvider"], "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"You can use the following filters to streamline results:
Status
Username
Domain
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE
| VISUAL_STUDIO_PROFESSIONAL
| OFFICE_PROFESSIONAL_PLUS
| REMOTE_DESKTOP_SERVICES
The maximum number of results to return from a single request.
" }, + "Filters":{ + "shape":"FilterList", + "documentation":"You can use the following filters to streamline results:
Status
Username
Domain
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" - }, - "Product":{ - "shape":"String", - "documentation":"The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE
| VISUAL_STUDIO_PROFESSIONAL
| OFFICE_PROFESSIONAL_PLUS
| REMOTE_DESKTOP_SERVICES
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" - }, "ProductUserSummaries":{ "shape":"ProductUserSummaryList", "documentation":"Metadata that describes the list product subscriptions operation.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -1059,26 +1078,26 @@ "ListUserAssociationsRequest":{ "type":"structure", "required":[ - "IdentityProvider", - "InstanceId" + "InstanceId", + "IdentityProvider" ], "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"You can use the following filters to streamline results:
Status
Username
Domain
The ID of the EC2 instance, which provides user-based subscriptions.
" }, "IdentityProvider":{ "shape":"IdentityProvider", "documentation":"An object that specifies details for the identity provider.
" }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the EC2 instance, which provides user-based subscriptions.
" - }, "MaxResults":{ "shape":"BoxInteger", "documentation":"The maximum number of results to return from a single request.
" }, + "Filters":{ + "shape":"FilterList", + "documentation":"You can use the following filters to streamline results:
Status
Username
Domain
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" @@ -1101,47 +1120,47 @@ "ProductUserSummary":{ "type":"structure", "required":[ - "IdentityProvider", + "Username", "Product", - "Status", - "Username" + "IdentityProvider", + "Status" ], "members":{ - "Domain":{ + "Username":{ "shape":"String", - "documentation":"The domain name of the Active Directory that contains the user information for the product subscription.
" + "documentation":"The user name from the identity provider for this product user.
" + }, + "Product":{ + "shape":"String", + "documentation":"The name of the user-based subscription product.
" }, "IdentityProvider":{ "shape":"IdentityProvider", "documentation":"An object that specifies details for the identity provider.
" }, - "Product":{ + "Status":{ "shape":"String", - "documentation":"The name of the user-based subscription product.
" + "documentation":"The status of a product for this user.
" }, "ProductUserArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) for this product user.
" }, - "Status":{ - "shape":"String", - "documentation":"The status of a product for this user.
" - }, "StatusMessage":{ "shape":"String", "documentation":"The status message for a product for this user.
" }, - "SubscriptionEndDate":{ + "Domain":{ "shape":"String", - "documentation":"The end date of a subscription.
" + "documentation":"The domain name of the Active Directory that contains the user information for the product subscription.
" }, "SubscriptionStartDate":{ "shape":"String", "documentation":"The start date of a subscription.
" }, - "Username":{ + "SubscriptionEndDate":{ "shape":"String", - "documentation":"The user name from the identity provider for this product user.
" + "documentation":"The end date of a subscription.
" } }, "documentation":"A summary of the user-based subscription products for a specific user.
" @@ -1198,7 +1217,7 @@ }, "ResourceArn":{ "type":"string", - "pattern":"^arn:([a-z0-9-\\.]{1,63}):([a-z0-9-\\.]{1,63}):([a-z0-9-\\.]{1,63}):([a-z0-9-\\.]{1,63}):([a-z0-9-\\.]{1,510})/([a-z0-9-\\.]{1,510})$" + "pattern":"arn:([a-z0-9-\\.]{1,63}):([a-z0-9-\\.]{1,63}):([a-z0-9-\\.]{1,63}):([a-z0-9-\\.]{1,63}):([a-z0-9-\\.]{1,510})/([a-z0-9-\\.]{1,510})" }, "ResourceNotFoundException":{ "type":"structure", @@ -1230,7 +1249,7 @@ "type":"string", "max":200, "min":5, - "pattern":"^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$" + "pattern":"sg-(([0-9a-z]{8})|([0-9a-z]{17}))" }, "ServerEndpoint":{ "type":"structure", @@ -1268,17 +1287,17 @@ "Settings":{ "type":"structure", "required":[ - "SecurityGroupId", - "Subnets" + "Subnets", + "SecurityGroupId" ], "members":{ - "SecurityGroupId":{ - "shape":"SecurityGroup", - "documentation":"A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
" - }, "Subnets":{ "shape":"SettingsSubnetsList", "documentation":"The subnets defined for the registered identity provider.
" + }, + "SecurityGroupId":{ + "shape":"SecurityGroup", + "documentation":"A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
" } }, "documentation":"The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints, and the security group ID that is associated with the VPC endpoints. The security group should permit inbound TCP port 1688 communication from resources in the VPC.
" @@ -1291,14 +1310,14 @@ "StartProductSubscriptionRequest":{ "type":"structure", "required":[ + "Username", "IdentityProvider", - "Product", - "Username" + "Product" ], "members":{ - "Domain":{ + "Username":{ "shape":"String", - "documentation":"The domain name of the Active Directory that contains the user for whom to start the product subscription.
" + "documentation":"The user name from the identity provider of the user.
" }, "IdentityProvider":{ "shape":"IdentityProvider", @@ -1308,13 +1327,13 @@ "shape":"String", "documentation":"The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE
| VISUAL_STUDIO_PROFESSIONAL
| OFFICE_PROFESSIONAL_PLUS
| REMOTE_DESKTOP_SERVICES
The domain name of the Active Directory that contains the user for whom to start the product subscription.
" + }, "Tags":{ "shape":"Tags", "documentation":"The tags that apply to the product subscription.
" - }, - "Username":{ - "shape":"String", - "documentation":"The user name from the identity provider of the user.
" } } }, @@ -1331,9 +1350,9 @@ "StopProductSubscriptionRequest":{ "type":"structure", "members":{ - "Domain":{ + "Username":{ "shape":"String", - "documentation":"The domain name of the Active Directory that contains the user for whom to stop the product subscription.
" + "documentation":"The user name from the identity provider for the user.
" }, "IdentityProvider":{ "shape":"IdentityProvider", @@ -1347,9 +1366,9 @@ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the product user.
" }, - "Username":{ + "Domain":{ "shape":"String", - "documentation":"The user name from the identity provider for the user.
" + "documentation":"The domain name of the Active Directory that contains the user for whom to stop the product subscription.
" } } }, @@ -1370,7 +1389,7 @@ }, "Subnet":{ "type":"string", - "pattern":"^subnet-[a-z0-9]{8,17}" + "pattern":"subnet-[a-z0-9]{8,17}.*" }, "Subnets":{ "type":"list", @@ -1404,8 +1423,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "Tags":{ "type":"map", @@ -1447,22 +1465,21 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateIdentityProviderSettingsRequest":{ "type":"structure", "required":["UpdateSettings"], "members":{ "IdentityProvider":{"shape":"IdentityProvider"}, - "IdentityProviderArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the identity provider to update.
" - }, "Product":{ "shape":"String", "documentation":"The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE
| VISUAL_STUDIO_PROFESSIONAL
| OFFICE_PROFESSIONAL_PLUS
| REMOTE_DESKTOP_SERVICES
The Amazon Resource Name (ARN) of the identity provider to update.
" + }, "UpdateSettings":{ "shape":"UpdateSettings", "documentation":"Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:
Subnets which you want to add to provision VPC endpoints.
Subnets which you want to remove the VPC endpoints from.
Security group ID which permits traffic to the VPC endpoints.
A message that provides a reason for a Failed
or Defaulted
synchronization status.
The following messages are possible:
SYNC_ON_HOLD
- The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.
DEFAULTED_FOR_SLR_MISSING
- The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
DEFAULTED_FOR_SLR_MISSING_ON_HOLD
- The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
Unknown
- The reason that synchronization failed is unknown. Contact Amazon Web ServicesSupport for more information.
A message that provides a reason for a Failed
or Defaulted
synchronization status.
The following messages are possible:
SYNC_ON_HOLD
- The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.
DEFAULTED_FOR_SLR_MISSING
- The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
DEFAULTED_FOR_SLR_MISSING_ON_HOLD
- The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
Unknown
- The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.
Create a data store.
", @@ -112,7 +113,8 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Get the import job properties to learn more about the job or job progress.
The jobStatus
refers to the execution of the import job. Therefore, an import job can return a jobStatus
as COMPLETED
even if validation issues are discovered during the import process. If a jobStatus
returns as COMPLETED
, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.
Get the import job properties to learn more about the job or job progress.
The jobStatus
refers to the execution of the import job. Therefore, an import job can return a jobStatus
as COMPLETED
even if validation issues are discovered during the import process. If a jobStatus
returns as COMPLETED
, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.
Get data store properties.
" + "documentation":"Get data store properties.
", + "readonly":true }, "GetImageFrame":{ "name":"GetImageFrame", @@ -150,7 +153,8 @@ {"shape":"ResourceNotFoundException"} ], "documentation":"Get an image frame (pixel data) for an image set.
", - "endpoint":{"hostPrefix":"runtime-"} + "endpoint":{"hostPrefix":"runtime-"}, + "readonly":true }, "GetImageSet":{ "name":"GetImageSet", @@ -170,7 +174,8 @@ {"shape":"ResourceNotFoundException"} ], "documentation":"Get image set properties.
", - "endpoint":{"hostPrefix":"runtime-"} + "endpoint":{"hostPrefix":"runtime-"}, + "readonly":true }, "GetImageSetMetadata":{ "name":"GetImageSetMetadata", @@ -190,7 +195,8 @@ {"shape":"ResourceNotFoundException"} ], "documentation":"Get metadata attributes for an image set.
", - "endpoint":{"hostPrefix":"runtime-"} + "endpoint":{"hostPrefix":"runtime-"}, + "readonly":true }, "ListDICOMImportJobs":{ "name":"ListDICOMImportJobs", @@ -209,7 +215,8 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"List import jobs created for a specific data store.
" + "documentation":"List import jobs created for a specific data store.
", + "readonly":true }, "ListDatastores":{ "name":"ListDatastores", @@ -226,7 +233,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"List data stores.
" + "documentation":"List data stores.
", + "readonly":true }, "ListImageSetVersions":{ "name":"ListImageSetVersions", @@ -246,7 +254,8 @@ {"shape":"ResourceNotFoundException"} ], "documentation":"List image set versions.
", - "endpoint":{"hostPrefix":"runtime-"} + "endpoint":{"hostPrefix":"runtime-"}, + "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -264,7 +273,8 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Lists all tags associated with a medical imaging resource.
" + "documentation":"Lists all tags associated with a medical imaging resource.
", + "readonly":true }, "SearchImageSets":{ "name":"SearchImageSets", @@ -625,6 +635,10 @@ "kmsKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.
" + }, + "lambdaAuthorizerArn":{ + "shape":"LambdaArn", + "documentation":"The ARN of the authorizer's Lambda function.
" } } }, @@ -762,7 +776,7 @@ }, "DICOMNumberOfStudyRelatedInstances":{ "type":"integer", - "max":10000, + "max":1000000, "min":0 }, "DICOMNumberOfStudyRelatedSeries":{ @@ -804,7 +818,7 @@ "type":"string", "max":256, "min":0, - "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", + "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[0-9][0-9]*|0))*", "sensitive":true }, "DICOMSeriesModality":{ @@ -843,13 +857,13 @@ }, "DICOMStudyDescription":{ "type":"string", - "max":64, + "max":256, "min":0, "sensitive":true }, "DICOMStudyId":{ "type":"string", - "max":16, + "max":256, "min":0, "sensitive":true }, @@ -857,7 +871,7 @@ "type":"string", "max":256, "min":0, - "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", + "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[0-9][0-9]*|0))*", "sensitive":true }, "DICOMStudyTime":{ @@ -984,6 +998,10 @@ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.
" }, + "lambdaAuthorizerArn":{ + "shape":"LambdaArn", + "documentation":"The ARN of the authorizer's Lambda function.
" + }, "datastoreArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) for the data store.
" @@ -1461,7 +1479,10 @@ "UPDATED", "UPDATE_FAILED", "DELETING", - "DELETED" + "DELETED", + "IMPORTING", + "IMPORTED", + "IMPORT_FAILED" ] }, "ImageSetsMetadataSummaries":{ @@ -1542,6 +1563,10 @@ "min":1, "pattern":"arn:aws[a-zA-Z-]{0,16}:kms:[a-z]{2}(-[a-z]{1,16}){1,3}-\\d{1}:\\d{12}:((key/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})|(alias/[a-zA-Z0-9:/_-]{1,256}))" }, + "LambdaArn":{ + "type":"string", + "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, "ListDICOMImportJobsRequest":{ "type":"structure", "required":["datastoreId"], diff --git a/services/memorydb/pom.xml b/services/memorydb/pom.xml index e48f98bd1c80..54d8ec7fa166 100644 --- a/services/memorydb/pom.xml +++ b/services/memorydb/pom.xml @@ -21,7 +21,7 @@The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.
Constraints:
Must specify a valid system snapshot in the \"available\" state.
Specify a valid DB snapshot identifier.
Example: my-cluster-snapshot1
The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. If the source DB cluster snapshot is in a different region or owned by another account, specify the snapshot ARN.
Constraints:
Must specify a valid system snapshot in the \"available\" state.
Specify a valid DB snapshot identifier.
Example: my-cluster-snapshot1
Deletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment.
After you delete a transit gateway attachment, raffic will no longer flow through the firewall endpoints.
After you initiate the delete operation, use DescribeFirewall to monitor the deletion status.
" + "documentation":"Deletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment.
After you delete a transit gateway attachment, traffic will no longer flow through the firewall endpoints.
After you initiate the delete operation, use DescribeFirewall to monitor the deletion status.
" }, "DeleteResourcePolicy":{ "name":"DeleteResourcePolicy", @@ -695,7 +695,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"Rejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints.
Only the firewall owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment.
Use DescribeFirewall to monitor the rejection status. To accept the attachment instead of rejecting it, use AcceptNetworkFirewallTransitGatewayAttachment.
Once rejected, you cannot reverse this action. To establish connectivity, you must create a new transit gateway-attached firewall.
Rejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints.
Only the transit gateway owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment.
Use DescribeFirewall to monitor the rejection status. To accept the attachment instead of rejecting it, use AcceptNetworkFirewallTransitGatewayAttachment.
Once rejected, you cannot reverse this action. To establish connectivity, you must create a new transit gateway-attached firewall.
Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone independence.
You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection
setting controls whether you can make these modifications.
Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.
You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection
setting controls whether you can make these modifications.
Contains variables that you can use to override default Suricata settings in your firewall policy.
" + }, + "EnableTLSSessionHolding":{ + "shape":"EnableTLSSessionHolding", + "documentation":"When true, prevents TCP and TLS packets from reaching destination servers until TLS Inspection has evaluated Server Name Indication (SNI) rules. Requires an associated TLS Inspection configuration.
" } }, "documentation":"The firewall policy defines the behavior of a firewall using a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
This, along with FirewallPolicyResponse, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
" @@ -2851,7 +2856,9 @@ "type":"string", "enum":[ "ALLOWLIST", - "DENYLIST" + "DENYLIST", + "REJECTLIST", + "ALERTLIST" ] }, "GetAnalysisReportResultsRequest":{ @@ -4077,7 +4084,7 @@ }, "GeneratedRulesType":{ "shape":"GeneratedRulesType", - "documentation":"Whether you want to allow or deny access to the domains in your target list.
" + "documentation":"Whether you want to apply allow, reject, alert, or drop behavior to the domains in your target list.
When logging is enabled and you choose Alert, traffic that matches the domain specifications generates an alert in the firewall's logs. Then, traffic either passes, is rejected, or drops based on other rules in the firewall policy.
Stateful inspection criteria for a domain list rule group.
For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET
rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.
Creates a centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.
" + }, "CreateTelemetryRule":{ "name":"CreateTelemetryRule", "http":{ @@ -51,6 +70,23 @@ ], "documentation":"Creates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.
" }, + "DeleteCentralizationRuleForOrganization":{ + "name":"DeleteCentralizationRuleForOrganization", + "http":{ + "method":"POST", + "requestUri":"/DeleteCentralizationRuleForOrganization", + "responseCode":200 + }, + "input":{"shape":"DeleteCentralizationRuleForOrganizationInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"Deletes an organization-wide centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.
" + }, "DeleteTelemetryRule":{ "name":"DeleteTelemetryRule", "http":{ @@ -85,6 +121,24 @@ ], "documentation":"Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.
" }, + "GetCentralizationRuleForOrganization":{ + "name":"GetCentralizationRuleForOrganization", + "http":{ + "method":"POST", + "requestUri":"/GetCentralizationRuleForOrganization", + "responseCode":200 + }, + "input":{"shape":"GetCentralizationRuleForOrganizationInput"}, + "output":{"shape":"GetCentralizationRuleForOrganizationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.
" + }, "GetTelemetryEvaluationStatus":{ "name":"GetTelemetryEvaluationStatus", "http":{ @@ -152,6 +206,23 @@ ], "documentation":"Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.
" }, + "ListCentralizationRulesForOrganization":{ + "name":"ListCentralizationRulesForOrganization", + "http":{ + "method":"POST", + "requestUri":"/ListCentralizationRulesForOrganization", + "responseCode":200 + }, + "input":{"shape":"ListCentralizationRulesForOrganizationInput"}, + "output":{"shape":"ListCentralizationRulesForOrganizationOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"Lists all centralization rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.
" + }, "ListResourceTelemetry":{ "name":"ListResourceTelemetry", "http":{ @@ -333,6 +404,25 @@ ], "documentation":"Removes tags from a telemetry rule resource.
" }, + "UpdateCentralizationRuleForOrganization":{ + "name":"UpdateCentralizationRuleForOrganization", + "http":{ + "method":"POST", + "requestUri":"/UpdateCentralizationRuleForOrganization", + "responseCode":200 + }, + "input":{"shape":"UpdateCentralizationRuleForOrganizationInput"}, + "output":{"shape":"UpdateCentralizationRuleForOrganizationOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"Updates an existing centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.
" + }, "UpdateTelemetryRule":{ "name":"UpdateTelemetryRule", "http":{ @@ -403,6 +493,124 @@ "max":10, "min":1 }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CentralizationFailureReason":{ + "type":"string", + "enum":[ + "TRUSTED_ACCESS_NOT_ENABLED", + "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION", + "INTERNAL_SERVER_ERROR" + ] + }, + "CentralizationRule":{ + "type":"structure", + "required":[ + "Source", + "Destination" + ], + "members":{ + "Source":{ + "shape":"CentralizationRuleSource", + "documentation":"Configuration determining the source of the telemetry data to be centralized.
" + }, + "Destination":{ + "shape":"CentralizationRuleDestination", + "documentation":"Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.
" + } + }, + "documentation":"Defines how telemetry data should be centralized across an Amazon Web Services Organization, including source and destination configurations.
" + }, + "CentralizationRuleDestination":{ + "type":"structure", + "required":["Region"], + "members":{ + "Region":{ + "shape":"Region", + "documentation":"The primary destination region to which telemetry data should be centralized.
" + }, + "Account":{ + "shape":"AccountIdentifier", + "documentation":"The destination account (within the organization) to which the telemetry data should be centralized.
" + }, + "DestinationLogsConfiguration":{ + "shape":"DestinationLogsConfiguration", + "documentation":"Log specific configuration for centralization destination log groups.
" + } + }, + "documentation":"Configuration specifying the primary destination for centralized telemetry data.
" + }, + "CentralizationRuleSource":{ + "type":"structure", + "required":["Regions"], + "members":{ + "Regions":{ + "shape":"Regions", + "documentation":"The list of source regions from which telemetry data should be centralized.
" + }, + "Scope":{ + "shape":"SourceFilterString", + "documentation":"The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.
" + }, + "SourceLogsConfiguration":{ + "shape":"SourceLogsConfiguration", + "documentation":"Log specific configuration for centralization source log groups.
" + } + }, + "documentation":"Configuration specifying the source of telemetry data to be centralized.
" + }, + "CentralizationRuleSummaries":{ + "type":"list", + "member":{"shape":"CentralizationRuleSummary"} + }, + "CentralizationRuleSummary":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"The name of the organization centralization rule.
" + }, + "RuleArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the organization centralization rule.
" + }, + "CreatorAccountId":{ + "shape":"String", + "documentation":"The Amazon Web Services Account that created the organization centralization rule.
" + }, + "CreatedTimeStamp":{ + "shape":"Long", + "documentation":"The timestamp when the organization centralization rule was created.
" + }, + "CreatedRegion":{ + "shape":"Region", + "documentation":"The Amazon Web Services region where the organization centralization rule was created.
" + }, + "LastUpdateTimeStamp":{ + "shape":"Long", + "documentation":"The timestamp when the organization centralization rule was last updated.
" + }, + "RuleHealth":{ + "shape":"RuleHealth", + "documentation":"The health status of the organization centralization rule.
" + }, + "FailureReason":{ + "shape":"CentralizationFailureReason", + "documentation":"The reason why an organization centralization rule is marked UNHEALTHY.
" + }, + "DestinationAccountId":{ + "shape":"String", + "documentation":"The primary destination account of the organization centralization rule.
" + }, + "DestinationRegion":{ + "shape":"Region", + "documentation":"The primary destination region of the organization centralization rule.
" + } + }, + "documentation":"A summary of a centralization rule's key properties and status.
" + }, "ConflictException":{ "type":"structure", "members":{ @@ -415,6 +623,36 @@ }, "exception":true }, + "CreateCentralizationRuleForOrganizationInput":{ + "type":"structure", + "required":[ + "RuleName", + "Rule" + ], + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"A unique name for the organization-wide centralization rule being created.
" + }, + "Rule":{ + "shape":"CentralizationRule", + "documentation":"The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.
" + }, + "Tags":{ + "shape":"TagMapInput", + "documentation":"The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.
" + } + } + }, + "CreateCentralizationRuleForOrganizationOutput":{ + "type":"structure", + "members":{ + "RuleArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the created organization centralization rule.
" + } + } + }, "CreateTelemetryRuleForOrganizationInput":{ "type":"structure", "required":[ @@ -475,6 +713,16 @@ } } }, + "DeleteCentralizationRuleForOrganizationInput":{ + "type":"structure", + "required":["RuleIdentifier"], + "members":{ + "RuleIdentifier":{ + "shape":"RuleIdentifier", + "documentation":"The identifier (name or ARN) of the organization centralization rule to delete.
" + } + } + }, "DeleteTelemetryRuleForOrganizationInput":{ "type":"structure", "required":["RuleIdentifier"], @@ -495,11 +743,97 @@ } } }, + "DestinationLogsConfiguration":{ + "type":"structure", + "members":{ + "LogsEncryptionConfiguration":{ + "shape":"LogsEncryptionConfiguration", + "documentation":"The encryption configuration for centralization destination log groups.
" + }, + "BackupConfiguration":{ + "shape":"LogsBackupConfiguration", + "documentation":"Configuration defining the backup region and an optional KMS key for the backup destination.
" + } + }, + "documentation":"Configuration for centralization destination log groups, including encryption and backup settings.
" + }, "DestinationType":{ "type":"string", "enum":["cloud-watch-logs"] }, + "EncryptedLogGroupStrategy":{ + "type":"string", + "enum":[ + "ALLOW", + "SKIP" + ] + }, + "EncryptionConflictResolutionStrategy":{ + "type":"string", + "enum":[ + "ALLOW", + "SKIP" + ] + }, + "EncryptionStrategy":{ + "type":"string", + "enum":[ + "CUSTOMER_MANAGED", + "AWS_OWNED" + ] + }, "FailureReason":{"type":"string"}, + "GetCentralizationRuleForOrganizationInput":{ + "type":"structure", + "required":["RuleIdentifier"], + "members":{ + "RuleIdentifier":{ + "shape":"RuleIdentifier", + "documentation":"The identifier (name or ARN) of the organization centralization rule to retrieve.
" + } + } + }, + "GetCentralizationRuleForOrganizationOutput":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"The name of the organization centralization rule.
" + }, + "RuleArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the organization centralization rule.
" + }, + "CreatorAccountId":{ + "shape":"String", + "documentation":"The Amazon Web Services Account that created the organization centralization rule.
" + }, + "CreatedTimeStamp":{ + "shape":"Long", + "documentation":"The timestamp when the organization centralization rule was created.
" + }, + "CreatedRegion":{ + "shape":"Region", + "documentation":"The Amazon Web Services region where the organization centralization rule was created.
" + }, + "LastUpdateTimeStamp":{ + "shape":"Long", + "documentation":"The timestamp when the organization centralization rule was last updated.
" + }, + "RuleHealth":{ + "shape":"RuleHealth", + "documentation":"The health status of the organization centralization rule.
" + }, + "FailureReason":{ + "shape":"CentralizationFailureReason", + "documentation":"The reason why an organization centralization rule is marked UNHEALTHY.
" + }, + "CentralizationRule":{ + "shape":"CentralizationRule", + "documentation":"The configuration details for the organization centralization rule.
" + } + } + }, "GetTelemetryEvaluationStatusForOrganizationOutput":{ "type":"structure", "members":{ @@ -616,6 +950,51 @@ "exception":true, "fault":true }, + "ListCentralizationRulesForOrganizationInput":{ + "type":"structure", + "members":{ + "RuleNamePrefix":{ + "shape":"ListCentralizationRulesForOrganizationInputRuleNamePrefixString", + "documentation":"A string to filter organization centralization rules whose names begin with the specified prefix.
" + }, + "AllRegions":{ + "shape":"Boolean", + "documentation":"A flag determining whether to return organization centralization rules from all regions or only the current region.
" + }, + "MaxResults":{ + "shape":"ListCentralizationRulesForOrganizationMaxResults", + "documentation":"The maximum number of organization centralization rules to return in a single call.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. A previous call generates this token.
" + } + } + }, + "ListCentralizationRulesForOrganizationInputRuleNamePrefixString":{ + "type":"string", + "max":100, + "min":1 + }, + "ListCentralizationRulesForOrganizationMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListCentralizationRulesForOrganizationOutput":{ + "type":"structure", + "members":{ + "CentralizationRuleSummaries":{ + "shape":"CentralizationRuleSummaries", + "documentation":"A list of centralization rule summaries.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"A token to resume pagination of results.
" + } + } + }, "ListResourceTelemetryForOrganizationInput":{ "type":"structure", "members":{ @@ -816,6 +1195,45 @@ } } }, + "LogsBackupConfiguration":{ + "type":"structure", + "required":["Region"], + "members":{ + "Region":{ + "shape":"Region", + "documentation":"Logs specific backup destination region within the primary destination account to which log data should be centralized.
" + }, + "KmsKeyArn":{ + "shape":"ResourceArn", + "documentation":"KMS Key arn belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.
" + } + }, + "documentation":"Configuration for backing up centralized log data to a secondary region.
" + }, + "LogsEncryptionConfiguration":{ + "type":"structure", + "required":["EncryptionStrategy"], + "members":{ + "EncryptionStrategy":{ + "shape":"EncryptionStrategy", + "documentation":"Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
" + }, + "KmsKeyArn":{ + "shape":"ResourceArn", + "documentation":"KMS Key arn belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
" + }, + "EncryptionConflictResolutionStrategy":{ + "shape":"EncryptionConflictResolutionStrategy", + "documentation":"Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.
" + } + }, + "documentation":"Configuration for encrypting centralized log groups. This configuration is only applied to destination log groups for which the corresponding source log groups are encrypted using Customer Managed KMS Keys.
" + }, + "LogsFilterString":{ + "type":"string", + "max":2000, + "min":1 + }, "Long":{ "type":"long", "box":true @@ -830,11 +1248,20 @@ "member":{"shape":"OrganizationUnitIdentifier"}, "min":1 }, + "Region":{ + "type":"string", + "min":1 + }, + "Regions":{ + "type":"list", + "member":{"shape":"Region"}, + "min":1 + }, "ResourceArn":{ "type":"string", "max":1011, "min":1, - "pattern":"arn:aws:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)" + "pattern":"arn:aws([a-z0-9\\-]+)?:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)" }, "ResourceIdentifier":{"type":"string"}, "ResourceIdentifierPrefix":{ @@ -874,6 +1301,14 @@ "max":3653, "min":1 }, + "RuleHealth":{ + "type":"string", + "enum":[ + "Healthy", + "Unhealthy", + "Provisioning" + ] + }, "RuleIdentifier":{ "type":"string", "max":1011, @@ -883,7 +1318,7 @@ "type":"string", "max":100, "min":1, - "pattern":"[0-9A-Za-z-]+" + "pattern":"[0-9A-Za-z-_.#/]+" }, "ServiceQuotaExceededException":{ "type":"structure", @@ -903,6 +1338,29 @@ }, "exception":true }, + "SourceFilterString":{ + "type":"string", + "max":2000, + "min":1 + }, + "SourceLogsConfiguration":{ + "type":"structure", + "required":[ + "LogGroupSelectionCriteria", + "EncryptedLogGroupStrategy" + ], + "members":{ + "LogGroupSelectionCriteria":{ + "shape":"LogsFilterString", + "documentation":"The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
" + }, + "EncryptedLogGroupStrategy":{ + "shape":"EncryptedLogGroupStrategy", + "documentation":"A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.
" + } + }, + "documentation":"Configuration for selecting and handling source log groups for centralization.
" + }, "Status":{ "type":"string", "enum":[ @@ -1130,6 +1588,32 @@ } } }, + "UpdateCentralizationRuleForOrganizationInput":{ + "type":"structure", + "required":[ + "RuleIdentifier", + "Rule" + ], + "members":{ + "RuleIdentifier":{ + "shape":"RuleIdentifier", + "documentation":"The identifier (name or ARN) of the organization centralization rule to update.
" + }, + "Rule":{ + "shape":"CentralizationRule", + "documentation":"The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.
" + } + } + }, + "UpdateCentralizationRuleForOrganizationOutput":{ + "type":"structure", + "members":{ + "RuleArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the updated organization centralization rule.
" + } + } + }, "UpdateTelemetryRuleForOrganizationInput":{ "type":"structure", "required":[ diff --git a/services/odb/pom.xml b/services/odb/pom.xml index 89912efb66f9..d2a2d6fe494c 100644 --- a/services/odb/pom.xml +++ b/services/odb/pom.xml @@ -17,7 +17,7 @@Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
" }, + "CreatePipelineEndpoint":{ + "name":"CreatePipelineEndpoint", + "http":{ + "method":"POST", + "requestUri":"/2022-01-01/osis/createPipelineEndpoint" + }, + "input":{"shape":"CreatePipelineEndpointRequest"}, + "output":{"shape":"CreatePipelineEndpointResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Creates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to ingest data from your VPC into pipelines that you have access to.
" + }, "DeletePipeline":{ "name":"DeletePipeline", "http":{ @@ -49,6 +67,42 @@ ], "documentation":"Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
" }, + "DeletePipelineEndpoint":{ + "name":"DeletePipelineEndpoint", + "http":{ + "method":"DELETE", + "requestUri":"/2022-01-01/osis/deletePipelineEndpoint/{EndpointId}" + }, + "input":{"shape":"DeletePipelineEndpointRequest"}, + "output":{"shape":"DeletePipelineEndpointResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.
", + "idempotent":true + }, + "DeleteResourcePolicy":{ + "name":"DeleteResourcePolicy", + "http":{ + "method":"DELETE", + "requestUri":"/2022-01-01/osis/resourcePolicy/{ResourceArn}" + }, + "input":{"shape":"DeleteResourcePolicyRequest"}, + "output":{"shape":"DeleteResourcePolicyResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a resource-based policy from an OpenSearch Ingestion resource.
", + "idempotent":true + }, "GetPipeline":{ "name":"GetPipeline", "http":{ @@ -100,6 +154,24 @@ ], "documentation":"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.
" }, + "GetResourcePolicy":{ + "name":"GetResourcePolicy", + "http":{ + "method":"GET", + "requestUri":"/2022-01-01/osis/resourcePolicy/{ResourceArn}" + }, + "input":{"shape":"GetResourcePolicyRequest"}, + "output":{"shape":"GetResourcePolicyResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the resource-based policy attached to an OpenSearch Ingestion resource.
" + }, "ListPipelineBlueprints":{ "name":"ListPipelineBlueprints", "http":{ @@ -117,6 +189,40 @@ ], "documentation":"Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
" }, + "ListPipelineEndpointConnections":{ + "name":"ListPipelineEndpointConnections", + "http":{ + "method":"GET", + "requestUri":"/2022-01-01/osis/listPipelineEndpointConnections" + }, + "input":{"shape":"ListPipelineEndpointConnectionsRequest"}, + "output":{"shape":"ListPipelineEndpointConnectionsResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the pipeline endpoints connected to pipelines in your account.
" + }, + "ListPipelineEndpoints":{ + "name":"ListPipelineEndpoints", + "http":{ + "method":"GET", + "requestUri":"/2022-01-01/osis/listPipelineEndpoints" + }, + "input":{"shape":"ListPipelineEndpointsRequest"}, + "output":{"shape":"ListPipelineEndpointsResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all pipeline endpoints in your account.
" + }, "ListPipelines":{ "name":"ListPipelines", "http":{ @@ -151,6 +257,43 @@ ], "documentation":"Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
" }, + "PutResourcePolicy":{ + "name":"PutResourcePolicy", + "http":{ + "method":"PUT", + "requestUri":"/2022-01-01/osis/resourcePolicy/{ResourceArn}" + }, + "input":{"shape":"PutResourcePolicyRequest"}, + "output":{"shape":"PutResourcePolicyResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Attaches a resource-based policy to an OpenSearch Ingestion resource. Resource-based policies grant permissions to principals to perform actions on the resource.
", + "idempotent":true + }, + "RevokePipelineEndpointConnections":{ + "name":"RevokePipelineEndpointConnections", + "http":{ + "method":"POST", + "requestUri":"/2022-01-01/osis/revokePipelineEndpointConnections" + }, + "input":{"shape":"RevokePipelineEndpointConnectionsRequest"}, + "output":{"shape":"RevokePipelineEndpointConnectionsResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Revokes pipeline endpoints from specified endpoint IDs.
", + "idempotent":true + }, "StartPipeline":{ "name":"StartPipeline", "http":{ @@ -265,6 +408,12 @@ "error":{"httpStatusCode":403}, "exception":true }, + "AwsAccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^\\\\d{12}$" + }, "BlueprintFormat":{ "type":"string", "pattern":"(YAML|JSON)" @@ -373,6 +522,44 @@ "error":{"httpStatusCode":409}, "exception":true }, + "CreatePipelineEndpointRequest":{ + "type":"structure", + "required":[ + "PipelineArn", + "VpcOptions" + ], + "members":{ + "PipelineArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline to create the endpoint for.
" + }, + "VpcOptions":{ + "shape":"PipelineEndpointVpcOptions", + "documentation":"Container for the VPC configuration for the pipeline endpoint, including subnet IDs and security group IDs.
" + } + } + }, + "CreatePipelineEndpointResponse":{ + "type":"structure", + "members":{ + "PipelineArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline associated with the endpoint.
" + }, + "EndpointId":{ + "shape":"PipelineEndpointId", + "documentation":"The unique identifier of the pipeline endpoint.
" + }, + "Status":{ + "shape":"PipelineEndpointStatus", + "documentation":"The current status of the pipeline endpoint.
" + }, + "VpcId":{ + "shape":"String", + "documentation":"The ID of the VPC where the pipeline endpoint was created.
" + } + } + }, "CreatePipelineRequest":{ "type":"structure", "required":[ @@ -420,7 +607,7 @@ }, "PipelineRoleArn":{ "shape":"PipelineRoleArn", - "documentation":"The Amazon Resource Name (ARN) of an IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. For more information, see Setting up roles and users in Amazon OpenSearch Ingestion.
" + "documentation":"The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources.
" } } }, @@ -433,6 +620,22 @@ } } }, + "DeletePipelineEndpointRequest":{ + "type":"structure", + "required":["EndpointId"], + "members":{ + "EndpointId":{ + "shape":"PipelineEndpointId", + "documentation":"The unique identifier of the pipeline endpoint to delete.
", + "location":"uri", + "locationName":"EndpointId" + } + } + }, + "DeletePipelineEndpointResponse":{ + "type":"structure", + "members":{} + }, "DeletePipelineRequest":{ "type":"structure", "required":["PipelineName"], @@ -449,6 +652,22 @@ "type":"structure", "members":{} }, + "DeleteResourcePolicyRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the resource from which to delete the policy.
", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "DeleteResourcePolicyResponse":{ + "type":"structure", + "members":{} + }, "DisabledOperationException":{ "type":"structure", "members":{}, @@ -540,6 +759,31 @@ } } }, + "GetResourcePolicyRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the resource for which to retrieve the policy.
", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "GetResourcePolicyResponse":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The resource-based policy document in JSON format.
" + } + } + }, "IngestEndpointUrlsList":{ "type":"list", "member":{"shape":"String"} @@ -584,6 +828,66 @@ } } }, + "ListPipelineEndpointConnectionsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of pipeline endpoint connections to return in the response.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If your initial ListPipelineEndpointConnections
operation returns a nextToken
, you can include the returned nextToken
in subsequent ListPipelineEndpointConnections
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.
A list of pipeline endpoint connections.
" + } + } + }, + "ListPipelineEndpointsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of pipeline endpoints to return in the response.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If your initial ListPipelineEndpoints
operation returns a NextToken
, you can include the returned NextToken
in subsequent ListPipelineEndpoints
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.
A list of pipeline endpoints.
" + } + } + }, "ListPipelinesRequest":{ "type":"structure", "members":{ @@ -737,7 +1041,7 @@ }, "PipelineRoleArn":{ "shape":"PipelineRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that provides the required permissions for a pipeline to read from the source and write to the sink.
" + "documentation":"The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.
" } }, "documentation":"Information about an existing OpenSearch Ingestion pipeline.
" @@ -831,6 +1135,101 @@ "type":"list", "member":{"shape":"PipelineDestination"} }, + "PipelineEndpoint":{ + "type":"structure", + "members":{ + "PipelineArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline associated with this endpoint.
" + }, + "EndpointId":{ + "shape":"PipelineEndpointId", + "documentation":"The unique identifier for the pipeline endpoint.
" + }, + "Status":{ + "shape":"PipelineEndpointStatus", + "documentation":"The current status of the pipeline endpoint.
" + }, + "VpcId":{ + "shape":"String", + "documentation":"The ID of the VPC where the pipeline endpoint is created.
" + }, + "VpcOptions":{ + "shape":"PipelineEndpointVpcOptions", + "documentation":"Configuration options for the VPC endpoint, including subnet and security group settings.
" + }, + "IngestEndpointUrl":{ + "shape":"String", + "documentation":"The URL used to ingest data to the pipeline through the VPC endpoint.
" + } + }, + "documentation":"Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private connectivity between your VPC and the pipeline.
" + }, + "PipelineEndpointConnection":{ + "type":"structure", + "members":{ + "PipelineArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline in the endpoint connection.
" + }, + "EndpointId":{ + "shape":"PipelineEndpointId", + "documentation":"The unique identifier of the endpoint in the connection.
" + }, + "Status":{ + "shape":"PipelineEndpointStatus", + "documentation":"The current status of the pipeline endpoint connection.
" + }, + "VpcEndpointOwner":{ + "shape":"AwsAccountId", + "documentation":"The Amazon Web Services account ID that owns the VPC endpoint used in this connection.
" + } + }, + "documentation":"Represents a connection to a pipeline endpoint, containing details about the endpoint association.
" + }, + "PipelineEndpointConnectionsSummaryList":{ + "type":"list", + "member":{"shape":"PipelineEndpointConnection"} + }, + "PipelineEndpointId":{ + "type":"string", + "max":512, + "min":3, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-_]+$" + }, + "PipelineEndpointIdsList":{ + "type":"list", + "member":{"shape":"PipelineEndpointId"} + }, + "PipelineEndpointStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "CREATE_FAILED", + "DELETING", + "REVOKING", + "REVOKED" + ] + }, + "PipelineEndpointVpcOptions":{ + "type":"structure", + "members":{ + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"A list of subnet IDs where the pipeline endpoint network interfaces are created.
" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"A list of security group IDs that control network access to the pipeline endpoint.
" + } + }, + "documentation":"Configuration settings for the VPC endpoint, specifying network access controls.
" + }, + "PipelineEndpointsSummaryList":{ + "type":"list", + "member":{"shape":"PipelineEndpoint"} + }, "PipelineName":{ "type":"string", "max":28, @@ -919,6 +1318,38 @@ "type":"integer", "min":1 }, + "PutResourcePolicyRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Policy" + ], + "members":{ + "ResourceArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the resource to attach the policy to.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The resource-based policy document in JSON format.
" + } + } + }, + "PutResourcePolicyResponse":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The resource-based policy document that was attached to the resource.
" + } + } + }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{}, @@ -933,6 +1364,37 @@ "error":{"httpStatusCode":404}, "exception":true }, + "ResourcePolicy":{ + "type":"string", + "max":204800, + "min":2 + }, + "RevokePipelineEndpointConnectionsRequest":{ + "type":"structure", + "required":[ + "PipelineArn", + "EndpointIds" + ], + "members":{ + "PipelineArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline from which to revoke endpoint connections.
" + }, + "EndpointIds":{ + "shape":"PipelineEndpointIdsList", + "documentation":"A list of endpoint IDs for which to revoke access to the pipeline.
" + } + } + }, + "RevokePipelineEndpointConnectionsResponse":{ + "type":"structure", + "members":{ + "PipelineArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline from which endpoint connections were revoked.
" + } + } + }, "SecurityGroupId":{ "type":"string", "max":20, @@ -1133,7 +1595,7 @@ }, "PipelineRoleArn":{ "shape":"PipelineRoleArn", - "documentation":"The Amazon Resource Name (ARN) of an IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. For more information, see Setting up roles and users in Amazon OpenSearch Ingestion.
" + "documentation":"The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources.
" } } }, diff --git a/services/outposts/pom.xml b/services/outposts/pom.xml index 539757861157..20b8ee62cf9f 100644 --- a/services/outposts/pom.xml +++ b/services/outposts/pom.xml @@ -21,7 +21,7 @@Gets the Amazon Web Services Payment Cryptography key associated with the alias.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, + "GetCertificateSigningRequest":{ + "name":"GetCertificateSigningRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCertificateSigningRequestInput"}, + "output":{"shape":"GetCertificateSigningRequestOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Used to retrieve the public key for a keypair.
" + }, "GetDefaultKeyReplicationRegions":{ "name":"GetDefaultKeyReplicationRegions", "http":{ @@ -564,6 +582,90 @@ "type":"boolean", "box":true }, + "CertificateSigningRequestType":{ + "type":"string", + "max":32768, + "min":1, + "pattern":"[^\\[;\\]<>]+", + "sensitive":true + }, + "CertificateSubjectType":{ + "type":"structure", + "required":["CommonName"], + "members":{ + "CommonName":{ + "shape":"CertificateSubjectTypeCommonNameString", + "documentation":"Common Name to be used in the certificate signing request
" + }, + "OrganizationUnit":{ + "shape":"CertificateSubjectTypeOrganizationUnitString", + "documentation":"Organization Unit to be used in the certificate signing request
" + }, + "Organization":{ + "shape":"CertificateSubjectTypeOrganizationString", + "documentation":"Organization to be used in the certificate signing request
" + }, + "City":{ + "shape":"CertificateSubjectTypeCityString", + "documentation":"City to be used in the certificate signing request
" + }, + "Country":{ + "shape":"CertificateSubjectTypeCountryString", + "documentation":"Country to be used in the certificate signing request
" + }, + "StateOrProvince":{ + "shape":"CertificateSubjectTypeStateOrProvinceString", + "documentation":"State Or Province to be used in the certificate signing request
" + }, + "EmailAddress":{ + "shape":"CertificateSubjectTypeEmailAddressString", + "documentation":"Email to be used in the certificate signing request
" + } + }, + "documentation":"Metadata used in generating the CSR
" + }, + "CertificateSubjectTypeCityString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[A-Za-z]+" + }, + "CertificateSubjectTypeCommonNameString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z]+" + }, + "CertificateSubjectTypeCountryString":{ + "type":"string", + "max":2, + "min":2, + "pattern":"[A-Za-z]+" + }, + "CertificateSubjectTypeEmailAddressString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*" + }, + "CertificateSubjectTypeOrganizationString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z]+" + }, + "CertificateSubjectTypeOrganizationUnitString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z]+" + }, + "CertificateSubjectTypeStateOrProvinceString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[A-Za-z]+" + }, "CertificateType":{ "type":"string", "max":32768, @@ -943,7 +1045,6 @@ "required":[ "CertificateAuthorityPublicKeyIdentifier", "WrappingKeyCertificate", - "ExportToken", "KeyBlockFormat" ], "members":{ @@ -959,6 +1060,14 @@ "shape":"ExportTokenId", "documentation":"The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 30 days. You can use the same export token to export multiple keys from the same service account.
" }, + "SigningKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"Key Identifier used for signing the export key
" + }, + "SigningKeyCertificate":{ + "shape":"CertificateType", + "documentation":"Certificate used for signing the export key
" + }, "KeyBlockFormat":{ "shape":"Tr34KeyBlockFormat", "documentation":"The format of key block that Amazon Web Services Payment Cryptography will use during key export.
" @@ -994,6 +1103,38 @@ } } }, + "GetCertificateSigningRequestInput":{ + "type":"structure", + "required":[ + "KeyIdentifier", + "SigningAlgorithm", + "CertificateSubject" + ], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"Asymmetric key used for generating the certificate signing request
" + }, + "SigningAlgorithm":{ + "shape":"SigningAlgorithmType", + "documentation":"Algorithm used to generate the certificate signing request
" + }, + "CertificateSubject":{ + "shape":"CertificateSubjectType", + "documentation":"Certificate subject data
" + } + } + }, + "GetCertificateSigningRequestOutput":{ + "type":"structure", + "required":["CertificateSigningRequest"], + "members":{ + "CertificateSigningRequest":{ + "shape":"CertificateSigningRequestType", + "documentation":"Certificate signing request
" + } + } + }, "GetDefaultKeyReplicationRegionsInput":{ "type":"structure", "members":{}, @@ -1329,7 +1470,6 @@ "required":[ "CertificateAuthorityPublicKeyIdentifier", "SigningKeyCertificate", - "ImportToken", "WrappedKeyBlock", "KeyBlockFormat" ], @@ -1346,6 +1486,14 @@ "shape":"ImportTokenId", "documentation":"The import token that initiates key import using the asymmetric TR-34 key exchange method into Amazon Web Services Payment Cryptography. It expires after 30 days. You can use the same import token to import multiple keys to the same service account.
" }, + "WrappingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"Key Identifier used for unwrapping the import key
" + }, + "WrappingKeyCertificate":{ + "shape":"CertificateType", + "documentation":"Key Identifier used for unwrapping the import key
" + }, "WrappedKeyBlock":{ "shape":"Tr34WrappedKeyBlock", "documentation":"The TR-34 wrapped key block to import.
" @@ -1704,7 +1852,10 @@ "shape":"Boolean", "documentation":"Specifies whether the key is enabled.
" }, - "MultiRegionKeyType":{"shape":"MultiRegionKeyType"}, + "MultiRegionKeyType":{ + "shape":"MultiRegionKeyType", + "documentation":"Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.
Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).
" + }, "PrimaryRegion":{"shape":"Region"} }, "documentation":"Metadata about an Amazon Web Services Payment Cryptography key.
" @@ -1928,7 +2079,10 @@ "type":"structure", "required":["Status"], "members":{ - "Status":{"shape":"KeyReplicationState"}, + "Status":{ + "shape":"KeyReplicationState", + "documentation":"The current status of key replication in this region.
This field indicates whether the key replication is in progress, completed successfully, or has encountered an error. Possible values include states such as SYNCRHONIZED, IN_PROGRESS, DELETE_IN_PROGRESS, or FAILED. This provides visibility into the replication process for monitoring and troubleshooting purposes.
" + }, "StatusMessage":{ "shape":"String", "documentation":"A message that provides additional information about the current replication status of the key.
This field contains details about any issues or progress updates related to key replication operations. It may include information about replication failures, synchronization status, or other operational details.
" @@ -2014,6 +2168,16 @@ "min":2, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+" }, + "SigningAlgorithmType":{ + "type":"string", + "documentation":"Defines the Algorithm used to generate the certificate signing request
", + "enum":[ + "SHA224", + "SHA256", + "SHA384", + "SHA512" + ] + }, "StartKeyUsageInput":{ "type":"structure", "required":["KeyIdentifier"], diff --git a/services/paymentcryptographydata/pom.xml b/services/paymentcryptographydata/pom.xml index bb9908e67baa..4f8099287479 100644 --- a/services/paymentcryptographydata/pom.xml +++ b/services/paymentcryptographydata/pom.xml @@ -21,7 +21,7 @@Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
" + "documentation":"Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.
" }, "customLaunchTemplate":{"shape":"CustomLaunchTemplate"}, "iamInstanceProfileArn":{ @@ -649,7 +649,7 @@ "scalingConfiguration":{"shape":"ScalingConfiguration"}, "instanceConfigs":{ "shape":"InstanceList", - "documentation":"A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
" + "documentation":"A list of EC2 instance configurations that PCS can provision in the compute node group.
" }, "spotOptions":{"shape":"SpotOptions"}, "slurmConfiguration":{"shape":"ComputeNodeGroupSlurmConfiguration"}, @@ -866,7 +866,7 @@ }, "purchaseOption":{ "shape":"PurchaseOption", - "documentation":"Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
" + "documentation":"Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.
" }, "customLaunchTemplate":{"shape":"CustomLaunchTemplate"}, "iamInstanceProfileArn":{ @@ -879,7 +879,7 @@ }, "instanceConfigs":{ "shape":"InstanceList", - "documentation":"A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
" + "documentation":"A list of EC2 instance configurations that PCS can provision in the compute node group.
" }, "spotOptions":{"shape":"SpotOptions"}, "slurmConfiguration":{ @@ -1332,7 +1332,7 @@ "members":{ "subnetIds":{ "shape":"SubnetIdList", - "documentation":"The list of subnet IDs where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. Subnet IDs have the form subnet-0123456789abcdef0
.
Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.
Amazon Web Services PCS currently supports only 1 subnet in this list.
The list of subnet IDs where PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and PCS resources. Subnet IDs have the form subnet-0123456789abcdef0
.
Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.
PCS currently supports only 1 subnet in this list.
The Amazon Resource Name (ARN) of the the shared Slurm key.
" + "documentation":"The Amazon Resource Name (ARN) of the shared Slurm key.
" }, "secretVersion":{ "shape":"String", @@ -1749,7 +1750,7 @@ "members":{ "allocationStrategy":{ "shape":"SpotAllocationStrategy", - "documentation":"The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.
" + "documentation":"The Amazon EC2 allocation strategy PCS uses to provision EC2 instances. PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.
" } }, "documentation":"Additional configuration when you specify SPOT
as the purchaseOption
for the CreateComputeNodeGroup
API action.
Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
" + "documentation":"Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.
" }, "spotOptions":{"shape":"SpotOptions"}, "scalingConfiguration":{ diff --git a/services/personalize/pom.xml b/services/personalize/pom.xml index c190525cd4e6..ec048581c065 100644 --- a/services/personalize/pom.xml +++ b/services/personalize/pom.xml @@ -21,7 +21,7 @@Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization
or UpdateAccountCustomization
API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions
API operation. To share the theme, grant permissions by using the UpdateThemePermissions
API operation.
Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization
or UpdateAccountCustomization
API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions
API operation. To share the theme, grant permissions by using the UpdateThemePermissions
API operation.
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe
and CreateAccountSubscription
actions, make sure that both actions are set to Allow
. If either action is set to Deny
, the Deny
action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
" + "documentation":"Creates an QuickSight account, or subscribes to QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for QuickSight in the QuickSight User Guide.
If your IAM policy includes both the Subscribe
and CreateAccountSubscription
actions, make sure that both actions are set to Allow
. If either action is set to Deny
, the Deny
action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to QuickSight, see Passing IAM roles to QuickSight in the QuickSight User Guide.
You can't set default resource access on the new account from the QuickSight API. Instead, add default resource access from the QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the QuickSight User Guide.
" }, "CreateAnalysis":{ "name":"CreateAnalysis", @@ -144,7 +144,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Creates an Amazon QuickSight brand.
" + "documentation":"Creates an QuickSight brand.
" }, "CreateCustomPermissions":{ "name":"CreateCustomPermissions", @@ -186,7 +186,7 @@ {"shape":"LimitExceededException"}, {"shape":"InternalFailureException"} ], - "documentation":"Creates a dashboard from either a template or directly with a DashboardDefinition
. To first create a template, see the CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
" + "documentation":"Creates a dashboard from either a template or directly with a DashboardDefinition
. To first create a template, see the CreateTemplate
API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
" }, "CreateDataSet":{ "name":"CreateDataSet", @@ -290,7 +290,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Use the CreateGroup
operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.
The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
" + "documentation":"Use the CreateGroup
operation to create a group in QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.
The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
" }, "CreateGroupMembership":{ "name":"CreateGroupMembership", @@ -369,7 +369,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web ServicesSupport.
" + "documentation":"(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
" }, "CreateRefreshSchedule":{ "name":"CreateRefreshSchedule", @@ -408,7 +408,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Use CreateRoleMembership
to add an existing Amazon QuickSight group to an existing role.
Use CreateRoleMembership
to add an existing QuickSight group to an existing role.
Creates a template either from a TemplateDefinition
or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
" + "documentation":"Creates a template either from a TemplateDefinition
or from an existing QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
" }, "CreateTemplateAlias":{ "name":"CreateTemplateAlias", @@ -551,6 +551,23 @@ ], "documentation":"Creates a new VPC connection.
" }, + "DeleteAccountCustomPermission":{ + "name":"DeleteAccountCustomPermission", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/custom-permission" + }, + "input":{"shape":"DeleteAccountCustomPermissionRequest"}, + "output":{"shape":"DeleteAccountCustomPermissionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Unapplies a custom permissions profile from an account.
" + }, "DeleteAccountCustomization":{ "name":"DeleteAccountCustomization", "http":{ @@ -570,7 +587,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
" + "documentation":"Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and QuickSight namespace.
" }, "DeleteAccountSubscription":{ "name":"DeleteAccountSubscription", @@ -589,7 +606,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Use the DeleteAccountSubscription
operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True
. To change this setting and delete your account, call the UpdateAccountSettings
API and set the value of the TerminationProtectionEnabled
parameter to False
, then make another call to the DeleteAccountSubscription
API.
Use the DeleteAccountSubscription
operation to delete an QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True
. To change this setting and delete your account, call the UpdateAccountSettings
API and set the value of the TerminationProtectionEnabled
parameter to False
, then make another call to the DeleteAccountSubscription
API.
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime
stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis
API operation to remove the DeletionTime
stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
" + "documentation":"Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime
stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis
API operation to remove the DeletionTime
stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
" }, "DeleteBrand":{ "name":"DeleteBrand", @@ -626,7 +643,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Deletes an Amazon QuickSight brand.
", + "documentation":"Deletes an QuickSight brand.
", "idempotent":true }, "DeleteBrandAssignment":{ @@ -756,7 +773,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Deletes a linked Amazon Q Business application from an Amazon QuickSight account
" + "documentation":"Deletes a linked Amazon Q Business application from an QuickSight account
" }, "DeleteFolder":{ "name":"DeleteFolder", @@ -868,7 +885,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
" + "documentation":"Deletes all access scopes and authorized targets that are associated with a service from the QuickSight IAM Identity Center application.
This operation is only supported for QuickSight accounts that use IAM Identity Center.
" }, "DeleteNamespace":{ "name":"DeleteNamespace", @@ -1133,6 +1150,23 @@ ], "documentation":"Deletes a VPC connection.
" }, + "DescribeAccountCustomPermission":{ + "name":"DescribeAccountCustomPermission", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/custom-permission" + }, + "input":{"shape":"DescribeAccountCustomPermissionRequest"}, + "output":{"shape":"DescribeAccountCustomPermissionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Describes the custom permissions profile that is applied to an account.
" + }, "DescribeAccountCustomization":{ "name":"DescribeAccountCustomization", "http":{ @@ -1149,7 +1183,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved
flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account
- The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.
Amazon Web Services Region
- In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI.
Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations
- Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization
command in each Amazon Web Services Region where you want to apply the same customizations.
Describes the customizations associated with the provided Amazon Web Services account and Amazon QuickSight namespace in an Amazon Web Services Region. The QuickSight console evaluates which customizations to apply by running this API operation with the Resolved
flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account
- The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported Amazon Web Services Region.
Amazon Web Services Region
- In each Amazon Web Services Region where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI.
Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations
- Within an Amazon Web Services Region, a set of QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization
command in each Amazon Web Services Region where you want to apply the same customizations.
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
" + "documentation":"Describes the settings that were used when your QuickSight subscription was first created in this Amazon Web Services account.
" }, "DescribeAccountSubscription":{ "name":"DescribeAccountSubscription", @@ -1185,7 +1219,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo
object that includes an account's name, subscription status, authentication type, edition, and notification email address.
Use the DescribeAccountSubscription operation to receive a description of an QuickSight account's subscription. A successful API call returns an AccountInfo
object that includes an account's name, subscription status, authentication type, edition, and notification email address.
Describes a Amazon Q Business application that is linked to an Amazon QuickSight account.
" + "documentation":"Describes a Amazon Q Business application that is linked to an QuickSight account.
" }, "DescribeFolder":{ "name":"DescribeFolder", @@ -1722,7 +1756,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Describes all customer managed key registrations in a Amazon QuickSight account.
" + "documentation":"Describes all customer managed key registrations in a QuickSight account.
" }, "DescribeNamespace":{ "name":"DescribeNamespace", @@ -1776,7 +1810,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"} ], - "documentation":"Describes the state of a Amazon QuickSight Q Search configuration.
" + "documentation":"Describes the state of a QuickSight Q Search configuration.
" }, "DescribeRefreshSchedule":{ "name":"DescribeRefreshSchedule", @@ -2112,7 +2146,7 @@ {"shape":"UnsupportedPricingPlanException"}, {"shape":"InternalFailureException"} ], - "documentation":"Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user that is registered in an Amazon QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to quicksight:read
. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
Generates an embed URL that you can use to embed an QuickSight experience in your website. This action can be used for any type of user that is registered in an QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to quicksight:read
. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL
only from the server, not from the user's browser. The following rules apply to the generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes
parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" + "documentation":"Generates a temporary session URL and authorization code(bearer token) that you can use to embed an QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL
only from the server, not from the user's browser. The following rules apply to the generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes
parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" }, "GetSessionEmbedUrl":{ "name":"GetSessionEmbedUrl", @@ -2157,7 +2191,7 @@ {"shape":"UnsupportedUserEditionException"}, {"shape":"InternalFailureException"} ], - "documentation":"Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl
where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser
API operation. Use RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl
where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser
API operation. Use RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
Lists all brands in an Amazon QuickSight account.
" + "documentation":"Lists all brands in an QuickSight account.
" }, "ListCustomPermissions":{ "name":"ListCustomPermissions", @@ -2261,7 +2295,7 @@ {"shape":"UnsupportedUserEditionException"}, {"shape":"InternalFailureException"} ], - "documentation":"Lists all the versions of the dashboards in the Amazon QuickSight subscription.
" + "documentation":"Lists all the versions of the dashboards in the QuickSight subscription.
" }, "ListDashboards":{ "name":"ListDashboards", @@ -2462,7 +2496,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
" + "documentation":"Lists all services and authorized targets that the QuickSight IAM Identity Center application can access.
This operation is only supported for QuickSight accounts that use IAM Identity Center.
" }, "ListIngestions":{ "name":"ListIngestions", @@ -2794,7 +2828,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Predicts existing visuals or generates new visuals to answer a given query.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to quicksight:read
. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
We recommend enabling the QSearchStatus
API to unlock the full potential of PredictQnA
. When QSearchStatus
is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA
uses generative Q&A to provide an answer. To update the QSearchStatus
, see UpdateQuickSightQSearchConfiguration.
Predicts existing visuals or generates new visuals to answer a given query.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to quicksight:read
. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.
We recommend enabling the QSearchStatus
API to unlock the full potential of PredictQnA
. When QSearchStatus
is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA
uses generative Q&A to provide an answer. To update the QSearchStatus
, see UpdateQuickSightQSearchConfiguration.
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
" + "documentation":"Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the QuickSight API, QuickSight generates a registration URL. The user accesses this registration URL to create their account. QuickSight doesn't send a registration email to users who are registered from the QuickSight API. If you want new users to receive a registration email, then add those users in the QuickSight console. For more information on registering a new user in the QuickSight console, see Inviting users to access QuickSight.
" }, "RestoreAnalysis":{ "name":"RestoreAnalysis", @@ -2967,7 +3001,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Use the SearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
Use the SearchGroups
operation to search groups in a specified QuickSight namespace using the supplied filters.
Searches for any Q topic that exists in an Amazon QuickSight account.
" + "documentation":"Searches for any Q topic that exists in an QuickSight account.
" }, "StartAssetBundleExportJob":{ "name":"StartAssetBundleExportJob", @@ -3004,7 +3038,7 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob
API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob
API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
" + "documentation":"Starts an Asset Bundle export job.
An Asset Bundle export job exports specified QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob
API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob
API call. Each QuickSight account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
" }, "StartAssetBundleImportJob":{ "name":"StartAssetBundleImportJob", @@ -3023,7 +3057,7 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary \"create\"
, \"describe\"
, and \"update\"
permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified QuickSight assets into an QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your QuickSight account. Each QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary \"create\"
, \"describe\"
, and \"update\"
permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
1 Paginated PDF
1 Excel workbook that includes up to 5 table or pivot table visuals
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the DescribeDashboardSnapshotJob
API. When you call the DescribeDashboardSnapshotJob
API, check the JobStatus
field in the response. Once the job reaches a COMPLETED
or FAILED
status, use the DescribeDashboardSnapshotJobResult
API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult
API returns detailed information about the error that occurred.
StartDashboardSnapshotJob API throttling
Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob
. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.
Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
A large number of SnapshotExport
API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob
is created and there are already 12 jobs with the RUNNING
status, the new job request fails and returns a LimitExceededException
error. Wait for a current job to comlpete before you resubmit the new job.
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException
is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes)
. Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.
The time that it takes to process a job can be impacted by the following factors:
The dataset type (Direct Query or SPICE).
The size of the dataset.
The complexity of the calculated fields that are used in the dashboard.
The number of visuals that are on a sheet.
The types of visuals that are on the sheet.
The number of formats and snapshots that are requested in the job configuration.
The size of the generated snapshots.
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
1 Paginated PDF
1 Excel workbook that includes up to 5 table or pivot table visuals
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the DescribeDashboardSnapshotJob
API. When you call the DescribeDashboardSnapshotJob
API, check the JobStatus
field in the response. Once the job reaches a COMPLETED
or FAILED
status, use the DescribeDashboardSnapshotJobResult
API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult
API returns detailed information about the error that occurred.
StartDashboardSnapshotJob API throttling
QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob
. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, QuickSight throttles the API calls to maintin an optimal experience and reliability for all QuickSight users.
Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
A large number of SnapshotExport
API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob
is created and there are already 12 jobs with the RUNNING
status, the new job request fails and returns a LimitExceededException
error. Wait for a current job to comlpete before you resubmit the new job.
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the QuickSight API in one second, a ThrottlingException
is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes)
. Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.
The time that it takes to process a job can be impacted by the following factors:
The dataset type (Direct Query or SPICE).
The size of the dataset.
The complexity of the calculated fields that are used in the dashboard.
The number of visuals that are on a sheet.
The types of visuals that are on the sheet.
The number of formats and snapshots that are requested in the job configuration.
The size of the generated snapshots.
Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202
HTTP status code.
For more information, see Scheduling and sending Amazon QuickSight reports by email and Configuring email report settings for a Amazon QuickSight dashboard in the Amazon QuickSight User Guide.
" + "documentation":"Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202
HTTP status code.
For more information, see Scheduling and sending QuickSight reports by email and Configuring email report settings for a QuickSight dashboard in the Amazon QuickSight User Guide.
" }, "TagResource":{ "name":"TagResource", @@ -3081,7 +3115,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource
operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource
operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
Tags are used to track costs for users in QuickSight. You can't tag other resources that QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
QuickSight doesn't currently support the tag editor for Resource Groups.
Removes a tag or tags from a resource.
" }, + "UpdateAccountCustomPermission":{ + "name":"UpdateAccountCustomPermission", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/custom-permission" + }, + "input":{"shape":"UpdateAccountCustomPermissionRequest"}, + "output":{"shape":"UpdateAccountCustomPermissionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Applies a custom permissions profile to an account.
" + }, "UpdateAccountCustomization":{ "name":"UpdateAccountCustomization", "http":{ @@ -3117,7 +3168,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization
API operation.
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization
API operation.
Updates an Amazon QuickSight application with a token exchange grant. This operation only supports Amazon QuickSight applications that are registered with IAM Identity Center.
" + "documentation":"Updates an QuickSight application with a token exchange grant. This operation only supports QuickSight applications that are registered with IAM Identity Center.
" }, "UpdateBrand":{ "name":"UpdateBrand", @@ -3458,7 +3509,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InternalFailureException"} ], - "documentation":"Updates a Amazon Q Business application that is linked to a Amazon QuickSight account.
" + "documentation":"Updates a Amazon Q Business application that is linked to a QuickSight account.
" }, "UpdateFolder":{ "name":"UpdateFolder", @@ -3552,7 +3603,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
" + "documentation":"Adds or updates services and authorized targets to configure what the QuickSight IAM Identity Center application can access.
This operation is only supported for QuickSight accounts using IAM Identity Center
" }, "UpdateIpRestriction":{ "name":"UpdateIpRestriction", @@ -3586,7 +3637,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Updates a customer managed key in a Amazon QuickSight account.
" + "documentation":"Updates a customer managed key in a QuickSight account.
" }, "UpdatePublicSharingSettings":{ "name":"UpdatePublicSharingSettings", @@ -3604,7 +3655,7 @@ {"shape":"UnsupportedPricingPlanException"}, {"shape":"InternalFailureException"} ], - "documentation":"Use the UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
" + "documentation":"Use the UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of an QuickSight dashboard.
To use this operation, turn on session capacity pricing for your QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with QuickSight, see Using QuickSight with IAM in the QuickSight User Guide.
" }, "UpdateQPersonalizationConfiguration":{ "name":"UpdateQPersonalizationConfiguration", @@ -3641,7 +3692,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"} ], - "documentation":"Updates the state of a Amazon QuickSight Q Search configuration.
" + "documentation":"Updates the state of a QuickSight Q Search configuration.
" }, "UpdateRefreshSchedule":{ "name":"UpdateRefreshSchedule", @@ -3696,7 +3747,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Updates the SPICE capacity configuration for a Amazon QuickSight account.
" + "documentation":"Updates the SPICE capacity configuration for a QuickSight account.
" }, "UpdateTemplate":{ "name":"UpdateTemplate", @@ -3952,7 +4003,7 @@ "members":{ "DefaultTheme":{ "shape":"Arn", - "documentation":"The default theme for this Amazon QuickSight subscription.
" + "documentation":"The default theme for this QuickSight subscription.
" }, "DefaultEmailCustomizationTemplate":{ "shape":"Arn", @@ -3966,19 +4017,19 @@ "members":{ "AccountName":{ "shape":"String", - "documentation":"The account name that you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when users sign in.
" + "documentation":"The account name that you provided for the QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for QuickSight. It's unique over all of Amazon Web Services, and it appears only when users sign in.
" }, "Edition":{ "shape":"Edition", - "documentation":"The edition of your Amazon QuickSight account.
" + "documentation":"The edition of your QuickSight account.
" }, "NotificationEmail":{ "shape":"String", - "documentation":"The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.
" + "documentation":"The email address that will be used for QuickSight to send notifications regarding your Amazon Web Services account or QuickSight subscription.
" }, "AuthenticationType":{ "shape":"String", - "documentation":"The way that your Amazon QuickSight account is authenticated.
" + "documentation":"The way that your QuickSight account is authenticated.
" }, "AccountSubscriptionStatus":{ "shape":"String", @@ -3989,7 +4040,7 @@ "documentation":"The Amazon Resource Name (ARN) for the IAM Identity Center instance.
" } }, - "documentation":"A structure that contains the following account information elements:
Your Amazon QuickSight account name.
The edition of Amazon QuickSight that your account is using.
The notification email address that is associated with the Amazon QuickSight account.
The authentication type of the Amazon QuickSight account.
The status of the Amazon QuickSight account's subscription.
A structure that contains the following account information elements:
Your QuickSight account name.
The edition of QuickSight that your account is using.
The notification email address that is associated with the QuickSight account.
The authentication type of the QuickSight account.
The status of the QuickSight account's subscription.
The \"account name\" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
" + "documentation":"The \"account name\" you provided for the QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
" }, "Edition":{ "shape":"Edition", - "documentation":"The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
" + "documentation":"The edition of QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
" }, "DefaultNamespace":{ "shape":"Namespace", - "documentation":"The default Amazon QuickSight namespace for your Amazon Web Services account.
" + "documentation":"The default QuickSight namespace for your Amazon Web Services account.
" }, "NotificationEmail":{ "shape":"String", - "documentation":"The main notification email for your Amazon QuickSight subscription.
" + "documentation":"The main notification email for your QuickSight subscription.
" }, "PublicSharingEnabled":{ "shape":"Boolean", - "documentation":"A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.
" + "documentation":"A Boolean value that indicates whether public sharing is turned on for an QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.
" }, "TerminationProtectionEnabled":{ "shape":"Boolean", - "documentation":"A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True
value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption
request. A False
value will allow the ccount to be deleted.
A boolean value that determines whether or not an QuickSight account can be deleted. A True
value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption
request. A False
value will allow the ccount to be deleted.
The Amazon QuickSight settings associated with your Amazon Web Services account.
" + "documentation":"The QuickSight settings associated with your Amazon Web Services account.
" }, "ActionList":{ "type":"list", @@ -4245,32 +4296,32 @@ "members":{ "DataQnA":{ "shape":"DataQnAConfigurations", - "documentation":"Adds generative Q&A capabilitiees to an embedded Amazon QuickSight console.
" + "documentation":"Adds generative Q&A capabilitiees to an embedded QuickSight console.
" }, "GenerativeAuthoring":{ "shape":"GenerativeAuthoringConfigurations", - "documentation":"Adds the generative BI authoring experience to an embedded Amazon QuickSight console.
" + "documentation":"Adds the generative BI authoring experience to an embedded QuickSight console.
" }, "ExecutiveSummary":{ "shape":"ExecutiveSummaryConfigurations", - "documentation":"Adds the executive summaries feature to an embedded Amazon QuickSight console.
" + "documentation":"Adds the executive summaries feature to an embedded QuickSight console.
" }, "DataStories":{ "shape":"DataStoriesConfigurations", - "documentation":"Adds the data stories feature to an embedded Amazon QuickSight console.
" + "documentation":"Adds the data stories feature to an embedded QuickSight console.
" } }, - "documentation":"A collection of Amazon Q feature configurations in an embedded Amazon QuickSight console.
" + "documentation":"A collection of Amazon Q feature configurations in an embedded QuickSight console.
" }, "AmazonQInQuickSightDashboardConfigurations":{ "type":"structure", "members":{ "ExecutiveSummary":{ "shape":"ExecutiveSummaryConfigurations", - "documentation":"A generated executive summary of an embedded Amazon QuickSight dashboard.
" + "documentation":"A generated executive summary of an embedded QuickSight dashboard.
" } }, - "documentation":"A collection of Amazon Q feature configurations in an embedded Amazon QuickSight dashboard.
" + "documentation":"A collection of Amazon Q feature configurations in an embedded QuickSight dashboard.
" }, "Analysis":{ "type":"structure", @@ -4490,7 +4541,7 @@ }, "Name":{ "shape":"AnalysisName", - "documentation":"The name of the analysis. This name is displayed in the Amazon QuickSight console.
" + "documentation":"The name of the analysis. This name is displayed in the QuickSight console.
" }, "Status":{ "shape":"ResourceStatus", @@ -4558,7 +4609,7 @@ "members":{ "InitialDashboardId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.
The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns
parameter. Otherwise, the request will fail with InvalidParameterValueException
.
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this dashboard.
The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns
parameter. Otherwise, the request will fail with InvalidParameterValueException
.
The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns
parameter. Otherwise, the request will fail with InvalidParameterValueException
.
The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns
parameter. Otherwise, the request will fail with InvalidParameterValueException
.
The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
" @@ -4617,11 +4668,11 @@ "members":{ "Dashboard":{ "shape":"AnonymousUserDashboardEmbeddingConfiguration", - "documentation":"The type of embedding experience. In this case, Amazon QuickSight dashboards.
" + "documentation":"The type of embedding experience. In this case, QuickSight dashboards.
" }, "DashboardVisual":{ "shape":"AnonymousUserDashboardVisualEmbeddingConfiguration", - "documentation":"The type of embedding experience. In this case, Amazon QuickSight visuals.
" + "documentation":"The type of embedding experience. In this case, QuickSight visuals.
" }, "QSearchBar":{ "shape":"AnonymousUserQSearchBarEmbeddingConfiguration", @@ -4632,7 +4683,7 @@ "documentation":"The Generative Q&A experience that you want to use for anonymous user embedding.
" } }, - "documentation":"The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.
" + "documentation":"The type of experience you want to embed. For anonymous users, you can embed QuickSight dashboards.
" }, "AnonymousUserGenerativeQnAEmbeddingConfiguration":{ "type":"structure", @@ -4640,7 +4691,7 @@ "members":{ "InitialTopicId":{ "shape":"RestrictiveResourceId", - "documentation":"The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.
The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns
parameter. Otherwise, the request fails with an InvalidParameterValueException
error.
The QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.
The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns
parameter. Otherwise, the request fails with an InvalidParameterValueException
error.
The settings that you want to use for the Generative Q&A experience.
" @@ -4651,7 +4702,7 @@ "members":{ "InitialTopicId":{ "shape":"RestrictiveResourceId", - "documentation":"The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.
The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns
parameter. Otherwise, the request fails with an InvalidParameterValueException
error.
The QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders the Q search bar with this legacy topic pre-selected.
The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns
parameter. Otherwise, the request fails with an InvalidParameterValueException
error.
The settings that you want to use with the Q search bar.
" @@ -6043,7 +6094,7 @@ "documentation":"A list of link sharing permissions for the dashboards that you want to apply overrides to.
" } }, - "documentation":"A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.
" + "documentation":"A structure that contains the configuration of a shared link to an QuickSight dashboard.
" }, "AssetBundleResourcePermissions":{ "type":"structure", @@ -6120,7 +6171,7 @@ }, "IdentityCenterConfiguration":{ "shape":"IdentityCenterConfiguration", - "documentation":"An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
" + "documentation":"An optional parameter that configures IAM Identity Center authentication to grant QuickSight access to your workgroup.
This parameter can only be specified if your QuickSight account is configured with IAM Identity Center.
" } }, "documentation":"Parameters for Amazon Athena.
" @@ -7204,7 +7255,7 @@ "members":{ "BrandId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The ID of the Amazon QuickSight brand.
" + "documentation":"The ID of the QuickSight brand.
" }, "Arn":{ "shape":"Arn", @@ -7270,7 +7321,7 @@ }, "BrandId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The ID of the Amazon QuickSight brand.
" + "documentation":"The ID of the QuickSight brand.
" }, "BrandName":{ "shape":"Name", @@ -7541,9 +7592,17 @@ "IncludeContentInScheduledReportsEmail":{ "shape":"CapabilityState", "documentation":"The ability to include content in scheduled email reports.
" + }, + "Dashboard":{ + "shape":"CapabilityState", + "documentation":"The ability to perform dashboard-related actions.
" + }, + "Analysis":{ + "shape":"CapabilityState", + "documentation":"The ability to perform analysis-related actions.
" } }, - "documentation":"A set of actions that correspond to Amazon QuickSight permissions.
" + "documentation":"A set of actions that correspond to QuickSight permissions.
" }, "CapabilityState":{ "type":"string", @@ -7717,11 +7776,11 @@ "members":{ "FilterListConfiguration":{ "shape":"FilterListConfiguration", - "documentation":"A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.
" + "documentation":"A list of filter configurations. In the QuickSight console, this filter type is called a filter list.
" }, "CustomFilterListConfiguration":{ "shape":"CustomFilterListConfiguration", - "documentation":"A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.
" + "documentation":"A list of custom filter values. In the QuickSight console, this filter type is called a custom filter list.
" }, "CustomFilterConfiguration":{ "shape":"CustomFilterConfiguration", @@ -8095,7 +8154,7 @@ "members":{ "Principals":{ "shape":"PrincipalList", - "documentation":"An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
" + "documentation":"An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
" }, "ColumnNames":{ "shape":"ColumnNameList", @@ -8811,19 +8870,19 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
", + "documentation":"The ID for the Amazon Web Services account that you want to customize QuickSight for.
", "location":"uri", "locationName":"AwsAccountId" }, "Namespace":{ "shape":"Namespace", - "documentation":"The Amazon QuickSight namespace that you want to add customizations to.
", + "documentation":"The QuickSight namespace that you want to add customizations to.
", "location":"querystring", "locationName":"namespace" }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace.
For example, you can add a default theme by setting AccountCustomization
to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }
. Or, you can add a custom theme by specifying \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }
.
The QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace.
For example, you can add a default theme by setting AccountCustomization
to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }
. Or, you can add a custom theme by specifying \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }
.
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
" + "documentation":"The ID for the Amazon Web Services account that you want to customize QuickSight for.
" }, "Namespace":{ "shape":"Namespace", @@ -8848,7 +8907,7 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.
" + "documentation":"The QuickSight customizations you're adding in the current Amazon Web Services Region.
" }, "RequestId":{ "shape":"String", @@ -8872,77 +8931,77 @@ "members":{ "Edition":{ "shape":"Edition", - "documentation":"The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE
or ENTERPRISE_AND_Q
.
If you choose ENTERPRISE_AND_Q
, the following parameters are required:
FirstName
LastName
EmailAddress
ContactNumber
The edition of QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE
or ENTERPRISE_AND_Q
.
If you choose ENTERPRISE_AND_Q
, the following parameters are required:
FirstName
LastName
EmailAddress
ContactNumber
The method that you want to use to authenticate your Amazon QuickSight account.
If you choose ACTIVE_DIRECTORY
, provide an ActiveDirectoryName
and an AdminGroup
associated with your Active Directory.
If you choose IAM_IDENTITY_CENTER
, provide an AdminGroup
associated with your IAM Identity Center account.
The method that you want to use to authenticate your QuickSight account.
If you choose ACTIVE_DIRECTORY
, provide an ActiveDirectoryName
and an AdminGroup
associated with your Active Directory.
If you choose IAM_IDENTITY_CENTER
, provide an AdminGroup
associated with your IAM Identity Center account.
The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
", + "documentation":"The Amazon Web Services account ID of the account that you're using to create your QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, "AccountName":{ "shape":"AccountName", - "documentation":"The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName
value after the Amazon QuickSight account is created.
The name of your QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName
value after the QuickSight account is created.
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
" + "documentation":"The email address that you want QuickSight to send notifications to regarding your QuickSight account or QuickSight subscription.
" }, "ActiveDirectoryName":{ "shape":"String", - "documentation":"The name of your Active Directory. This field is required if ACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account.
The name of your Active Directory. This field is required if ACTIVE_DIRECTORY
is the selected authentication method of the new QuickSight account.
The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account.
The realm of the Active Directory that is associated with your QuickSight account. This field is required if ACTIVE_DIRECTORY
is the selected authentication method of the new QuickSight account.
The ID of the Active Directory that is associated with your Amazon QuickSight account.
" + "documentation":"The ID of the Active Directory that is associated with your QuickSight account.
" }, "AdminGroup":{ "shape":"GroupsList", - "documentation":"The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup
field is required if ACTIVE_DIRECTORY
or IAM_IDENTITY_CENTER
is the selected authentication method of the new Amazon QuickSight account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + "documentation":"The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup
field is required if ACTIVE_DIRECTORY
or IAM_IDENTITY_CENTER
is the selected authentication method of the new QuickSight account.
For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
" }, "AuthorGroup":{ "shape":"GroupsList", - "documentation":"The author group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + "documentation":"The author group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
" }, "ReaderGroup":{ "shape":"GroupsList", - "documentation":"The reader group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + "documentation":"The reader group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
" }, "AdminProGroup":{ "shape":"GroupsList", - "documentation":"The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup
field is required if ACTIVE_DIRECTORY
or IAM_IDENTITY_CENTER
is the selected authentication method of the new Amazon QuickSight account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + "documentation":"The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup
field is required if ACTIVE_DIRECTORY
or IAM_IDENTITY_CENTER
is the selected authentication method of the new QuickSight account.
For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
" }, "AuthorProGroup":{ "shape":"GroupsList", - "documentation":"The author pro group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + "documentation":"The author pro group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
" }, "ReaderProGroup":{ "shape":"GroupsList", - "documentation":"The reader pro group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + "documentation":"The reader pro group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.
" }, "FirstName":{ "shape":"String", - "documentation":"The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
The first name of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q
is the selected edition of the new QuickSight account.
The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
The last name of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q
is the selected edition of the new QuickSight account.
The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
The email address of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q
is the selected edition of the new QuickSight account.
A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
A 10-digit phone number for the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q
is the selected edition of the new QuickSight account.
A SignupResponse
object that returns information about a newly created Amazon QuickSight account.
A SignupResponse
object that returns information about a newly created QuickSight account.
A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.
" + "documentation":"A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
" }, "Parameters":{ "shape":"Parameters", @@ -9006,7 +9065,7 @@ }, "ThemeArn":{ "shape":"Arn", - "documentation":"The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
" + "documentation":"The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
" }, "Tags":{ "shape":"TagList", @@ -9022,7 +9081,7 @@ }, "FolderArns":{ "shape":"FolderArnList", - "documentation":"When you create the analysis, Amazon QuickSight adds the analysis to these folders.
" + "documentation":"When you create the analysis, QuickSight adds the analysis to these folders.
" } } }, @@ -9067,7 +9126,7 @@ }, "BrandId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The ID of the Amazon QuickSight brand.
", + "documentation":"The ID of the QuickSight brand.
", "location":"uri", "locationName":"BrandId" }, @@ -9187,7 +9246,7 @@ }, "SourceEntity":{ "shape":"DashboardSourceEntity", - "documentation":"The entity that you are using as a source when you create the dashboard. In SourceEntity
, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate
API operation. For SourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
Either a SourceEntity
or a Definition
must be provided in order for the request to be valid.
The entity that you are using as a source when you create the dashboard. In SourceEntity
, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate
API operation. For SourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate
ARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
Either a SourceEntity
or a Definition
must be provided in order for the request to be valid.
Options for publishing the dashboard when you create it:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either ENABLED
or DISABLED
. When this is set to DISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either ENABLED
or DISABLED
. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either COLLAPSED
or EXPANDED
. This option is COLLAPSED
by default.
Options for publishing the dashboard when you create it:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either ENABLED
or DISABLED
. When this is set to DISABLED
, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either ENABLED
or DISABLED
. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either COLLAPSED
or EXPANDED
. This option is COLLAPSED
by default.
AvailabilityStatus
for ExecutiveSummaryOption
- This status can be either ENABLED
or DISABLED
. The option to build an executive summary is disabled when this is set to DISABLED
. This option is ENABLED
by default.
AvailabilityStatus
for DataStoriesSharingOption
- This status can be either ENABLED
or DISABLED
. The option to share a data story is disabled when this is set to DISABLED
. This option is ENABLED
by default.
When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
" + "documentation":"When you create the dashboard, QuickSight adds the dashboard to these folders.
" }, "LinkSharingConfiguration":{ "shape":"LinkSharingConfiguration", @@ -9295,7 +9354,7 @@ }, "ColumnGroups":{ "shape":"ColumnGroupList", - "documentation":"Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
" + "documentation":"Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
" }, "FieldFolders":{ "shape":"FieldFolderMap", @@ -9328,7 +9387,7 @@ }, "FolderArns":{ "shape":"FolderArnList", - "documentation":"When you create the dataset, Amazon QuickSight adds the dataset to these folders.
" + "documentation":"When you create the dataset, QuickSight adds the dataset to these folders.
" }, "PerformanceConfiguration":{ "shape":"PerformanceConfiguration", @@ -9399,11 +9458,11 @@ }, "DataSourceParameters":{ "shape":"DataSourceParameters", - "documentation":"The parameters that Amazon QuickSight uses to connect to your underlying source.
" + "documentation":"The parameters that QuickSight uses to connect to your underlying source.
" }, "Credentials":{ "shape":"DataSourceCredentials", - "documentation":"The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
" + "documentation":"The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
" }, "Permissions":{ "shape":"ResourcePermissionList", @@ -9411,11 +9470,11 @@ }, "VpcConnectionProperties":{ "shape":"VpcConnectionProperties", - "documentation":"Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
" + "documentation":"Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
" }, "SslProperties":{ "shape":"SslProperties", - "documentation":"Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
" + "documentation":"Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
" }, "Tags":{ "shape":"TagList", @@ -9423,7 +9482,7 @@ }, "FolderArns":{ "shape":"FolderArnList", - "documentation":"When you create the data source, Amazon QuickSight adds the data source to these folders.
" + "documentation":"When you create the data source, QuickSight adds the data source to these folders.
" } } }, @@ -9686,7 +9745,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.
", + "documentation":"The ID of the Amazon Web Services account where you want to assign an IAM policy to QuickSight users or groups.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -9700,11 +9759,11 @@ }, "PolicyArn":{ "shape":"Arn", - "documentation":"The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
" + "documentation":"The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
" }, "Identities":{ "shape":"IdentityMap", - "documentation":"The Amazon QuickSight users, groups, or both that you want to assign the policy to.
" + "documentation":"The QuickSight users, groups, or both that you want to assign the policy to.
" }, "Namespace":{ "shape":"Namespace", @@ -9731,11 +9790,11 @@ }, "PolicyArn":{ "shape":"Arn", - "documentation":"The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.
" + "documentation":"The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
" }, "Identities":{ "shape":"IdentityMap", - "documentation":"The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
" + "documentation":"The QuickSight users, groups, or both that the IAM policy is assigned to.
" }, "RequestId":{ "shape":"String", @@ -9816,7 +9875,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.
", + "documentation":"The ID for the Amazon Web Services account that you want to create the QuickSight namespace in.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -9839,7 +9898,7 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"The ARN of the Amazon QuickSight namespace you created.
" + "documentation":"The ARN of the QuickSight namespace you created.
" }, "Name":{ "shape":"Namespace", @@ -9988,7 +10047,7 @@ }, "AliasName":{ "shape":"AliasName", - "documentation":"The name that you want to give to the template alias that you're creating. Don't start the alias name with the $
character. Alias names that start with $
are reserved by Amazon QuickSight.
The name that you want to give to the template alias that you're creating. Don't start the alias name with the $
character. Alias names that start with $
are reserved by QuickSight.
The entity that you are using as a source when you create the template. In SourceEntity
, you specify the type of object you're using as source: SourceTemplate
for a template or SourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate
, specify the ARN of the source template. For SourceAnalysis
, specify the ARN of the source analysis. The SourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
or SourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
Either a SourceEntity
or a Definition
must be provided in order for the request to be valid.
The entity that you are using as a source when you create the template. In SourceEntity
, you specify the type of object you're using as source: SourceTemplate
for a template or SourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate
, specify the ARN of the source template. For SourceAnalysis
, specify the ARN of the source analysis. The SourceTemplate
ARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
or SourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
Either a SourceEntity
or a Definition
must be provided in order for the request to be valid.
The type of custom connector.
" + } + }, + "documentation":"The parameters that are required to connect to a custom connection data source.
" + }, "CustomContentConfiguration":{ "type":"structure", "members":{ @@ -10889,7 +10958,7 @@ "documentation":"The Amazon Web Services request ID for this operation.
" } }, - "documentation":"The customer managed key that is registered to your Amazon QuickSight account is unavailable.
", + "documentation":"The customer managed key that is registered to your QuickSight account is unavailable.
", "error":{"httpStatusCode":400}, "exception":true }, @@ -11044,7 +11113,15 @@ }, "DataQAEnabledOption":{ "shape":"DataQAEnabledOption", - "documentation":"Adds Q&A capabilities to an Amazon QuickSight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.
" + "documentation":"Adds Q&A capabilities to an QuickSight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.
" + }, + "ExecutiveSummaryOption":{ + "shape":"ExecutiveSummaryOption", + "documentation":"Executive summary option.
" + }, + "DataStoriesSharingOption":{ + "shape":"DataStoriesSharingOption", + "documentation":"Data stories sharing option.
" } }, "documentation":"Dashboard publish options.
" @@ -11279,18 +11356,18 @@ "members":{ "DashboardId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The ID of the dashboard that has the visual that you want to embed. The DashboardId
can be found in the IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId
with a ListDashboards
API operation.
The ID of the dashboard that has the visual that you want to embed. The DashboardId
can be found in the IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of the QuickSight console. You can also get the DashboardId
with a ListDashboards
API operation.
The ID of the sheet that the has visual that you want to embed. The SheetId
can be found in the IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of the Amazon QuickSight console.
The ID of the sheet that the has visual that you want to embed. The SheetId
can be found in the IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of the QuickSight console.
The ID of the visual that you want to embed. The VisualID
can be found in the IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of the Amazon QuickSight console.
The ID of the visual that you want to embed. The VisualID
can be found in the IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of the QuickSight console.
A structure that contains the following elements:
The DashboardId
of the dashboard that has the visual that you want to embed.
The SheetId
of the sheet that has the visual that you want to embed.
The VisualId
of the visual that you want to embed.
The DashboardId
, SheetId
, and VisualId
can be found in the IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId
with a ListDashboards
API operation.
A structure that contains the following elements:
The DashboardId
of the dashboard that has the visual that you want to embed.
The SheetId
of the sheet that has the visual that you want to embed.
The VisualId
of the visual that you want to embed.
The DashboardId
, SheetId
, and VisualId
can be found in the IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of the QuickSight console. You can also get the DashboardId
with a ListDashboards
API operation.
The generative Q&A settings of an embedded Amazon QuickSight console.
" + "documentation":"The generative Q&A settings of an embedded QuickSight console.
" } }, - "documentation":"The generative Q&A settings of an embedded Amazon QuickSight console.
" + "documentation":"The generative Q&A settings of an embedded QuickSight console.
" }, "DataSet":{ "type":"structure", @@ -12047,11 +12124,11 @@ }, "VpcConnectionProperties":{ "shape":"VpcConnectionProperties", - "documentation":"The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
" + "documentation":"The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
" }, "SslProperties":{ "shape":"SslProperties", - "documentation":"Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
" + "documentation":"Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
" }, "ErrorInfo":{ "shape":"DataSourceErrorInfo", @@ -12233,6 +12310,10 @@ "ImpalaParameters":{ "shape":"ImpalaParameters", "documentation":"The parameters for Impala.
" + }, + "CustomConnectionParameters":{ + "shape":"CustomConnectionParameters", + "documentation":"The parameters for custom connectors.
" } }, "documentation":"The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
" @@ -12337,7 +12418,8 @@ "DATABRICKS", "STARBURST", "TRINO", - "BIGQUERY" + "BIGQUERY", + "GOOGLESHEETS" ] }, "DataStoriesConfigurations":{ @@ -12346,10 +12428,20 @@ "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"The data story settings of an embedded Amazon QuickSight console.
" + "documentation":"The data story settings of an embedded QuickSight console.
" + } + }, + "documentation":"The data story settings of an embedded QuickSight console.
" + }, + "DataStoriesSharingOption":{ + "type":"structure", + "members":{ + "AvailabilityStatus":{ + "shape":"DashboardBehavior", + "documentation":"Availability status.
" } }, - "documentation":"The data story settings of an embedded Amazon QuickSight console.
" + "documentation":"Executive summary option.
" }, "Database":{ "type":"string", @@ -13230,19 +13322,44 @@ }, "documentation":"The default options that correspond to the TextField
filter control type.
The ID of the Amazon Web Services account from which you want to unapply the custom permissions profile.
", + "location":"uri", + "locationName":"AwsAccountId" + } + } + }, + "DeleteAccountCustomPermissionResponse":{ + "type":"structure", + "members":{ + "RequestId":{ + "shape":"String", + "documentation":"The Amazon Web Services request ID for this operation.
" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"The HTTP status of the request.
" + } + } + }, "DeleteAccountCustomizationRequest":{ "type":"structure", "required":["AwsAccountId"], "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.
", + "documentation":"The ID for the Amazon Web Services account that you want to delete QuickSight customizations from in this Amazon Web Services Region.
", "location":"uri", "locationName":"AwsAccountId" }, "Namespace":{ "shape":"Namespace", - "documentation":"The Amazon QuickSight namespace that you're deleting the customizations from.
", + "documentation":"The QuickSight namespace that you're deleting the customizations from.
", "location":"querystring", "locationName":"namespace" } @@ -13309,7 +13426,7 @@ }, "RecoveryWindowInDays":{ "shape":"RecoveryWindowInDays", - "documentation":"A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery
option in the same API call. The default value is 30.
A value that specifies the number of days that QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery
option in the same API call. The default value is 30.
The ID of the Amazon QuickSight brand.
", + "documentation":"The ID of the QuickSight brand.
", "location":"uri", "locationName":"BrandId" } @@ -13612,13 +13729,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the Amazon QuickSight account that you want to disconnect from a Amazon Q Business application.
", + "documentation":"The ID of the QuickSight account that you want to disconnect from a Amazon Q Business application.
", "location":"uri", "locationName":"AwsAccountId" }, "Namespace":{ "shape":"Namespace", - "documentation":"The Amazon QuickSight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter.
", + "documentation":"The QuickSight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter.
", "location":"querystring", "locationName":"namespace" } @@ -13910,7 +14027,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.
", + "documentation":"The ID for the Amazon Web Services account that you want to delete the QuickSight namespace from.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -14562,25 +14679,54 @@ "max":1, "min":1 }, + "DescribeAccountCustomPermissionRequest":{ + "type":"structure", + "required":["AwsAccountId"], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"The ID of the Amazon Web Services account for which you want to describe the applied custom permissions profile.
", + "location":"uri", + "locationName":"AwsAccountId" + } + } + }, + "DescribeAccountCustomPermissionResponse":{ + "type":"structure", + "members":{ + "CustomPermissionsName":{ + "shape":"CustomPermissionsName", + "documentation":"The name of the custom permissions profile.
" + }, + "RequestId":{ + "shape":"String", + "documentation":"The Amazon Web Services request ID for this operation.
" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"The HTTP status of the request.
" + } + } + }, "DescribeAccountCustomizationRequest":{ "type":"structure", "required":["AwsAccountId"], "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.
", + "documentation":"The ID for the Amazon Web Services account that you want to describe QuickSight customizations for.
", "location":"uri", "locationName":"AwsAccountId" }, "Namespace":{ "shape":"Namespace", - "documentation":"The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.
", + "documentation":"The QuickSight namespace that you want to describe QuickSight customizations for.
", "location":"querystring", "locationName":"namespace" }, "Resolved":{ "shape":"boolean", - "documentation":"The Resolved
flag works with the other parameters to determine which view of Amazon QuickSight customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved
, to reveal customizations that are configured at different levels.
The Resolved
flag works with the other parameters to determine which view of QuickSight customizations is returned. You can add this flag to your command to use the same view that QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved
, to reveal customizations that are configured at different levels.
The Amazon QuickSight namespace that you're describing.
" + "documentation":"The QuickSight namespace that you're describing.
" }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.
" + "documentation":"The QuickSight customizations that exist in the current Amazon Web Services Region.
" }, "RequestId":{ "shape":"String", @@ -14633,7 +14779,7 @@ "members":{ "AccountSettings":{ "shape":"AccountSettings", - "documentation":"The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription.
In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a QuickSight \"account\" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
" + "documentation":"The QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription.
In the QuickSight console, the QuickSight subscription is sometimes referred to as a QuickSight \"account\" even though it's technically not an account by itself. Instead, it's a subscription to the QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to QuickSight in every Amazon Web Services Region where you use it.
" }, "RequestId":{ "shape":"String", @@ -14652,7 +14798,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The Amazon Web Services account ID associated with your Amazon QuickSight account.
", + "documentation":"The Amazon Web Services account ID associated with your QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" } @@ -14663,7 +14809,7 @@ "members":{ "AccountInfo":{ "shape":"AccountInfo", - "documentation":"A structure that contains the following elements:
Your Amazon QuickSight account name.
The edition of Amazon QuickSight that your account is using.
The notification email address that is associated with the Amazon QuickSight account.
The authentication type of the Amazon QuickSight account.
The status of the Amazon QuickSight account's subscription.
A structure that contains the following elements:
Your QuickSight account name.
The edition of QuickSight that your account is using.
The notification email address that is associated with the QuickSight account.
The authentication type of the QuickSight account.
The status of the QuickSight account's subscription.
The ID of the Amazon QuickSight brand.
", + "documentation":"The ID of the QuickSight brand.
", "location":"uri", "locationName":"BrandId" } @@ -15093,7 +15239,7 @@ }, "BrandId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The ID of the Amazon QuickSight brand.
", + "documentation":"The ID of the QuickSight brand.
", "location":"uri", "locationName":"BrandId" }, @@ -15231,7 +15377,7 @@ }, "DashboardPublishOptions":{ "shape":"DashboardPublishOptions", - "documentation":"Options for publishing the dashboard:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either ENABLED
or DISABLED
. When this is set to DISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either ENABLED
or DISABLED
. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either COLLAPSED
or EXPANDED
. This option is COLLAPSED
by default.
Options for publishing the dashboard:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either ENABLED
or DISABLED
. When this is set to DISABLED
, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either ENABLED
or DISABLED
. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either COLLAPSED
or EXPANDED
. This option is COLLAPSED
by default.
AvailabilityStatus
for ExecutiveSummaryOption
- This status can be either ENABLED
or DISABLED
. The option to build an executive summary is disabled when this is set to DISABLED
. This option is ENABLED
by default.
AvailabilityStatus
for DataStoriesSharingOption
- This status can be either ENABLED
or DISABLED
. The option to share a data story is disabled when this is set to DISABLED
. This option is ENABLED
by default.
The ID of the Amazon QuickSight account that is linked to the Amazon Q Business application that you want described.
", + "documentation":"The ID of the QuickSight account that is linked to the Amazon Q Business application that you want described.
", "location":"uri", "locationName":"AwsAccountId" }, "Namespace":{ "shape":"Namespace", - "documentation":"The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.
", + "documentation":"The QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.
", "location":"querystring", "locationName":"namespace" } @@ -15753,7 +15899,7 @@ }, "ApplicationId":{ "shape":"String", - "documentation":"The ID of the Amazon Q Business application that is linked to the Amazon QuickSight account.
" + "documentation":"The ID of the Amazon Q Business application that is linked to the QuickSight account.
" } } }, @@ -16197,7 +16343,11 @@ }, "KeyRegistration":{ "shape":"KeyRegistration", - "documentation":"A list of RegisteredCustomerManagedKey
objects in a Amazon QuickSight account.
A list of RegisteredCustomerManagedKey
objects in a QuickSight account.
A list of QDataKey
objects in a QuickSight account.
The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.
", + "documentation":"The ID for the Amazon Web Services account that contains the QuickSight namespace that you want to describe.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -16284,7 +16434,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that the user wants described.
", + "documentation":"The ID of the Amazon Web Services account that contains the QuickSight Q Search configuration that the user wants described.
", "location":"uri", "locationName":"AwsAccountId" } @@ -16295,7 +16445,7 @@ "members":{ "QSearchStatus":{ "shape":"QSearchStatus", - "documentation":"The status of Amazon QuickSight Q Search configuration.
" + "documentation":"The status of QuickSight Q Search configuration.
" }, "RequestId":{ "shape":"String", @@ -17200,7 +17350,7 @@ "members":{ "LabelVisibility":{ "shape":"Visibility", - "documentation":"Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'
.
Determines the visibility of the label in a donut chart. In the QuickSight console, this option is called 'Show total'
.
The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.
" @@ -17320,7 +17470,7 @@ "documentation":"The list of custom actions that are configured for a visual.
" } }, - "documentation":"An empty visual.
Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual
until a visual type is selected.
An empty visual.
Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the QuickSight console is considered an EmptyVisual
until a visual type is selected.
The executive summary settings of an embedded Amazon QuickSight console or dashboard.
" + "documentation":"The executive summary settings of an embedded QuickSight console or dashboard.
" } }, - "documentation":"The executive summary settings of an embedded Amazon QuickSight console or dashboard.
" + "documentation":"The executive summary settings of an embedded QuickSight console or dashboard.
" + }, + "ExecutiveSummaryOption":{ + "type":"structure", + "members":{ + "AvailabilityStatus":{ + "shape":"DashboardBehavior", + "documentation":"Availability status.
" + } + }, + "documentation":"Data stories sharing option.
" }, "ExplicitHierarchy":{ "type":"structure", @@ -17522,10 +17682,10 @@ }, "SenderFault":{ "shape":"Boolean", - "documentation":"A boolean that indicates whether a FailedKeyRegistrationEntry
resulted from user error. If the value of this property is True
, the error was caused by user error. If the value of this property is False
, the error occurred on the backend. If your job continues fail and with a False
SenderFault
value, contact Amazon Web ServicesSupport.
A boolean that indicates whether a FailedKeyRegistrationEntry
resulted from user error. If the value of this property is True
, the error was caused by user error. If the value of this property is False
, the error occurred on the backend. If your job continues fail and with a False
SenderFault
value, contact Amazon Web Services Support.
An entry that appears when a KeyRegistration
update to Amazon QuickSight fails.
An entry that appears when a KeyRegistration
update to QuickSight fails.
The sharing scope of the folder.
" } }, - "documentation":"A folder in Amazon QuickSight.
" + "documentation":"A folder in QuickSight.
" }, "FolderArnList":{ "type":"list", @@ -18467,7 +18627,7 @@ "documentation":"The type of asset that it is.
" } }, - "documentation":"An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.
" + "documentation":"An asset in a QuickSight folder, such as a dashboard, analysis, or dataset.
" }, "FolderMemberList":{ "type":"list", @@ -18495,7 +18655,7 @@ "documentation":"The value of the named item (in this example, PARENT_FOLDER_ARN
), that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\"
.
A filter to use to search an Amazon QuickSight folder.
" + "documentation":"A filter to use to search an QuickSight folder.
" }, "FolderSearchFilterList":{ "type":"list", @@ -18534,7 +18694,7 @@ "documentation":"The sharing scope of the folder.
" } }, - "documentation":"A summary of information about an existing Amazon QuickSight folder.
" + "documentation":"A summary of information about an existing QuickSight folder.
" }, "FolderSummaryList":{ "type":"list", @@ -19262,7 +19422,7 @@ }, "Namespace":{ "shape":"Namespace", - "documentation":"The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default
.
The QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default
.
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.
If you choose Dashboard
embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.
If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.
Currently, you can pass up to 25 theme ARNs in each API call.
" + "documentation":"The Amazon Resource Names (ARNs) for the QuickSight resources that the user is authorized to access during the lifetime of the session.
If you choose Dashboard
embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.
If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.
Currently, you can pass up to 25 theme ARNs in each API call.
" }, "ExperienceConfiguration":{ "shape":"AnonymousUserEmbeddingExperienceConfiguration", @@ -19278,7 +19438,7 @@ }, "AllowedDomains":{ "shape":"StringList", - "documentation":"The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *
. For example, https://*.sapp.amazon.com
includes all subdomains under https://sapp.amazon.com
.
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *
. For example, https://*.sapp.amazon.com
includes all subdomains under https://sapp.amazon.com
.
The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.
" + "documentation":"The experience that you want to embed. For registered users, you can embed QuickSight dashboards, QuickSight visuals, the QuickSight Q search bar, the QuickSight Generative Q&A experience, or the entire QuickSight console.
" }, "AllowedDomains":{ "shape":"StringList", - "documentation":"The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *
. For example, https://*.sapp.amazon.com
includes all subdomains under https://sapp.amazon.com
.
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *
. For example, https://*.sapp.amazon.com
includes all subdomains under https://sapp.amazon.com
.
The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.
" + "documentation":"The embed URL for the QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.
" }, "Status":{ "shape":"StatusCode", @@ -19464,10 +19624,10 @@ "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"The generative BI authoring settings of an embedded Amazon QuickSight console.
" + "documentation":"The generative BI authoring settings of an embedded QuickSight console.
" } }, - "documentation":"The generative BI authoring settings of an embedded Amazon QuickSight console.
" + "documentation":"The generative BI authoring settings of an embedded QuickSight console.
" }, "GeoSpatialColumnGroup":{ "type":"structure", @@ -20258,7 +20418,7 @@ }, "StatePersistenceEnabled":{ "shape":"Boolean", - "documentation":"Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE
, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE
.
Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE
, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE
.
The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default
.
The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default
.
A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType
parameter must be set to ANONYMOUS
because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS
\", the session can access all three dashboards.
A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType
parameter must be set to ANONYMOUS
because other identity types authenticate as QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS
\", the session can access all three dashboards.
The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
", + "documentation":"The ID for the Amazon Web Services account associated with your QuickSight subscription.
", "location":"uri", "locationName":"AwsAccountId" }, "EntryPoint":{ "shape":"EntryPoint", - "documentation":"The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId
- where DashboardId
is the actual ID key from the Amazon QuickSight console URL of the dashboard
/analyses/AnalysisId
- where AnalysisId
is the actual ID key from the Amazon QuickSight console URL of the analysis
The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId
- where DashboardId
is the actual ID key from the QuickSight console URL of the dashboard
/analyses/AnalysisId
- where AnalysisId
is the actual ID key from the QuickSight console URL of the analysis
A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code
value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code
value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
This value determines the layout behavior when the viewport is resized.
FIXED
: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic
.
RESPONSIVE
: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled
.
This value determines the layout behavior when the viewport is resized.
FIXED
: A fixed width will be used when optimizing the layout. In the QuickSight console, this option is called Classic
.
RESPONSIVE
: The width of the canvas will be responsive and optimized to the view port. In the QuickSight console, this option is called Tiled
.
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
", + "documentation":"A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by QuickSight to optimize query performance.
", "box":true } }, @@ -23648,7 +23808,7 @@ "members":{ "Services":{ "shape":"AuthorizedTargetsByServices", - "documentation":"A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.
" + "documentation":"A list of services and their authorized targets that the QuickSight IAM Identity Center application can access.
" }, "NextToken":{ "shape":"String", @@ -23732,7 +23892,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.
", + "documentation":"The ID for the Amazon Web Services account that contains the QuickSight namespaces that you want to list.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -24201,7 +24361,7 @@ }, "Type":{ "shape":"ThemeType", - "documentation":"The type of themes that you want to list. Valid options include the following:
ALL (default)
- Display all existing themes.
CUSTOM
- Display only the themes created by people using Amazon QuickSight.
QUICKSIGHT
- Display only the starting themes defined by Amazon QuickSight.
The type of themes that you want to list. Valid options include the following:
ALL (default)
- Display all existing themes.
CUSTOM
- Display only the themes created by people using Amazon QuickSight.
QUICKSIGHT
- Display only the starting themes defined by QuickSight.
The parameters that have a data type of date-time.
" } }, - "documentation":"A list of Amazon QuickSight parameters and the list's override values.
" + "documentation":"A list of QuickSight parameters and the list's override values.
" }, "Password":{ "type":"string", @@ -27171,7 +27340,7 @@ "documentation":"The alt text for the visual.
" } }, - "documentation":"A flexible visualization type that allows engineers to create new custom charts in Amazon QuickSight.
" + "documentation":"A flexible visualization type that allows engineers to create new custom charts in QuickSight.
" }, "PluginVisualAxisName":{ "type":"string", @@ -27609,6 +27778,27 @@ "DISABLED" ] }, + "QDataKey":{ + "type":"structure", + "members":{ + "QDataKeyArn":{ + "shape":"String", + "documentation":"The ARN of the KMS key that is registered to a QuickSight account for encryption and decryption use as a QDataKey
.
The type of QDataKey
.
A structure that contains information about the QDataKey
.
The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The recent snapshots configuration for an embedded QuickSight dashboard.
" } }, - "documentation":"The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The recent snapshots configuration for an embedded QuickSight dashboard.
" }, "RecoveryWindowInDays":{ "type":"long", @@ -27948,22 +28138,22 @@ "members":{ "RoleArn":{ "shape":"RoleArn", - "documentation":"Use the RoleArn
structure to allow Amazon QuickSight to call redshift:GetClusterCredentials
on your cluster. The calling principal must have iam:PassRole
access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
Use the RoleArn
structure to allow QuickSight to call redshift:GetClusterCredentials
on your cluster. The calling principal must have iam:PassRole
access to pass the role to QuickSight. The role's trust policy must allow the QuickSight service principal to assume the role.
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser
to True
to create a new user with PUBLIC permissions.
The user whose permissions and group memberships will be used by QuickSight to access the cluster. If this user already exists in your database, QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser
to True
to create a new user with PUBLIC permissions.
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser
. If you choose to include this parameter, the RoleArn
must grant access to redshift:JoinGroup
.
A list of groups whose permissions will be granted to QuickSight to access the cluster. These permissions are combined with the permissions granted to QuickSight by the DatabaseUser
. If you choose to include this parameter, the RoleArn
must grant access to redshift:JoinGroup
.
Automatically creates a database user. If your database doesn't have a DatabaseUser
, set this parameter to True
. If there is no DatabaseUser
, Amazon QuickSight can't connect to your cluster. The RoleArn
that you use for this operation must grant access to redshift:CreateClusterUser
to successfully create the user.
A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials
API. For more information on the redshift:GetClusterCredentials
API, see GetClusterCredentials
.
A structure that grants QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials
API. For more information on the redshift:GetClusterCredentials
API, see GetClusterCredentials
.
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
" + "documentation":"An optional parameter that uses IAM authentication to grant QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
" }, "IdentityCenterConfiguration":{ "shape":"IdentityCenterConfiguration", - "documentation":"An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
" + "documentation":"An optional parameter that configures IAM Identity Center authentication to grant QuickSight access to your cluster.
This parameter can only be specified if your QuickSight account is configured with IAM Identity Center.
" } }, "documentation":"The parameters for Amazon Redshift. The ClusterId
field can be blank if Host
and Port
are both set. The Host
and Port
fields can be blank if the ClusterId
field is set.
The identity type that your Amazon QuickSight account uses to manage the identity of users.
" + "documentation":"The identity type that your QuickSight account uses to manage the identity of users.
" }, "Email":{ "shape":"String", @@ -28315,7 +28505,7 @@ }, "UserRole":{ "shape":"UserRole", - "documentation":"The Amazon QuickSight role for the user. The user role can be one of the following:
READER
: A user who has read-only access to dashboards.
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN
: A user who is an author, who can also manage Amazon QuickSight settings.
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
RESTRICTED_READER
: This role isn't currently available for use.
RESTRICTED_AUTHOR
: This role isn't currently available for use.
The Amazon QuickSight role for the user. The user role can be one of the following:
READER
: A user who has read-only access to dashboards.
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN
: A user who is an author, who can also manage Amazon QuickSight settings.
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
RESTRICTED_READER
: This role isn't currently available for use.
RESTRICTED_AUTHOR
: This role isn't currently available for use.
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser
instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser
API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
" + "documentation":"(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser
instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser
API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader, admin pro, author pro, reader pro).
This feature is available only to QuickSight Enterprise edition subscriptions.
" }, "ExternalLoginFederationProviderType":{ "shape":"String", @@ -28351,7 +28541,7 @@ }, "CustomFederationProviderUrl":{ "shape":"String", - "documentation":"The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType
parameter is set to CUSTOM_OIDC
.
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType
parameter is set to CUSTOM_OIDC
.
The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.
" + "documentation":"The ARN of the KMS key that is registered to a QuickSight account for encryption and decryption use.
" }, "DefaultKey":{ "shape":"Boolean", "documentation":"Indicates whether a RegisteredCustomerManagedKey
is set as the default key for encryption and decryption use.
A customer managed key structure that contains the information listed below:
KeyArn
- The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.
DefaultKey
- Indicates whether the current key is set as the default key for encryption and decryption use.
A customer managed key structure that contains the information listed below:
KeyArn
- The ARN of a KMS key that is registered to a QuickSight account for encryption and decryption use.
DefaultKey
- Indicates whether the current key is set as the default key for encryption and decryption use.
The state persistence configurations of an embedded Amazon QuickSight console.
" + "documentation":"The state persistence configurations of an embedded QuickSight console.
" }, "SharedView":{ "shape":"SharedViewConfigurations", @@ -28412,22 +28602,22 @@ }, "AmazonQInQuickSight":{ "shape":"AmazonQInQuickSightConsoleConfigurations", - "documentation":"The Amazon Q configurations of an embedded Amazon QuickSight console.
" + "documentation":"The Amazon Q configurations of an embedded QuickSight console.
" }, "Schedules":{ "shape":"SchedulesConfigurations", - "documentation":"The schedules configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The schedules configuration for an embedded QuickSight dashboard.
" }, "RecentSnapshots":{ "shape":"RecentSnapshotsConfigurations", - "documentation":"The recent snapshots configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The recent snapshots configuration for an embedded QuickSight dashboard.
" }, "ThresholdAlerts":{ "shape":"ThresholdAlertsConfigurations", - "documentation":"The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The threshold alerts configuration for an embedded QuickSight dashboard.
" } }, - "documentation":"The feature configurations of an embedded Amazon QuickSight console.
" + "documentation":"The feature configurations of an embedded QuickSight console.
" }, "RegisteredUserDashboardEmbeddingConfiguration":{ "type":"structure", @@ -28435,11 +28625,11 @@ "members":{ "InitialDashboardId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.
If the user does not have permission to view this dashboard, they see a permissions error message.
" + "documentation":"The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this dashboard if the user has permissions to view it.
If the user does not have permission to view this dashboard, they see a permissions error message.
" }, "FeatureConfigurations":{ "shape":"RegisteredUserDashboardFeatureConfigurations", - "documentation":"The feature configurations of an embbedded Amazon QuickSight dashboard.
" + "documentation":"The feature configurations of an embbedded QuickSight dashboard.
" } }, "documentation":"Information about the dashboard you want to embed.
" @@ -28457,23 +28647,23 @@ }, "Bookmarks":{ "shape":"BookmarksConfigurations", - "documentation":"The bookmarks configuration for an embedded dashboard in Amazon QuickSight.
" + "documentation":"The bookmarks configuration for an embedded dashboard in QuickSight.
" }, "AmazonQInQuickSight":{ "shape":"AmazonQInQuickSightDashboardConfigurations", - "documentation":"The Amazon Q configurations of an embedded Amazon QuickSight dashboard.
" + "documentation":"The Amazon Q configurations of an embedded QuickSight dashboard.
" }, "Schedules":{ "shape":"SchedulesConfigurations", - "documentation":"The schedules configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The schedules configuration for an embedded QuickSight dashboard.
" }, "RecentSnapshots":{ "shape":"RecentSnapshotsConfigurations", - "documentation":"The recent snapshots configuration for an Amazon QuickSight embedded dashboard
" + "documentation":"The recent snapshots configuration for an QuickSight embedded dashboard
" }, "ThresholdAlerts":{ "shape":"ThresholdAlertsConfigurations", - "documentation":"The threshold alerts configuration for an Amazon QuickSight embedded dashboard.
" + "documentation":"The threshold alerts configuration for an QuickSight embedded dashboard.
" } }, "documentation":"The feature configuration for an embedded dashboard.
" @@ -28484,7 +28674,7 @@ "members":{ "InitialDashboardVisualId":{ "shape":"DashboardVisualId", - "documentation":"The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns
parameter. Otherwise, the request will fail with InvalidParameterValueException
.
The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns
parameter. Otherwise, the request will fail with InvalidParameterValueException
.
The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
" @@ -28498,29 +28688,29 @@ }, "QuickSightConsole":{ "shape":"RegisteredUserQuickSightConsoleEmbeddingConfiguration", - "documentation":"The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.
Use GenerateEmbedUrlForRegisteredUser
where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser
API operation. Use the RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" + "documentation":"The configuration details for providing each QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the QuickSight Console in the Amazon QuickSight User Guide.
Use GenerateEmbedUrlForRegisteredUser
where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser
API operation. Use the RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" }, "QSearchBar":{ "shape":"RegisteredUserQSearchBarEmbeddingConfiguration", - "documentation":"The configuration details for embedding the Q search bar.
For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight User Guide.
" + "documentation":"The configuration details for embedding the Q search bar.
For more information about embedding the Q search bar, see Embedding Overview in the QuickSight User Guide.
" }, "DashboardVisual":{ "shape":"RegisteredUserDashboardVisualEmbeddingConfiguration", - "documentation":"The type of embedding experience. In this case, Amazon QuickSight visuals.
" + "documentation":"The type of embedding experience. In this case, QuickSight visuals.
" }, "GenerativeQnA":{ "shape":"RegisteredUserGenerativeQnAEmbeddingConfiguration", - "documentation":"The configuration details for embedding the Generative Q&A experience.
For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon QuickSight User Guide.
" + "documentation":"The configuration details for embedding the Generative Q&A experience.
For more information about embedding the Generative Q&A experience, see Embedding Overview in the QuickSight User Guide.
" } }, - "documentation":"The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.
Exactly one of the experience configurations is required. You can choose Dashboard
or QuickSightConsole
. You cannot choose more than one experience configuration.
The type of experience you want to embed. For registered users, you can embed QuickSight dashboards or the QuickSight console.
Exactly one of the experience configurations is required. You can choose Dashboard
or QuickSightConsole
. You cannot choose more than one experience configuration.
The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.
If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
" + "documentation":"The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the QuickSight application and opening a topic. The ID is in the URL for the topic that you open.
If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
" } }, "documentation":"An object that provides information about the configuration of a Generative Q&A experience.
" @@ -28530,7 +28720,7 @@ "members":{ "InitialTopicId":{ "shape":"RestrictiveResourceId", - "documentation":"The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID
is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.
If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
" + "documentation":"The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID
is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.
If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
" } }, "documentation":"Information about the Q search bar embedding experience.
" @@ -28540,14 +28730,14 @@ "members":{ "InitialPath":{ "shape":"EntryPath", - "documentation":"The initial URL path for the Amazon QuickSight console. InitialPath
is required.
The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId
. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.
/analyses/AnalysisId
. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
The initial URL path for the QuickSight console. InitialPath
is required.
The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId
. DashboardId is the actual ID key from the QuickSight console URL of the dashboard.
/analyses/AnalysisId
. AnalysisId is the actual ID key from the QuickSight console URL of the analysis.
The embedding configuration of an embedded Amazon QuickSight console.
" + "documentation":"The embedding configuration of an embedded QuickSight console.
" } }, - "documentation":"Information about the Amazon QuickSight console that you want to embed.
" + "documentation":"Information about the QuickSight console that you want to embed.
" }, "RelationalTable":{ "type":"structure", @@ -29108,7 +29298,7 @@ "documentation":"The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob
API call is made.
An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.
" + "documentation":"An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default QuickSight bucket.
" }, "S3Key":{ "type":"string", @@ -29121,7 +29311,7 @@ "members":{ "ManifestFileLocation":{ "shape":"ManifestFileLocation", - "documentation":"Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
" + "documentation":"Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into QuickSight.
" }, "RoleArn":{ "shape":"RoleArn", @@ -29447,10 +29637,10 @@ "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"The schedules configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The schedules configuration for an embedded QuickSight dashboard.
" } }, - "documentation":"The schedules configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The schedules configuration for an embedded QuickSight dashboard.
" }, "ScrollBarOptions":{ "type":"structure", @@ -30256,7 +30446,7 @@ }, "Name":{ "shape":"SheetName", - "documentation":"The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
" + "documentation":"The name of a sheet. This name is displayed on the sheet's tab in the QuickSight console.
" }, "Images":{ "shape":"SheetImageList", @@ -30372,7 +30562,7 @@ }, "Name":{ "shape":"SheetName", - "documentation":"The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
" + "documentation":"The name of the sheet. This name is displayed on the sheet's tab in the QuickSight console.
" }, "ParameterControls":{ "shape":"ParameterControlList", @@ -30694,19 +30884,19 @@ "members":{ "IAMUser":{ "shape":"Boolean", - "documentation":"A Boolean that is TRUE
if the Amazon QuickSight uses IAM as an authentication method.
A Boolean that is TRUE
if the QuickSight uses IAM as an authentication method.
The user login name for your Amazon QuickSight account.
" + "documentation":"The user login name for your QuickSight account.
" }, "accountName":{ "shape":"String", - "documentation":"The name of your Amazon QuickSight account.
" + "documentation":"The name of your QuickSight account.
" }, "directoryType":{ "shape":"String", - "documentation":"The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are SIMPLE_AD
, AD_CONNECTOR
, and MICROSOFT_AD
.
The type of Active Directory that is being used to authenticate the QuickSight account. Valid values are SIMPLE_AD
, AD_CONNECTOR
, and MICROSOFT_AD
.
A SignupResponse
object that contains a summary of a newly created account.
The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration
API call.
These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
" + "documentation":"The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration
API call.
These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
" } }, "documentation":"A structure that contains information on the anonymous user configuration.
" @@ -31167,7 +31357,7 @@ }, "OAuthParameters":{ "shape":"OAuthParameters", - "documentation":"An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
" + "documentation":"An object that contains information needed to create a data source connection between an QuickSight account and Snowflake.
" } }, "documentation":"The parameters for Snowflake.
" @@ -31283,7 +31473,7 @@ "documentation":"A Boolean option to control whether SSL should be disabled.
" } }, - "documentation":"Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
" + "documentation":"Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
" }, "StarburstParameters":{ "type":"structure", @@ -31319,7 +31509,7 @@ }, "OAuthParameters":{ "shape":"OAuthParameters", - "documentation":"An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
" + "documentation":"An object that contains information needed to create a data source connection between an QuickSight account and Starburst.
" } }, "documentation":"The parameters that are required to connect to a Starburst data source.
" @@ -31438,7 +31628,7 @@ }, "FailureAction":{ "shape":"AssetBundleImportFailureAction", - "documentation":"The failure action for the import job.
If you choose ROLLBACK
, failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING
, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
The failure action for the import job.
If you choose ROLLBACK
, failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING
, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the QuickSight account in an inconsistent state.
A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.
" + "documentation":"A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered QuickSight.
" }, "SnapshotConfiguration":{ "shape":"SnapshotConfiguration", @@ -31556,7 +31746,7 @@ }, "ScheduleId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon QuickSight console in the Schedules pane of the dashboard that the schedule is configured for.
", + "documentation":"The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the QuickSight console in the Schedules pane of the dashboard that the schedule is configured for.
", "location":"uri", "locationName":"ScheduleId" } @@ -31582,7 +31772,7 @@ "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
" + "documentation":"Determines if a QuickSight dashboard's state persistence settings are turned on or off.
" } }, "documentation":"The state perssitence configuration of an embedded dashboard.
" @@ -31906,7 +32096,7 @@ "documentation":"The HTTP status of a SuccessfulKeyRegistrationEntry
entry.
A success entry that occurs when a KeyRegistration
job is successfully applied to the Amazon QuickSight account.
A success entry that occurs when a KeyRegistration
job is successfully applied to the QuickSight account.
Time when this was created.
" } }, - "documentation":"A template object. A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to create a template or a dashboard from an existing template.
" + "documentation":"A template object. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to create a template or a dashboard from an existing template.
" }, "TemplateAlias":{ "type":"structure", @@ -33141,7 +33331,7 @@ }, "BaseThemeId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
" + "documentation":"The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
" }, "CreatedTime":{ "shape":"Timestamp", @@ -33217,10 +33407,10 @@ "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The threshold alerts configuration for an embedded QuickSight dashboard.
" } }, - "documentation":"The threshold alerts configuration for an embedded Amazon QuickSight dashboard.
" + "documentation":"The threshold alerts configuration for an embedded QuickSight dashboard.
" }, "ThrottlingException":{ "type":"structure", @@ -33972,6 +34162,10 @@ "RelativeDateFilter":{ "shape":"TopicRelativeDateFilter", "documentation":"The relative date filter.
" + }, + "NullFilter":{ + "shape":"TopicNullFilter", + "documentation":"The null filter.
" } }, "documentation":"A structure that represents a filter used to select items for a topic.
" @@ -34298,6 +34492,21 @@ }, "documentation":"A structure that represents a named entity.
" }, + "TopicNullFilter":{ + "type":"structure", + "members":{ + "NullFilterType":{ + "shape":"NullFilterType", + "documentation":"The type of the null filter. Valid values for this type are NULLS_ONLY
, NON_NULLS_ONLY
, and ALL_VALUES
.
A Boolean value that indicates if the filter is inverse.
" + } + }, + "documentation":"The structure that represents a null filter.
" + }, "TopicNumericEqualityFilter":{ "type":"structure", "members":{ @@ -35208,7 +35417,7 @@ "documentation":"The Amazon Web Services request ID for this request.
" } }, - "documentation":"This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl
API operation with the --identity-type ANONYMOUS
option.
This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You can do this on the Manage QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl
API operation with the --identity-type ANONYMOUS
option.
The Amazon Web Services request ID for this request.
" } }, - "documentation":"This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
", + "documentation":"This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
", "error":{"httpStatusCode":403}, "exception":true }, @@ -35278,6 +35487,38 @@ } } }, + "UpdateAccountCustomPermissionRequest":{ + "type":"structure", + "required":[ + "CustomPermissionsName", + "AwsAccountId" + ], + "members":{ + "CustomPermissionsName":{ + "shape":"CustomPermissionsName", + "documentation":"The name of the custom permissions profile that you want to apply to an account.
" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"The ID of the Amazon Web Services account for which you want to apply a custom permissions profile.
", + "location":"uri", + "locationName":"AwsAccountId" + } + } + }, + "UpdateAccountCustomPermissionResponse":{ + "type":"structure", + "members":{ + "RequestId":{ + "shape":"String", + "documentation":"The Amazon Web Services request ID for this operation.
" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"The HTTP status of the request.
" + } + } + }, "UpdateAccountCustomizationRequest":{ "type":"structure", "required":[ @@ -35287,19 +35528,19 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
", + "documentation":"The ID for the Amazon Web Services account that you want to update QuickSight customizations for.
", "location":"uri", "locationName":"AwsAccountId" }, "Namespace":{ "shape":"Namespace", - "documentation":"The namespace that you want to update Amazon QuickSight customizations for.
", + "documentation":"The namespace that you want to update QuickSight customizations for.
", "location":"querystring", "locationName":"namespace" }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
" + "documentation":"The QuickSight customizations you're updating in the current Amazon Web Services Region.
" } } }, @@ -35312,7 +35553,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
" + "documentation":"The ID for the Amazon Web Services account that you want to update QuickSight customizations for.
" }, "Namespace":{ "shape":"Namespace", @@ -35320,7 +35561,7 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
" + "documentation":"The QuickSight customizations you're updating in the current Amazon Web Services Region.
" }, "RequestId":{ "shape":"String", @@ -35342,21 +35583,21 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.
", + "documentation":"The ID for the Amazon Web Services account that contains the QuickSight settings that you want to list.
", "location":"uri", "locationName":"AwsAccountId" }, "DefaultNamespace":{ "shape":"Namespace", - "documentation":"The default namespace for this Amazon Web Services account. Currently, the default is default
. IAM users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace.
The default namespace for this Amazon Web Services account. Currently, the default is default
. IAM users that register for the first time with QuickSight provide an email address that becomes associated with the default namespace.
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.
" + "documentation":"The email address that you want QuickSight to send notifications to regarding your Amazon Web Services account or QuickSight subscription.
" }, "TerminationProtectionEnabled":{ "shape":"Boolean", - "documentation":"A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True
value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription
request. A False
value will allow the account to be deleted.
A boolean value that determines whether or not an QuickSight account can be deleted. A True
value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription
request. A False
value will allow the account to be deleted.
A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.
" + "documentation":"A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.
" }, "Parameters":{ "shape":"Parameters", @@ -35463,7 +35704,7 @@ }, "ThemeArn":{ "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
" + "documentation":"The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
" }, "Definition":{ "shape":"AnalysisDefinition", @@ -35516,7 +35757,7 @@ }, "Namespace":{ "shape":"Namespace", - "documentation":"The namespace of the Amazon QuickSight application.
", + "documentation":"The namespace of the QuickSight application.
", "location":"querystring", "locationName":"namespace" } @@ -35584,7 +35825,7 @@ }, "BrandId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The ID of the Amazon QuickSight brand.
", + "documentation":"The ID of the QuickSight brand.
", "location":"uri", "locationName":"BrandId" }, @@ -35622,7 +35863,7 @@ }, "BrandId":{ "shape":"ShortRestrictiveResourceId", - "documentation":"The ID of the Amazon QuickSight brand.
", + "documentation":"The ID of the QuickSight brand.
", "location":"uri", "locationName":"BrandId" }, @@ -35802,7 +36043,7 @@ }, "LinkSharingConfiguration":{ "shape":"LinkSharingConfiguration", - "documentation":"Updates the permissions of a shared link to an Amazon QuickSight dashboard.
" + "documentation":"Updates the permissions of a shared link to an QuickSight dashboard.
" } } }, @@ -35882,7 +36123,7 @@ }, "SourceEntity":{ "shape":"DashboardSourceEntity", - "documentation":"The entity that you are using as a source when you update the dashboard. In SourceEntity
, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate
entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate
API operation. For SourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you update the dashboard. In SourceEntity
, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate
entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate
API operation. For SourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate
ARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
Options for publishing the dashboard when you create it:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either ENABLED
or DISABLED
. When this is set to DISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either ENABLED
or DISABLED
. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either COLLAPSED
or EXPANDED
. This option is COLLAPSED
by default.
Options for publishing the dashboard when you create it:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either ENABLED
or DISABLED
. When this is set to DISABLED
, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either ENABLED
or DISABLED
. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either COLLAPSED
or EXPANDED
. This option is COLLAPSED
by default.
AvailabilityStatus
for ExecutiveSummaryOption
- This status can be either ENABLED
or DISABLED
. The option to build an executive summary is disabled when this is set to DISABLED
. This option is ENABLED
by default.
AvailabilityStatus
for DataStoriesSharingOption
- This status can be either ENABLED
or DISABLED
. The option to share a data story is disabled when this is set to DISABLED
. This option is ENABLED
by default.
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
" + "documentation":"Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
" }, "FieldFolders":{ "shape":"FieldFolderMap", @@ -36203,19 +36444,19 @@ }, "DataSourceParameters":{ "shape":"DataSourceParameters", - "documentation":"The parameters that Amazon QuickSight uses to connect to your underlying source.
" + "documentation":"The parameters that QuickSight uses to connect to your underlying source.
" }, "Credentials":{ "shape":"DataSourceCredentials", - "documentation":"The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
" + "documentation":"The credentials that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
" }, "VpcConnectionProperties":{ "shape":"VpcConnectionProperties", - "documentation":"Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
" + "documentation":"Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
" }, "SslProperties":{ "shape":"SslProperties", - "documentation":"Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
" + "documentation":"Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
" } } }, @@ -36254,13 +36495,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the Amazon QuickSight account that is connected to the Amazon Q Business application that you want to update.
", + "documentation":"The ID of the QuickSight account that is connected to the Amazon Q Business application that you want to update.
", "location":"uri", "locationName":"AwsAccountId" }, "Namespace":{ "shape":"Namespace", - "documentation":"The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.
", + "documentation":"The QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.
", "location":"querystring", "locationName":"namespace" }, @@ -36468,11 +36709,11 @@ }, "PolicyArn":{ "shape":"Arn", - "documentation":"The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
" + "documentation":"The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
" }, "Identities":{ "shape":"IdentityMap", - "documentation":"The Amazon QuickSight users, groups, or both that you want to assign the policy to.
" + "documentation":"The QuickSight users, groups, or both that you want to assign the policy to.
" } } }, @@ -36489,11 +36730,11 @@ }, "PolicyArn":{ "shape":"Arn", - "documentation":"The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.
" + "documentation":"The ARN for the IAM policy applied to the QuickSight users and groups specified in this assignment.
" }, "Identities":{ "shape":"IdentityMap", - "documentation":"The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
" + "documentation":"The QuickSight users, groups, or both that the IAM policy is assigned to.
" }, "AssignmentStatus":{ "shape":"AssignmentStatus", @@ -36610,7 +36851,7 @@ }, "KeyRegistration":{ "shape":"KeyRegistration", - "documentation":"A list of RegisteredCustomerManagedKey
objects to be updated to the Amazon QuickSight account.
A list of RegisteredCustomerManagedKey
objects to be updated to the QuickSight account.
The Amazon Web Services account ID associated with your Amazon QuickSight subscription.
", + "documentation":"The Amazon Web Services account ID associated with your QuickSight subscription.
", "location":"uri", "locationName":"AwsAccountId" }, "PublicSharingEnabled":{ "shape":"Boolean", - "documentation":"A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.
" + "documentation":"A Boolean value that indicates whether public sharing is turned on for an QuickSight account.
" } } }, @@ -36681,7 +36922,7 @@ }, "PersonalizationMode":{ "shape":"PersonalizationMode", - "documentation":"An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.
" + "documentation":"An option to allow QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.
" } } }, @@ -36712,13 +36953,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that you want to update.
", + "documentation":"The ID of the Amazon Web Services account that contains the QuickSight Q Search configuration that you want to update.
", "location":"uri", "locationName":"AwsAccountId" }, "QSearchStatus":{ "shape":"QSearchStatus", - "documentation":"The status of the Amazon QuickSight Q Search configuration that the user wants to update.
" + "documentation":"The status of the QuickSight Q Search configuration that the user wants to update.
" } } }, @@ -36727,7 +36968,7 @@ "members":{ "QSearchStatus":{ "shape":"QSearchStatus", - "documentation":"The status of the Amazon QuickSight Q Search configuration.
" + "documentation":"The status of the QuickSight Q Search configuration.
" }, "RequestId":{ "shape":"String", @@ -36999,7 +37240,7 @@ }, "SourceEntity":{ "shape":"TemplateSourceEntity", - "documentation":"The entity that you are using as a source when you update the template. In SourceEntity
, you specify the type of object you're using as source: SourceTemplate
for a template or SourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate
, specify the ARN of the source template. For SourceAnalysis
, specify the ARN of the source analysis. The SourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences
entity within SourceTemplate
or SourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you update the template. In SourceEntity
, you specify the type of object you're using as source: SourceTemplate
for a template or SourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate
, specify the ARN of the source template. For SourceAnalysis
, specify the ARN of the source analysis. The SourceTemplate
ARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences
entity within SourceTemplate
or SourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
" + "documentation":"The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
" }, "VersionDescription":{ "shape":"VersionDescription", @@ -37474,11 +37715,11 @@ }, "Role":{ "shape":"UserRole", - "documentation":"The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:
READER
: A user who has read-only access to dashboards.
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN
: A user who is an author, who can also manage Amazon QuickSight settings.
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
" + "documentation":"The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:
READER
: A user who has read-only access to dashboards.
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN
: A user who is an author, who can also manage Amazon QuickSight settings.
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.
" }, "CustomPermissionsName":{ "shape":"RoleName", - "documentation":"(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser
API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
" + "documentation":"(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser
API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions.
" }, "UnapplyCustomPermissions":{ "shape":"Boolean", @@ -37486,11 +37727,11 @@ }, "ExternalLoginFederationProviderType":{ "shape":"String", - "documentation":"The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
COGNITO
: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO
provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.
CUSTOM_OIDC
: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC
type, use the CustomFederationProviderUrl
parameter to provide the custom OIDC provider URL.
NONE
: This clears all the previously saved external login information for a user. Use the DescribeUser
API operation to check the external login information.
The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
COGNITO
: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO
provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.
CUSTOM_OIDC
: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC
type, use the CustomFederationProviderUrl
parameter to provide the custom OIDC provider URL.
NONE
: This clears all the previously saved external login information for a user. Use the DescribeUser
API operation to check the external login information.
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType
parameter is set to CUSTOM_OIDC
.
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType
parameter is set to CUSTOM_OIDC
.
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName
is N/A
when the value for IdentityType
is IAM
and the corresponding IAM user is deleted.
The user's user name. This value is required if you are registering a user that will be managed in QuickSight. In the output, the value for UserName
is N/A
when the value for IdentityType
is IAM
and the corresponding IAM user is deleted.
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER
: A user who has read-only access to dashboards.
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN
: A user who is an author, who can also manage Amazon Amazon QuickSight settings.
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
RESTRICTED_READER
: This role isn't currently available for use.
RESTRICTED_AUTHOR
: This role isn't currently available for use.
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER
: A user who has read-only access to dashboards.
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN
: A user who is an author, who can also manage Amazon QuickSight settings.
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
RESTRICTED_READER
: This role isn't currently available for use.
RESTRICTED_AUTHOR
: This role isn't currently available for use.
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
.
The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE
and IAM_AUTH
. When set to IAM_AUTH
, the proxy uses end-to-end IAM authentication to connect to the database. If you don't specify DefaultAuthScheme
or specify this parameter as NONE
, you must specify the Auth
option.
The authorization mechanism that the proxy uses.
" @@ -7654,6 +7657,10 @@ "shape":"StringList", "documentation":"The EC2 subnet IDs for the proxy.
" }, + "DefaultAuthScheme":{ + "shape":"String", + "documentation":"The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE
and IAM_AUTH
. When set to IAM_AUTH
, the proxy uses end-to-end IAM authentication to connect to the database.
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
" @@ -8768,6 +8775,13 @@ "advanced" ] }, + "DefaultAuthScheme":{ + "type":"string", + "enum":[ + "IAM_AUTH", + "NONE" + ] + }, "DeleteBlueGreenDeploymentRequest":{ "type":"structure", "required":["BlueGreenDeploymentIdentifier"], @@ -12897,6 +12911,10 @@ "shape":"String", "documentation":"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 default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE
and IAM_AUTH
. When set to IAM_AUTH
, the proxy uses end-to-end IAM authentication to connect to the database.
The new authentication settings for the DBProxy
.
Creates an Amazon Redshift application for use with IAM Identity Center.
" }, @@ -4717,6 +4719,14 @@ "ServiceIntegrations":{ "shape":"ServiceIntegrationList", "documentation":"A collection of service integrations for the Redshift IAM Identity Center application.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of tags.
" + }, + "SsoTagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of tags keys that Redshift Identity Center applications copy to IAM Identity Center. For each input key, the tag corresponding to the key-value pair is propagated.
" } } }, @@ -9643,6 +9653,14 @@ "ServiceIntegrations":{ "shape":"ServiceIntegrationList", "documentation":"A list of service integrations for the Redshift IAM Identity Center application.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of tags.
" + }, + "SsoTagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of tags keys that Redshift Identity Center applications copy to IAM Identity Center. For each input key, the tag corresponding to the key-value pair is propagated.
" } }, "documentation":"Contains properties for the Redshift IDC application.
", diff --git a/services/redshiftdata/pom.xml b/services/redshiftdata/pom.xml index 5ec0a2b47f59..b61a15b40ad0 100644 --- a/services/redshiftdata/pom.xml +++ b/services/redshiftdata/pom.xml @@ -21,7 +21,7 @@The Amazon Web Services Security Token Service temporary credential that S3 Access Grants vends to grantees and client applications.
", "sensitive":true }, + "DSSEKMSFilter":{ + "type":"structure", + "members":{ + "KmsKeyArn":{ + "shape":"NonEmptyKmsKeyArnString", + "documentation":"The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter to return objects that are encrypted by the specified key. For best performance, we recommend using the KMSKeyArn
filter in conjunction with other object metadata filters, like MatchAnyPrefix
, CreatedAfter
, or MatchAnyStorageClass
.
You must provide the full KMS Key ARN. You can't use an alias name or alias ARN. For more information, see KMS keys in the Amazon Web Services Key Management Service Developer Guide.
A filter that returns objects that are encrypted by dual-layer server-side encryption with Amazon Web Services Key Management Service (KMS) keys (DSSE-KMS). You can further refine your filtering by optionally providing a KMS Key ARN to create an object list of DSSE-KMS objects with that specific KMS Key ARN.
" + }, "DataSourceId":{ "type":"string", "max":191 @@ -4978,6 +4989,10 @@ "MatchAnyStorageClass":{ "shape":"StorageClassList", "documentation":"If provided, the generated manifest includes only source bucket objects that are stored with the specified storage class.
" + }, + "MatchAnyObjectEncryption":{ + "shape":"ObjectEncryptionFilterList", + "documentation":"If provided, the generated object list includes only source bucket objects with the indicated server-side encryption type (SSE-S3, SSE-KMS, DSSE-KMS, SSE-C, or NOT-SSE). If you select SSE-KMS or DSSE-KMS, you can optionally further filter your results by specifying a specific KMS Key ARN. If you select SSE-KMS, you can also optionally further filter your results by Bucket Key enabled status.
" } }, "documentation":"The filter used to describe a set of objects for the job's manifest.
" @@ -5310,7 +5325,7 @@ }, "NoncurrentVersionTransitions":{ "shape":"NoncurrentVersionTransitionList", - "documentation":"Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
This is not supported by Amazon S3 on Outposts buckets.
Specifies the transition rule for the lifecycle rule that describes when non-current objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
This is not supported by Amazon S3 on Outposts buckets.
A filter that returns objects that aren't server-side encrypted.
" + }, "ObjectAgeValue":{"type":"integer"}, "ObjectCreationTime":{"type":"timestamp"}, + "ObjectEncryptionFilter":{ + "type":"structure", + "members":{ + "SSES3":{ + "shape":"SSES3Filter", + "documentation":"Filters for objects that are encrypted by server-side encryption with Amazon S3 managed keys (SSE-S3).
", + "locationName":"SSE-S3" + }, + "SSEKMS":{ + "shape":"SSEKMSFilter", + "documentation":"Filters for objects that are encrypted by server-side encryption with Amazon Web Services Key Management Service (KMS) keys (SSE-KMS).
", + "locationName":"SSE-KMS" + }, + "DSSEKMS":{ + "shape":"DSSEKMSFilter", + "documentation":"Filters for objects that are encrypted by dual-layer server-side encryption with Amazon Web Services Key Management Service (KMS) keys (DSSE-KMS).
", + "locationName":"DSSE-KMS" + }, + "SSEC":{ + "shape":"SSECFilter", + "documentation":"Filters for objects that are encrypted by server-side encryption with customer-provided keys (SSE-C).
", + "locationName":"SSE-C" + }, + "NOTSSE":{ + "shape":"NotSSEFilter", + "documentation":"Filters for objects that are not encrypted by server-side encryption.
", + "locationName":"NOT-SSE" + } + }, + "documentation":"An optional filter for the S3JobManifestGenerator
that identifies the subset of objects by encryption type. This filter is used to create an object list for S3 Batch Operations jobs. If provided, this filter will generate an object list that only includes objects with the specified encryption type.
A filter that returns objects that are encrypted by server-side encryption with customer-provided keys (SSE-C).
" + }, "SSEKMS":{ "type":"structure", "required":["KeyId"], @@ -8202,6 +8274,22 @@ "documentation":"Configuration for the use of SSE-KMS to encrypt generated manifest objects.
", "locationName":"SSE-KMS" }, + "SSEKMSFilter":{ + "type":"structure", + "members":{ + "KmsKeyArn":{ + "shape":"NonEmptyKmsKeyArnString", + "documentation":"The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter to return objects that are encrypted by the specified key. For best performance, we recommend using the KMSKeyArn
filter in conjunction with other object metadata filters, like MatchAnyPrefix
, CreatedAfter
, or MatchAnyStorageClass
.
You must provide the full KMS Key ARN. You can't use an alias name or alias ARN. For more information, see KMS keys in the Amazon Web Services Key Management Service Developer Guide.
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services Key Management Service (Amazon Web Services KMS) keys (SSE-KMS). If specified, will filter SSE-KMS encrypted objects by S3 Bucket Key status. For more information, see Reducing the cost of SSE-KMS with Amazon S3 Bucket Keys in the Amazon S3 User Guide.
", + "box":true + } + }, + "documentation":"A filter that returns objects that are encrypted by server-side encryption with Amazon Web Services KMS (SSE-KMS).
" + }, "SSEKMSKeyId":{"type":"string"}, "SSES3":{ "type":"structure", @@ -8215,6 +8303,11 @@ "documentation":"Configuration for the use of SSE-S3 to encrypt generated manifest objects.
", "locationName":"SSE-S3" }, + "SSES3Filter":{ + "type":"structure", + "members":{}, + "documentation":"A filter that returns objects that are encrypted by server-side encryption with Amazon S3 managed keys (SSE-S3).
" + }, "Scope":{ "type":"structure", "members":{ diff --git a/services/s3outposts/pom.xml b/services/s3outposts/pom.xml index bc4cc3e29809..e3f48285bfd5 100644 --- a/services/s3outposts/pom.xml +++ b/services/s3outposts/pom.xml @@ -21,7 +21,7 @@Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
" - }, - "CreateReplicationJob":{ - "name":"CreateReplicationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateReplicationJobRequest"}, - "output":{"shape":"CreateReplicationJobResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"UnauthorizedOperationException"}, - {"shape":"OperationNotPermittedException"}, - {"shape":"ServerCannotBeReplicatedException"}, - {"shape":"ReplicationJobAlreadyExistsException"}, - {"shape":"NoConnectorsAvailableException"}, - {"shape":"InternalError"}, - {"shape":"TemporarilyUnavailableException"} - ], - "documentation":"Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI).
" - }, - "DeleteApp":{ - "name":"DeleteApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAppRequest"}, - "output":{"shape":"DeleteAppResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Deletes the specified application. Optionally deletes the launched stack associated with the application and all Server Migration Service replication jobs for servers in the application.
" - }, - "DeleteAppLaunchConfiguration":{ - "name":"DeleteAppLaunchConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAppLaunchConfigurationRequest"}, - "output":{"shape":"DeleteAppLaunchConfigurationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Deletes the launch configuration for the specified application.
" - }, - "DeleteAppReplicationConfiguration":{ - "name":"DeleteAppReplicationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAppReplicationConfigurationRequest"}, - "output":{"shape":"DeleteAppReplicationConfigurationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Deletes the replication configuration for the specified application.
" - }, - "DeleteAppValidationConfiguration":{ - "name":"DeleteAppValidationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAppValidationConfigurationRequest"}, - "output":{"shape":"DeleteAppValidationConfigurationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Deletes the validation configuration for the specified application.
" - }, - "DeleteReplicationJob":{ - "name":"DeleteReplicationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteReplicationJobRequest"}, - "output":{"shape":"DeleteReplicationJobResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"UnauthorizedOperationException"}, - {"shape":"OperationNotPermittedException"}, - {"shape":"ReplicationJobNotFoundException"} - ], - "documentation":"Deletes the specified replication job.
After you delete a replication job, there are no further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created by the replication runs are not deleted.
" - }, - "DeleteServerCatalog":{ - "name":"DeleteServerCatalog", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteServerCatalogRequest"}, - "output":{"shape":"DeleteServerCatalogResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"OperationNotPermittedException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"} - ], - "documentation":"Deletes all servers from your server catalog.
" - }, - "DisassociateConnector":{ - "name":"DisassociateConnector", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateConnectorRequest"}, - "output":{"shape":"DisassociateConnectorResponse"}, - "errors":[ - {"shape":"MissingRequiredParameterException"}, - {"shape":"UnauthorizedOperationException"}, - {"shape":"OperationNotPermittedException"}, - {"shape":"InvalidParameterException"} - ], - "documentation":"Disassociates the specified connector from Server Migration Service.
After you disassociate a connector, it is no longer available to support replication jobs.
" - }, - "GenerateChangeSet":{ - "name":"GenerateChangeSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateChangeSetRequest"}, - "output":{"shape":"GenerateChangeSetResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
" - }, - "GenerateTemplate":{ - "name":"GenerateTemplate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateTemplateRequest"}, - "output":{"shape":"GenerateTemplateResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
" - }, - "GetApp":{ - "name":"GetApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAppRequest"}, - "output":{"shape":"GetAppResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Retrieve information about the specified application.
" - }, - "GetAppLaunchConfiguration":{ - "name":"GetAppLaunchConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAppLaunchConfigurationRequest"}, - "output":{"shape":"GetAppLaunchConfigurationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Retrieves the application launch configuration associated with the specified application.
" - }, - "GetAppReplicationConfiguration":{ - "name":"GetAppReplicationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAppReplicationConfigurationRequest"}, - "output":{"shape":"GetAppReplicationConfigurationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Retrieves the application replication configuration associated with the specified application.
" - }, - "GetAppValidationConfiguration":{ - "name":"GetAppValidationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAppValidationConfigurationRequest"}, - "output":{"shape":"GetAppValidationConfigurationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Retrieves information about a configuration for validating an application.
" - }, - "GetAppValidationOutput":{ - "name":"GetAppValidationOutput", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAppValidationOutputRequest"}, - "output":{"shape":"GetAppValidationOutputResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Retrieves output from validating an application.
" - }, - "GetConnectors":{ - "name":"GetConnectors", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetConnectorsRequest"}, - "output":{"shape":"GetConnectorsResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"} - ], - "documentation":"Describes the connectors registered with the Server Migration Service.
" - }, - "GetReplicationJobs":{ - "name":"GetReplicationJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetReplicationJobsRequest"}, - "output":{"shape":"GetReplicationJobsResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"UnauthorizedOperationException"} - ], - "documentation":"Describes the specified replication job or all of your replication jobs.
" - }, - "GetReplicationRuns":{ - "name":"GetReplicationRuns", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetReplicationRunsRequest"}, - "output":{"shape":"GetReplicationRunsResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"UnauthorizedOperationException"} - ], - "documentation":"Describes the replication runs for the specified replication job.
" - }, - "GetServers":{ - "name":"GetServers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetServersRequest"}, - "output":{"shape":"GetServersResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"} - ], - "documentation":"Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
" - }, - "ImportAppCatalog":{ - "name":"ImportAppCatalog", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ImportAppCatalogRequest"}, - "output":{"shape":"ImportAppCatalogResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Allows application import from Migration Hub.
" - }, - "ImportServerCatalog":{ - "name":"ImportServerCatalog", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ImportServerCatalogRequest"}, - "output":{"shape":"ImportServerCatalogResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"OperationNotPermittedException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"NoConnectorsAvailableException"} - ], - "documentation":"Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.
This call returns immediately, but might take additional time to retrieve all the servers.
" - }, - "LaunchApp":{ - "name":"LaunchApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"LaunchAppRequest"}, - "output":{"shape":"LaunchAppResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Launches the specified application as a stack in CloudFormation.
" - }, - "ListApps":{ - "name":"ListApps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAppsRequest"}, - "output":{"shape":"ListAppsResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Retrieves summaries for all applications.
" - }, - "NotifyAppValidationOutput":{ - "name":"NotifyAppValidationOutput", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"NotifyAppValidationOutputRequest"}, - "output":{"shape":"NotifyAppValidationOutputResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Provides information to Server Migration Service about whether application validation is successful.
" - }, - "PutAppLaunchConfiguration":{ - "name":"PutAppLaunchConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutAppLaunchConfigurationRequest"}, - "output":{"shape":"PutAppLaunchConfigurationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Creates or updates the launch configuration for the specified application.
" - }, - "PutAppReplicationConfiguration":{ - "name":"PutAppReplicationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutAppReplicationConfigurationRequest"}, - "output":{"shape":"PutAppReplicationConfigurationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Creates or updates the replication configuration for the specified application.
" - }, - "PutAppValidationConfiguration":{ - "name":"PutAppValidationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutAppValidationConfigurationRequest"}, - "output":{"shape":"PutAppValidationConfigurationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Creates or updates a validation configuration for the specified application.
" - }, - "StartAppReplication":{ - "name":"StartAppReplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartAppReplicationRequest"}, - "output":{"shape":"StartAppReplicationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Starts replicating the specified application by creating replication jobs for each server in the application.
" - }, - "StartOnDemandAppReplication":{ - "name":"StartOnDemandAppReplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartOnDemandAppReplicationRequest"}, - "output":{"shape":"StartOnDemandAppReplicationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Starts an on-demand replication run for the specified application.
" - }, - "StartOnDemandReplicationRun":{ - "name":"StartOnDemandReplicationRun", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartOnDemandReplicationRunRequest"}, - "output":{"shape":"StartOnDemandReplicationRunResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"UnauthorizedOperationException"}, - {"shape":"OperationNotPermittedException"}, - {"shape":"ReplicationRunLimitExceededException"}, - {"shape":"DryRunOperationException"} - ], - "documentation":"Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.
There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.
" - }, - "StopAppReplication":{ - "name":"StopAppReplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopAppReplicationRequest"}, - "output":{"shape":"StopAppReplicationResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Stops replicating the specified application by deleting the replication job for each server in the application.
" - }, - "TerminateApp":{ - "name":"TerminateApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TerminateAppRequest"}, - "output":{"shape":"TerminateAppResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Terminates the stack for the specified application.
" - }, - "UpdateApp":{ - "name":"UpdateApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAppRequest"}, - "output":{"shape":"UpdateAppResponse"}, - "errors":[ - {"shape":"UnauthorizedOperationException"}, - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"InternalError"}, - {"shape":"OperationNotPermittedException"} - ], - "documentation":"Updates the specified application.
" - }, - "UpdateReplicationJob":{ - "name":"UpdateReplicationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateReplicationJobRequest"}, - "output":{"shape":"UpdateReplicationJobResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"MissingRequiredParameterException"}, - {"shape":"OperationNotPermittedException"}, - {"shape":"UnauthorizedOperationException"}, - {"shape":"ServerCannotBeReplicatedException"}, - {"shape":"ReplicationJobNotFoundException"}, - {"shape":"InternalError"}, - {"shape":"TemporarilyUnavailableException"} - ], - "documentation":"Updates the specified settings for the specified replication job.
" - } - }, - "shapes":{ - "AmiId":{"type":"string"}, - "AppDescription":{"type":"string"}, - "AppId":{"type":"string"}, - "AppIdWithValidation":{ - "type":"string", - "pattern":"^app-[0-9a-f]{17}$" - }, - "AppIds":{ - "type":"list", - "member":{"shape":"AppId"} - }, - "AppLaunchConfigurationStatus":{ - "type":"string", - "enum":[ - "NOT_CONFIGURED", - "CONFIGURED" - ] - }, - "AppLaunchStatus":{ - "type":"string", - "enum":[ - "READY_FOR_CONFIGURATION", - "CONFIGURATION_IN_PROGRESS", - "CONFIGURATION_INVALID", - "READY_FOR_LAUNCH", - "VALIDATION_IN_PROGRESS", - "LAUNCH_PENDING", - "LAUNCH_IN_PROGRESS", - "LAUNCHED", - "PARTIALLY_LAUNCHED", - "DELTA_LAUNCH_IN_PROGRESS", - "DELTA_LAUNCH_FAILED", - "LAUNCH_FAILED", - "TERMINATE_IN_PROGRESS", - "TERMINATE_FAILED", - "TERMINATED" - ] - }, - "AppLaunchStatusMessage":{"type":"string"}, - "AppName":{"type":"string"}, - "AppReplicationConfigurationStatus":{ - "type":"string", - "enum":[ - "NOT_CONFIGURED", - "CONFIGURED" - ] - }, - "AppReplicationStatus":{ - "type":"string", - "enum":[ - "READY_FOR_CONFIGURATION", - "CONFIGURATION_IN_PROGRESS", - "CONFIGURATION_INVALID", - "READY_FOR_REPLICATION", - "VALIDATION_IN_PROGRESS", - "REPLICATION_PENDING", - "REPLICATION_IN_PROGRESS", - "REPLICATED", - "PARTIALLY_REPLICATED", - "DELTA_REPLICATION_IN_PROGRESS", - "DELTA_REPLICATED", - "DELTA_REPLICATION_FAILED", - "REPLICATION_FAILED", - "REPLICATION_STOPPING", - "REPLICATION_STOP_FAILED", - "REPLICATION_STOPPED" - ] - }, - "AppReplicationStatusMessage":{"type":"string"}, - "AppStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING", - "DELETED", - "DELETE_FAILED" - ] - }, - "AppStatusMessage":{"type":"string"}, - "AppSummary":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The unique ID of the application.
" - }, - "importedAppId":{ - "shape":"ImportedAppId", - "documentation":"The ID of the application.
" - }, - "name":{ - "shape":"AppName", - "documentation":"The name of the application.
" - }, - "description":{ - "shape":"AppDescription", - "documentation":"The description of the application.
" - }, - "status":{ - "shape":"AppStatus", - "documentation":"Status of the application.
" - }, - "statusMessage":{ - "shape":"AppStatusMessage", - "documentation":"A message related to the status of the application
" - }, - "replicationConfigurationStatus":{ - "shape":"AppReplicationConfigurationStatus", - "documentation":"Status of the replication configuration.
" - }, - "replicationStatus":{ - "shape":"AppReplicationStatus", - "documentation":"The replication status of the application.
" - }, - "replicationStatusMessage":{ - "shape":"AppReplicationStatusMessage", - "documentation":"A message related to the replication status of the application.
" - }, - "latestReplicationTime":{ - "shape":"Timestamp", - "documentation":"The timestamp of the application's most recent successful replication.
" - }, - "launchConfigurationStatus":{ - "shape":"AppLaunchConfigurationStatus", - "documentation":"Status of the launch configuration.
" - }, - "launchStatus":{ - "shape":"AppLaunchStatus", - "documentation":"The launch status of the application.
" - }, - "launchStatusMessage":{ - "shape":"AppLaunchStatusMessage", - "documentation":"A message related to the launch status of the application.
" - }, - "launchDetails":{ - "shape":"LaunchDetails", - "documentation":"Details about the latest launch of the application.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The creation time of the application.
" - }, - "lastModified":{ - "shape":"Timestamp", - "documentation":"The last modified time of the application.
" - }, - "roleName":{ - "shape":"RoleName", - "documentation":"The name of the service role in the customer's account used by Server Migration Service.
" - }, - "totalServerGroups":{ - "shape":"TotalServerGroups", - "documentation":"The number of server groups present in the application.
" - }, - "totalServers":{ - "shape":"TotalServers", - "documentation":"The number of servers present in the application.
" - } - }, - "documentation":"Information about the application.
" - }, - "AppValidationConfiguration":{ - "type":"structure", - "members":{ - "validationId":{ - "shape":"ValidationId", - "documentation":"The ID of the validation.
" - }, - "name":{ - "shape":"NonEmptyStringWithMaxLen255", - "documentation":"The name of the configuration.
" - }, - "appValidationStrategy":{ - "shape":"AppValidationStrategy", - "documentation":"The validation strategy.
" - }, - "ssmValidationParameters":{ - "shape":"SSMValidationParameters", - "documentation":"The validation parameters.
" - } - }, - "documentation":"Configuration for validating an application.
" - }, - "AppValidationConfigurations":{ - "type":"list", - "member":{"shape":"AppValidationConfiguration"} - }, - "AppValidationOutput":{ - "type":"structure", - "members":{ - "ssmOutput":{ - "shape":"SSMOutput", - "documentation":"Output from using SSM to validate the application.
" - } - }, - "documentation":"Output from validating an application.
" - }, - "AppValidationStrategy":{ - "type":"string", - "enum":["SSM"] - }, - "Apps":{ - "type":"list", - "member":{"shape":"AppSummary"} - }, - "AssociatePublicIpAddress":{"type":"boolean"}, - "AutoLaunch":{"type":"boolean"}, - "BucketName":{"type":"string"}, - "ClientToken":{"type":"string"}, - "Command":{ - "type":"string", - "max":64000, - "min":1 - }, - "Connector":{ - "type":"structure", - "members":{ - "connectorId":{ - "shape":"ConnectorId", - "documentation":"The ID of the connector.
" - }, - "version":{ - "shape":"ConnectorVersion", - "documentation":"The connector version.
" - }, - "status":{ - "shape":"ConnectorStatus", - "documentation":"The status of the connector.
" - }, - "capabilityList":{ - "shape":"ConnectorCapabilityList", - "documentation":"The capabilities of the connector.
" - }, - "vmManagerName":{ - "shape":"VmManagerName", - "documentation":"The name of the VM manager.
" - }, - "vmManagerType":{ - "shape":"VmManagerType", - "documentation":"The VM management product.
" - }, - "vmManagerId":{ - "shape":"VmManagerId", - "documentation":"The ID of the VM manager.
" - }, - "ipAddress":{ - "shape":"IpAddress", - "documentation":"The IP address of the connector.
" - }, - "macAddress":{ - "shape":"MacAddress", - "documentation":"The MAC address of the connector.
" - }, - "associatedOn":{ - "shape":"Timestamp", - "documentation":"The time the connector was associated.
" - } - }, - "documentation":"Represents a connector.
" - }, - "ConnectorCapability":{ - "type":"string", - "enum":[ - "VSPHERE", - "SCVMM", - "HYPERV-MANAGER", - "SNAPSHOT_BATCHING", - "SMS_OPTIMIZED" - ] - }, - "ConnectorCapabilityList":{ - "type":"list", - "member":{"shape":"ConnectorCapability"} - }, - "ConnectorId":{"type":"string"}, - "ConnectorList":{ - "type":"list", - "member":{"shape":"Connector"} - }, - "ConnectorStatus":{ - "type":"string", - "enum":[ - "HEALTHY", - "UNHEALTHY" - ] - }, - "ConnectorVersion":{"type":"string"}, - "CreateAppRequest":{ - "type":"structure", - "members":{ - "name":{ - "shape":"AppName", - "documentation":"The name of the new application.
" - }, - "description":{ - "shape":"AppDescription", - "documentation":"The description of the new application
" - }, - "roleName":{ - "shape":"RoleName", - "documentation":"The name of the service role in the customer's account to be used by Server Migration Service.
" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of application creation.
" - }, - "serverGroups":{ - "shape":"ServerGroups", - "documentation":"The server groups to include in the application.
" - }, - "tags":{ - "shape":"Tags", - "documentation":"The tags to be associated with the application.
" - } - } - }, - "CreateAppResponse":{ - "type":"structure", - "members":{ - "appSummary":{ - "shape":"AppSummary", - "documentation":"A summary description of the application.
" - }, - "serverGroups":{ - "shape":"ServerGroups", - "documentation":"The server groups included in the application.
" - }, - "tags":{ - "shape":"Tags", - "documentation":"The tags associated with the application.
" - } - } - }, - "CreateReplicationJobRequest":{ - "type":"structure", - "required":[ - "serverId", - "seedReplicationTime" - ], - "members":{ - "serverId":{ - "shape":"ServerId", - "documentation":"The ID of the server.
" - }, - "seedReplicationTime":{ - "shape":"Timestamp", - "documentation":"The seed replication time.
" - }, - "frequency":{ - "shape":"Frequency", - "documentation":"The time between consecutive replication runs, in hours.
" - }, - "runOnce":{ - "shape":"RunOnce", - "documentation":"Indicates whether to run the replication job one time.
" - }, - "licenseType":{ - "shape":"LicenseType", - "documentation":"The license type to be used for the AMI created by a successful replication run.
" - }, - "roleName":{ - "shape":"RoleName", - "documentation":"The name of the IAM role to be used by the Server Migration Service.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the replication job.
" - }, - "numberOfRecentAmisToKeep":{ - "shape":"NumberOfRecentAmisToKeep", - "documentation":"The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.
" - }, - "encrypted":{ - "shape":"Encrypted", - "documentation":"Indicates whether the replication job produces encrypted AMIs.
" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:
KMS key ID
KMS key alias
ARN referring to the KMS key ID
ARN referring to the KMS key alias
If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.
" - } - } - }, - "CreateReplicationJobResponse":{ - "type":"structure", - "members":{ - "replicationJobId":{ - "shape":"ReplicationJobId", - "documentation":"The unique identifier of the replication job.
" - } - } - }, - "DeleteAppLaunchConfigurationRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - } - } - }, - "DeleteAppLaunchConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteAppReplicationConfigurationRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - } - } - }, - "DeleteAppReplicationConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteAppRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - }, - "forceStopAppReplication":{ - "shape":"ForceStopAppReplication", - "documentation":"Indicates whether to stop all replication jobs corresponding to the servers in the application while deleting the application.
" - }, - "forceTerminateApp":{ - "shape":"ForceTerminateApp", - "documentation":"Indicates whether to terminate the stack corresponding to the application while deleting the application.
" - } - } - }, - "DeleteAppResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteAppValidationConfigurationRequest":{ - "type":"structure", - "required":["appId"], - "members":{ - "appId":{ - "shape":"AppIdWithValidation", - "documentation":"The ID of the application.
" - } - } - }, - "DeleteAppValidationConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteReplicationJobRequest":{ - "type":"structure", - "required":["replicationJobId"], - "members":{ - "replicationJobId":{ - "shape":"ReplicationJobId", - "documentation":"The ID of the replication job.
" - } - } - }, - "DeleteReplicationJobResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteServerCatalogRequest":{ - "type":"structure", - "members":{ - } - }, - "DeleteServerCatalogResponse":{ - "type":"structure", - "members":{ - } - }, - "Description":{"type":"string"}, - "DisassociateConnectorRequest":{ - "type":"structure", - "required":["connectorId"], - "members":{ - "connectorId":{ - "shape":"ConnectorId", - "documentation":"The ID of the connector.
" - } - } - }, - "DisassociateConnectorResponse":{ - "type":"structure", - "members":{ - } - }, - "DryRunOperationException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"The user has the required permissions, so the request would have succeeded, but a dry run was performed.
", - "exception":true - }, - "EC2KeyName":{"type":"string"}, - "Encrypted":{"type":"boolean"}, - "ErrorMessage":{"type":"string"}, - "ExecutionTimeoutSeconds":{ - "type":"integer", - "max":28800, - "min":60 - }, - "ForceStopAppReplication":{"type":"boolean"}, - "ForceTerminateApp":{"type":"boolean"}, - "Frequency":{"type":"integer"}, - "GenerateChangeSetRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application associated with the change set.
" - }, - "changesetFormat":{ - "shape":"OutputFormat", - "documentation":"The format for the change set.
" - } - } - }, - "GenerateChangeSetResponse":{ - "type":"structure", - "members":{ - "s3Location":{ - "shape":"S3Location", - "documentation":"The location of the Amazon S3 object.
" - } - } - }, - "GenerateTemplateRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application associated with the CloudFormation template.
" - }, - "templateFormat":{ - "shape":"OutputFormat", - "documentation":"The format for generating the CloudFormation template.
" - } - } - }, - "GenerateTemplateResponse":{ - "type":"structure", - "members":{ - "s3Location":{ - "shape":"S3Location", - "documentation":"The location of the Amazon S3 object.
" - } - } - }, - "GetAppLaunchConfigurationRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - } - } - }, - "GetAppLaunchConfigurationResponse":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - }, - "roleName":{ - "shape":"RoleName", - "documentation":"The name of the service role in the customer's account that CloudFormation uses to launch the application.
" - }, - "autoLaunch":{ - "shape":"AutoLaunch", - "documentation":"Indicates whether the application is configured to launch automatically after replication is complete.
" - }, - "serverGroupLaunchConfigurations":{ - "shape":"ServerGroupLaunchConfigurations", - "documentation":"The launch configurations for server groups in this application.
" - } - } - }, - "GetAppReplicationConfigurationRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - } - } - }, - "GetAppReplicationConfigurationResponse":{ - "type":"structure", - "members":{ - "serverGroupReplicationConfigurations":{ - "shape":"ServerGroupReplicationConfigurations", - "documentation":"The replication configurations associated with server groups in this application.
" - } - } - }, - "GetAppRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - } - } - }, - "GetAppResponse":{ - "type":"structure", - "members":{ - "appSummary":{ - "shape":"AppSummary", - "documentation":"Information about the application.
" - }, - "serverGroups":{ - "shape":"ServerGroups", - "documentation":"The server groups that belong to the application.
" - }, - "tags":{ - "shape":"Tags", - "documentation":"The tags associated with the application.
" - } - } - }, - "GetAppValidationConfigurationRequest":{ - "type":"structure", - "required":["appId"], - "members":{ - "appId":{ - "shape":"AppIdWithValidation", - "documentation":"The ID of the application.
" - } - } - }, - "GetAppValidationConfigurationResponse":{ - "type":"structure", - "members":{ - "appValidationConfigurations":{ - "shape":"AppValidationConfigurations", - "documentation":"The configuration for application validation.
" - }, - "serverGroupValidationConfigurations":{ - "shape":"ServerGroupValidationConfigurations", - "documentation":"The configuration for instance validation.
" - } - } - }, - "GetAppValidationOutputRequest":{ - "type":"structure", - "required":["appId"], - "members":{ - "appId":{ - "shape":"AppIdWithValidation", - "documentation":"The ID of the application.
" - } - } - }, - "GetAppValidationOutputResponse":{ - "type":"structure", - "members":{ - "validationOutputList":{ - "shape":"ValidationOutputList", - "documentation":"The validation output.
" - } - } - }, - "GetConnectorsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"The token for the next set of results.
" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken
value.
Information about the registered connectors.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token required to retrieve the next set of results. This value is null when there are no more results to return.
" - } - } - }, - "GetReplicationJobsRequest":{ - "type":"structure", - "members":{ - "replicationJobId":{ - "shape":"ReplicationJobId", - "documentation":"The ID of the replication job.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token for the next set of results.
" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken
value.
Information about the replication jobs.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token required to retrieve the next set of results. This value is null when there are no more results to return.
" - } - } - }, - "GetReplicationRunsRequest":{ - "type":"structure", - "required":["replicationJobId"], - "members":{ - "replicationJobId":{ - "shape":"ReplicationJobId", - "documentation":"The ID of the replication job.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token for the next set of results.
" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken
value.
Information about the replication job.
" - }, - "replicationRunList":{ - "shape":"ReplicationRunList", - "documentation":"Information about the replication runs.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token required to retrieve the next set of results. This value is null when there are no more results to return.
" - } - } - }, - "GetServersRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"The token for the next set of results.
" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken
value.
The server addresses.
" - } - } - }, - "GetServersResponse":{ - "type":"structure", - "members":{ - "lastModifiedOn":{ - "shape":"Timestamp", - "documentation":"The time when the server was last modified.
" - }, - "serverCatalogStatus":{ - "shape":"ServerCatalogStatus", - "documentation":"The status of the server catalog.
" - }, - "serverList":{ - "shape":"ServerList", - "documentation":"Information about the servers.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token required to retrieve the next set of results. This value is null when there are no more results to return.
" - } - } - }, - "ImportAppCatalogRequest":{ - "type":"structure", - "members":{ - "roleName":{ - "shape":"RoleName", - "documentation":"The name of the service role. If you omit this parameter, we create a service-linked role for Migration Hub in your account. Otherwise, the role that you provide must have the policy and trust policy described in the Migration Hub User Guide.
" - } - } - }, - "ImportAppCatalogResponse":{ - "type":"structure", - "members":{ - } - }, - "ImportServerCatalogRequest":{ - "type":"structure", - "members":{ - } - }, - "ImportServerCatalogResponse":{ - "type":"structure", - "members":{ - } - }, - "ImportedAppId":{"type":"string"}, - "InstanceId":{ - "type":"string", - "pattern":"(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)" - }, - "InstanceType":{"type":"string"}, - "InternalError":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"An internal error occurred.
", - "exception":true, - "fault":true - }, - "InvalidParameterException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"A specified parameter is not valid.
", - "exception":true - }, - "IpAddress":{"type":"string"}, - "KmsKeyId":{"type":"string"}, - "LaunchAppRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - } - } - }, - "LaunchAppResponse":{ - "type":"structure", - "members":{ - } - }, - "LaunchDetails":{ - "type":"structure", - "members":{ - "latestLaunchTime":{ - "shape":"Timestamp", - "documentation":"The latest time that this application was launched successfully.
" - }, - "stackName":{ - "shape":"StackName", - "documentation":"The name of the latest stack launched for this application.
" - }, - "stackId":{ - "shape":"StackId", - "documentation":"The ID of the latest stack launched for this application.
" - } - }, - "documentation":"Details about the latest launch of an application.
" - }, - "LaunchOrder":{"type":"integer"}, - "LicenseType":{ - "type":"string", - "enum":[ - "AWS", - "BYOL" - ] - }, - "ListAppsRequest":{ - "type":"structure", - "members":{ - "appIds":{ - "shape":"AppIds", - "documentation":"The unique application IDs.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token for the next set of results.
" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return in a single call. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken
value.
The application summaries.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token required to retrieve the next set of results. This value is null when there are no more results to return.
" - } - } - }, - "LogicalId":{"type":"string"}, - "MacAddress":{"type":"string"}, - "MaxResults":{"type":"integer"}, - "MissingRequiredParameterException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"A required parameter is missing.
", - "exception":true - }, - "NextToken":{"type":"string"}, - "NoConnectorsAvailableException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"There are no connectors available.
", - "exception":true - }, - "NonEmptyStringWithMaxLen255":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[\\S]+$" - }, - "NotificationContext":{ - "type":"structure", - "members":{ - "validationId":{ - "shape":"ValidationId", - "documentation":"The ID of the validation.
" - }, - "status":{ - "shape":"ValidationStatus", - "documentation":"The status of the validation.
" - }, - "statusMessage":{ - "shape":"ValidationStatusMessage", - "documentation":"The status message.
" - } - }, - "documentation":"Contains the status of validating an application.
" - }, - "NotifyAppValidationOutputRequest":{ - "type":"structure", - "required":["appId"], - "members":{ - "appId":{ - "shape":"AppIdWithValidation", - "documentation":"The ID of the application.
" - }, - "notificationContext":{ - "shape":"NotificationContext", - "documentation":"The notification information.
" - } - } - }, - "NotifyAppValidationOutputResponse":{ - "type":"structure", - "members":{ - } - }, - "NumberOfRecentAmisToKeep":{"type":"integer"}, - "OperationNotPermittedException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"This operation is not allowed.
", - "exception":true - }, - "OutputFormat":{ - "type":"string", - "enum":[ - "JSON", - "YAML" - ] - }, - "PutAppLaunchConfigurationRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - }, - "roleName":{ - "shape":"RoleName", - "documentation":"The name of service role in the customer's account that CloudFormation uses to launch the application.
" - }, - "autoLaunch":{ - "shape":"AutoLaunch", - "documentation":"Indicates whether the application is configured to launch automatically after replication is complete.
" - }, - "serverGroupLaunchConfigurations":{ - "shape":"ServerGroupLaunchConfigurations", - "documentation":"Information about the launch configurations for server groups in the application.
" - } - } - }, - "PutAppLaunchConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "PutAppReplicationConfigurationRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - }, - "serverGroupReplicationConfigurations":{ - "shape":"ServerGroupReplicationConfigurations", - "documentation":"Information about the replication configurations for server groups in the application.
" - } - } - }, - "PutAppReplicationConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "PutAppValidationConfigurationRequest":{ - "type":"structure", - "required":["appId"], - "members":{ - "appId":{ - "shape":"AppIdWithValidation", - "documentation":"The ID of the application.
" - }, - "appValidationConfigurations":{ - "shape":"AppValidationConfigurations", - "documentation":"The configuration for application validation.
" - }, - "serverGroupValidationConfigurations":{ - "shape":"ServerGroupValidationConfigurations", - "documentation":"The configuration for instance validation.
" - } - } - }, - "PutAppValidationConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "ReplicationJob":{ - "type":"structure", - "members":{ - "replicationJobId":{ - "shape":"ReplicationJobId", - "documentation":"The ID of the replication job.
" - }, - "serverId":{ - "shape":"ServerId", - "documentation":"The ID of the server.
" - }, - "serverType":{ - "shape":"ServerType", - "documentation":"The type of server.
" - }, - "vmServer":{ - "shape":"VmServer", - "documentation":"Information about the VM server.
" - }, - "seedReplicationTime":{ - "shape":"Timestamp", - "documentation":"The seed replication time.
" - }, - "frequency":{ - "shape":"Frequency", - "documentation":"The time between consecutive replication runs, in hours.
" - }, - "runOnce":{ - "shape":"RunOnce", - "documentation":"Indicates whether to run the replication job one time.
" - }, - "nextReplicationRunStartTime":{ - "shape":"Timestamp", - "documentation":"The start time of the next replication run.
" - }, - "licenseType":{ - "shape":"LicenseType", - "documentation":"The license type to be used for the AMI created by a successful replication run.
" - }, - "roleName":{ - "shape":"RoleName", - "documentation":"The name of the IAM role to be used by Server Migration Service.
" - }, - "latestAmiId":{ - "shape":"AmiId", - "documentation":"The ID of the latest Amazon Machine Image (AMI).
" - }, - "state":{ - "shape":"ReplicationJobState", - "documentation":"The state of the replication job.
" - }, - "statusMessage":{ - "shape":"ReplicationJobStatusMessage", - "documentation":"The description of the current status of the replication job.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the replication job.
" - }, - "numberOfRecentAmisToKeep":{ - "shape":"NumberOfRecentAmisToKeep", - "documentation":"The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.
" - }, - "encrypted":{ - "shape":"Encrypted", - "documentation":"Indicates whether the replication job should produce encrypted AMIs.
" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:
KMS key ID
KMS key alias
ARN referring to the KMS key ID
ARN referring to the KMS key alias
If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.
" - }, - "replicationRunList":{ - "shape":"ReplicationRunList", - "documentation":"Information about the replication runs.
" - } - }, - "documentation":"Represents a replication job.
" - }, - "ReplicationJobAlreadyExistsException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"The specified replication job already exists.
", - "exception":true - }, - "ReplicationJobId":{"type":"string"}, - "ReplicationJobList":{ - "type":"list", - "member":{"shape":"ReplicationJob"} - }, - "ReplicationJobNotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"The specified replication job does not exist.
", - "exception":true - }, - "ReplicationJobState":{ - "type":"string", - "enum":[ - "PENDING", - "ACTIVE", - "FAILED", - "DELETING", - "DELETED", - "COMPLETED", - "PAUSED_ON_FAILURE", - "FAILING" - ] - }, - "ReplicationJobStatusMessage":{"type":"string"}, - "ReplicationJobTerminated":{"type":"boolean"}, - "ReplicationRun":{ - "type":"structure", - "members":{ - "replicationRunId":{ - "shape":"ReplicationRunId", - "documentation":"The ID of the replication run.
" - }, - "state":{ - "shape":"ReplicationRunState", - "documentation":"The state of the replication run.
" - }, - "type":{ - "shape":"ReplicationRunType", - "documentation":"The type of replication run.
" - }, - "stageDetails":{ - "shape":"ReplicationRunStageDetails", - "documentation":"Details about the current stage of the replication run.
" - }, - "statusMessage":{ - "shape":"ReplicationRunStatusMessage", - "documentation":"The description of the current status of the replication job.
" - }, - "amiId":{ - "shape":"AmiId", - "documentation":"The ID of the Amazon Machine Image (AMI) from the replication run.
" - }, - "scheduledStartTime":{ - "shape":"Timestamp", - "documentation":"The start time of the next replication run.
" - }, - "completedTime":{ - "shape":"Timestamp", - "documentation":"The completion time of the last replication run.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the replication run.
" - }, - "encrypted":{ - "shape":"Encrypted", - "documentation":"Indicates whether the replication run should produce an encrypted AMI.
" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:
KMS key ID
KMS key alias
ARN referring to the KMS key ID
ARN referring to the KMS key alias
If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.
" - } - }, - "documentation":"Represents a replication run.
" - }, - "ReplicationRunId":{"type":"string"}, - "ReplicationRunLimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"You have exceeded the number of on-demand replication runs you can request in a 24-hour period.
", - "exception":true - }, - "ReplicationRunList":{ - "type":"list", - "member":{"shape":"ReplicationRun"} - }, - "ReplicationRunStage":{"type":"string"}, - "ReplicationRunStageDetails":{ - "type":"structure", - "members":{ - "stage":{ - "shape":"ReplicationRunStage", - "documentation":"The current stage of a replication run.
" - }, - "stageProgress":{ - "shape":"ReplicationRunStageProgress", - "documentation":"The progress of the current stage of a replication run.
" - } - }, - "documentation":"Details of the current stage of a replication run.
" - }, - "ReplicationRunStageProgress":{"type":"string"}, - "ReplicationRunState":{ - "type":"string", - "enum":[ - "PENDING", - "MISSED", - "ACTIVE", - "FAILED", - "COMPLETED", - "DELETING", - "DELETED" - ] - }, - "ReplicationRunStatusMessage":{"type":"string"}, - "ReplicationRunType":{ - "type":"string", - "enum":[ - "ON_DEMAND", - "AUTOMATIC" - ] - }, - "RoleName":{"type":"string"}, - "RunOnce":{"type":"boolean"}, - "S3BucketName":{ - "type":"string", - "max":63, - "min":3 - }, - "S3KeyName":{ - "type":"string", - "max":1024 - }, - "S3Location":{ - "type":"structure", - "members":{ - "bucket":{ - "shape":"S3BucketName", - "documentation":"The Amazon S3 bucket name.
" - }, - "key":{ - "shape":"S3KeyName", - "documentation":"The Amazon S3 bucket key.
" - } - }, - "documentation":"Location of an Amazon S3 object.
" - }, - "SSMOutput":{ - "type":"structure", - "members":{ - "s3Location":{"shape":"S3Location"} - }, - "documentation":"Contains the location of validation output.
" - }, - "SSMValidationParameters":{ - "type":"structure", - "members":{ - "source":{ - "shape":"Source", - "documentation":"The location of the validation script.
" - }, - "instanceId":{ - "shape":"InstanceId", - "documentation":"The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.
" - }, - "scriptType":{ - "shape":"ScriptType", - "documentation":"The type of validation script.
" - }, - "command":{ - "shape":"Command", - "documentation":"The command to run the validation script.
" - }, - "executionTimeoutSeconds":{ - "shape":"ExecutionTimeoutSeconds", - "documentation":"The timeout interval, in seconds.
" - }, - "outputS3BucketName":{ - "shape":"BucketName", - "documentation":"The name of the S3 bucket for output.
" - } - }, - "documentation":"Contains validation parameters.
" - }, - "ScriptType":{ - "type":"string", - "enum":[ - "SHELL_SCRIPT", - "POWERSHELL_SCRIPT" - ] - }, - "SecurityGroup":{"type":"string"}, - "Server":{ - "type":"structure", - "members":{ - "serverId":{ - "shape":"ServerId", - "documentation":"The ID of the server.
" - }, - "serverType":{ - "shape":"ServerType", - "documentation":"The type of server.
" - }, - "vmServer":{ - "shape":"VmServer", - "documentation":"Information about the VM server.
" - }, - "replicationJobId":{ - "shape":"ReplicationJobId", - "documentation":"The ID of the replication job.
" - }, - "replicationJobTerminated":{ - "shape":"ReplicationJobTerminated", - "documentation":"Indicates whether the replication job is deleted or failed.
" - } - }, - "documentation":"Represents a server.
" - }, - "ServerCannotBeReplicatedException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"The specified server cannot be replicated.
", - "exception":true - }, - "ServerCatalogStatus":{ - "type":"string", - "enum":[ - "NOT_IMPORTED", - "IMPORTING", - "AVAILABLE", - "DELETED", - "EXPIRED" - ] - }, - "ServerGroup":{ - "type":"structure", - "members":{ - "serverGroupId":{ - "shape":"ServerGroupId", - "documentation":"The ID of a server group.
" - }, - "name":{ - "shape":"ServerGroupName", - "documentation":"The name of a server group.
" - }, - "serverList":{ - "shape":"ServerList", - "documentation":"The servers that belong to a server group.
" - } - }, - "documentation":"Logical grouping of servers.
" - }, - "ServerGroupId":{"type":"string"}, - "ServerGroupLaunchConfiguration":{ - "type":"structure", - "members":{ - "serverGroupId":{ - "shape":"ServerGroupId", - "documentation":"The ID of the server group with which the launch configuration is associated.
" - }, - "launchOrder":{ - "shape":"LaunchOrder", - "documentation":"The launch order of servers in the server group.
" - }, - "serverLaunchConfigurations":{ - "shape":"ServerLaunchConfigurations", - "documentation":"The launch configuration for servers in the server group.
" - } - }, - "documentation":"Launch configuration for a server group.
" - }, - "ServerGroupLaunchConfigurations":{ - "type":"list", - "member":{"shape":"ServerGroupLaunchConfiguration"} - }, - "ServerGroupName":{"type":"string"}, - "ServerGroupReplicationConfiguration":{ - "type":"structure", - "members":{ - "serverGroupId":{ - "shape":"ServerGroupId", - "documentation":"The ID of the server group with which this replication configuration is associated.
" - }, - "serverReplicationConfigurations":{ - "shape":"ServerReplicationConfigurations", - "documentation":"The replication configuration for servers in the server group.
" - } - }, - "documentation":"Replication configuration for a server group.
" - }, - "ServerGroupReplicationConfigurations":{ - "type":"list", - "member":{"shape":"ServerGroupReplicationConfiguration"} - }, - "ServerGroupValidationConfiguration":{ - "type":"structure", - "members":{ - "serverGroupId":{ - "shape":"ServerGroupId", - "documentation":"The ID of the server group.
" - }, - "serverValidationConfigurations":{ - "shape":"ServerValidationConfigurations", - "documentation":"The validation configuration.
" - } - }, - "documentation":"Configuration for validating an instance.
" - }, - "ServerGroupValidationConfigurations":{ - "type":"list", - "member":{"shape":"ServerGroupValidationConfiguration"} - }, - "ServerGroups":{ - "type":"list", - "member":{"shape":"ServerGroup"} - }, - "ServerId":{"type":"string"}, - "ServerLaunchConfiguration":{ - "type":"structure", - "members":{ - "server":{ - "shape":"Server", - "documentation":"The ID of the server with which the launch configuration is associated.
" - }, - "logicalId":{ - "shape":"LogicalId", - "documentation":"The logical ID of the server in the CloudFormation template.
" - }, - "vpc":{ - "shape":"VPC", - "documentation":"The ID of the VPC into which the server should be launched.
" - }, - "subnet":{ - "shape":"Subnet", - "documentation":"The ID of the subnet the server should be launched into.
" - }, - "securityGroup":{ - "shape":"SecurityGroup", - "documentation":"The ID of the security group that applies to the launched server.
" - }, - "ec2KeyName":{ - "shape":"EC2KeyName", - "documentation":"The name of the Amazon EC2 SSH key to be used for connecting to the launched server.
" - }, - "userData":{ - "shape":"UserData", - "documentation":"Location of the user-data script to be executed when launching the server.
" - }, - "instanceType":{ - "shape":"InstanceType", - "documentation":"The instance type to use when launching the server.
" - }, - "associatePublicIpAddress":{ - "shape":"AssociatePublicIpAddress", - "documentation":"Indicates whether a publicly accessible IP address is created when launching the server.
" - }, - "iamInstanceProfileName":{ - "shape":"RoleName", - "documentation":"The name of the IAM instance profile.
" - }, - "configureScript":{"shape":"S3Location"}, - "configureScriptType":{ - "shape":"ScriptType", - "documentation":"The type of configuration script.
" - } - }, - "documentation":"Launch configuration for a server.
" - }, - "ServerLaunchConfigurations":{ - "type":"list", - "member":{"shape":"ServerLaunchConfiguration"} - }, - "ServerList":{ - "type":"list", - "member":{"shape":"Server"} - }, - "ServerReplicationConfiguration":{ - "type":"structure", - "members":{ - "server":{ - "shape":"Server", - "documentation":"The ID of the server with which this replication configuration is associated.
" - }, - "serverReplicationParameters":{ - "shape":"ServerReplicationParameters", - "documentation":"The parameters for replicating the server.
" - } - }, - "documentation":"Replication configuration of a server.
" - }, - "ServerReplicationConfigurations":{ - "type":"list", - "member":{"shape":"ServerReplicationConfiguration"} - }, - "ServerReplicationParameters":{ - "type":"structure", - "members":{ - "seedTime":{ - "shape":"Timestamp", - "documentation":"The seed time for creating a replication job for the server.
" - }, - "frequency":{ - "shape":"Frequency", - "documentation":"The frequency of creating replication jobs for the server.
" - }, - "runOnce":{ - "shape":"RunOnce", - "documentation":"Indicates whether to run the replication job one time.
" - }, - "licenseType":{ - "shape":"LicenseType", - "documentation":"The license type for creating a replication job for the server.
" - }, - "numberOfRecentAmisToKeep":{ - "shape":"NumberOfRecentAmisToKeep", - "documentation":"The number of recent AMIs to keep when creating a replication job for this server.
" - }, - "encrypted":{ - "shape":"Encrypted", - "documentation":"Indicates whether the replication job produces encrypted AMIs.
" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:
KMS key ID
KMS key alias
ARN referring to the KMS key ID
ARN referring to the KMS key alias
If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.
" - } - }, - "documentation":"The replication parameters for replicating a server.
" - }, - "ServerType":{ - "type":"string", - "enum":["VIRTUAL_MACHINE"] - }, - "ServerValidationConfiguration":{ - "type":"structure", - "members":{ - "server":{"shape":"Server"}, - "validationId":{ - "shape":"ValidationId", - "documentation":"The ID of the validation.
" - }, - "name":{ - "shape":"NonEmptyStringWithMaxLen255", - "documentation":"The name of the configuration.
" - }, - "serverValidationStrategy":{ - "shape":"ServerValidationStrategy", - "documentation":"The validation strategy.
" - }, - "userDataValidationParameters":{ - "shape":"UserDataValidationParameters", - "documentation":"The validation parameters.
" - } - }, - "documentation":"Configuration for validating an instance.
" - }, - "ServerValidationConfigurations":{ - "type":"list", - "member":{"shape":"ServerValidationConfiguration"} - }, - "ServerValidationOutput":{ - "type":"structure", - "members":{ - "server":{"shape":"Server"} - }, - "documentation":"Contains output from validating an instance.
" - }, - "ServerValidationStrategy":{ - "type":"string", - "enum":["USERDATA"] - }, - "Source":{ - "type":"structure", - "members":{ - "s3Location":{"shape":"S3Location"} - }, - "documentation":"Contains the location of a validation script.
" - }, - "StackId":{"type":"string"}, - "StackName":{"type":"string"}, - "StartAppReplicationRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - } - } - }, - "StartAppReplicationResponse":{ - "type":"structure", - "members":{ - } - }, - "StartOnDemandAppReplicationRequest":{ - "type":"structure", - "required":["appId"], - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the replication run.
" - } - } - }, - "StartOnDemandAppReplicationResponse":{ - "type":"structure", - "members":{ - } - }, - "StartOnDemandReplicationRunRequest":{ - "type":"structure", - "required":["replicationJobId"], - "members":{ - "replicationJobId":{ - "shape":"ReplicationJobId", - "documentation":"The ID of the replication job.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the replication run.
" - } - } - }, - "StartOnDemandReplicationRunResponse":{ - "type":"structure", - "members":{ - "replicationRunId":{ - "shape":"ReplicationRunId", - "documentation":"The ID of the replication run.
" - } - } - }, - "StopAppReplicationRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - } - } - }, - "StopAppReplicationResponse":{ - "type":"structure", - "members":{ - } - }, - "Subnet":{"type":"string"}, - "Tag":{ - "type":"structure", - "members":{ - "key":{ - "shape":"TagKey", - "documentation":"The tag key.
" - }, - "value":{ - "shape":"TagValue", - "documentation":"The tag value.
" - } - }, - "documentation":"Key/value pair that can be assigned to an application.
" - }, - "TagKey":{"type":"string"}, - "TagValue":{"type":"string"}, - "Tags":{ - "type":"list", - "member":{"shape":"Tag"} - }, - "TemporarilyUnavailableException":{ - "type":"structure", - "members":{ - }, - "documentation":"The service is temporarily unavailable.
", - "exception":true, - "fault":true - }, - "TerminateAppRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - } - } - }, - "TerminateAppResponse":{ - "type":"structure", - "members":{ - } - }, - "Timestamp":{"type":"timestamp"}, - "TotalServerGroups":{"type":"integer"}, - "TotalServers":{"type":"integer"}, - "UnauthorizedOperationException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
", - "exception":true - }, - "UpdateAppRequest":{ - "type":"structure", - "members":{ - "appId":{ - "shape":"AppId", - "documentation":"The ID of the application.
" - }, - "name":{ - "shape":"AppName", - "documentation":"The new name of the application.
" - }, - "description":{ - "shape":"AppDescription", - "documentation":"The new description of the application.
" - }, - "roleName":{ - "shape":"RoleName", - "documentation":"The name of the service role in the customer's account used by Server Migration Service.
" - }, - "serverGroups":{ - "shape":"ServerGroups", - "documentation":"The server groups in the application to update.
" - }, - "tags":{ - "shape":"Tags", - "documentation":"The tags to associate with the application.
" - } - } - }, - "UpdateAppResponse":{ - "type":"structure", - "members":{ - "appSummary":{ - "shape":"AppSummary", - "documentation":"A summary description of the application.
" - }, - "serverGroups":{ - "shape":"ServerGroups", - "documentation":"The updated server groups in the application.
" - }, - "tags":{ - "shape":"Tags", - "documentation":"The tags associated with the application.
" - } - } - }, - "UpdateReplicationJobRequest":{ - "type":"structure", - "required":["replicationJobId"], - "members":{ - "replicationJobId":{ - "shape":"ReplicationJobId", - "documentation":"The ID of the replication job.
" - }, - "frequency":{ - "shape":"Frequency", - "documentation":"The time between consecutive replication runs, in hours.
" - }, - "nextReplicationRunStartTime":{ - "shape":"Timestamp", - "documentation":"The start time of the next replication run.
" - }, - "licenseType":{ - "shape":"LicenseType", - "documentation":"The license type to be used for the AMI created by a successful replication run.
" - }, - "roleName":{ - "shape":"RoleName", - "documentation":"The name of the IAM role to be used by Server Migration Service.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the replication job.
" - }, - "numberOfRecentAmisToKeep":{ - "shape":"NumberOfRecentAmisToKeep", - "documentation":"The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.
" - }, - "encrypted":{ - "shape":"Encrypted", - "documentation":"When true, the replication job produces encrypted AMIs. For more information, KmsKeyId
.
The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:
KMS key ID
KMS key alias
ARN referring to the KMS key ID
ARN referring to the KMS key alias
If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.
" - } - } - }, - "UpdateReplicationJobResponse":{ - "type":"structure", - "members":{ - } - }, - "UserData":{ - "type":"structure", - "members":{ - "s3Location":{ - "shape":"S3Location", - "documentation":"Amazon S3 location of the user-data script.
" - } - }, - "documentation":"A script that runs on first launch of an Amazon EC2 instance. Used for configuring the server during launch.
" - }, - "UserDataValidationParameters":{ - "type":"structure", - "members":{ - "source":{ - "shape":"Source", - "documentation":"The location of the validation script.
" - }, - "scriptType":{ - "shape":"ScriptType", - "documentation":"The type of validation script.
" - } - }, - "documentation":"Contains validation parameters.
" - }, - "VPC":{"type":"string"}, - "ValidationId":{ - "type":"string", - "pattern":"^val-[0-9a-f]{17}$" - }, - "ValidationOutput":{ - "type":"structure", - "members":{ - "validationId":{ - "shape":"ValidationId", - "documentation":"The ID of the validation.
" - }, - "name":{ - "shape":"NonEmptyStringWithMaxLen255", - "documentation":"The name of the validation.
" - }, - "status":{ - "shape":"ValidationStatus", - "documentation":"The status of the validation.
" - }, - "statusMessage":{ - "shape":"ValidationStatusMessage", - "documentation":"The status message.
" - }, - "latestValidationTime":{ - "shape":"Timestamp", - "documentation":"The latest time that the validation was performed.
" - }, - "appValidationOutput":{ - "shape":"AppValidationOutput", - "documentation":"The output from validating an application.
" - }, - "serverValidationOutput":{ - "shape":"ServerValidationOutput", - "documentation":"The output from validation an instance.
" - } - }, - "documentation":"Contains validation output.
" - }, - "ValidationOutputList":{ - "type":"list", - "member":{"shape":"ValidationOutput"} - }, - "ValidationStatus":{ - "type":"string", - "enum":[ - "READY_FOR_VALIDATION", - "PENDING", - "IN_PROGRESS", - "SUCCEEDED", - "FAILED" - ] - }, - "ValidationStatusMessage":{ - "type":"string", - "max":2500 - }, - "VmId":{"type":"string"}, - "VmManagerId":{"type":"string"}, - "VmManagerName":{"type":"string"}, - "VmManagerType":{ - "type":"string", - "enum":[ - "VSPHERE", - "SCVMM", - "HYPERV-MANAGER" - ] - }, - "VmName":{"type":"string"}, - "VmPath":{"type":"string"}, - "VmServer":{ - "type":"structure", - "members":{ - "vmServerAddress":{ - "shape":"VmServerAddress", - "documentation":"The VM server location.
" - }, - "vmName":{ - "shape":"VmName", - "documentation":"The name of the VM.
" - }, - "vmManagerName":{ - "shape":"VmManagerName", - "documentation":"The name of the VM manager.
" - }, - "vmManagerType":{ - "shape":"VmManagerType", - "documentation":"The type of VM management product.
" - }, - "vmPath":{ - "shape":"VmPath", - "documentation":"The VM folder path in the vCenter Server virtual machine inventory tree.
" - } - }, - "documentation":"Represents a VM server.
" - }, - "VmServerAddress":{ - "type":"structure", - "members":{ - "vmManagerId":{ - "shape":"VmManagerId", - "documentation":"The ID of the VM manager.
" - }, - "vmId":{ - "shape":"VmId", - "documentation":"The ID of the VM.
" - } - }, - "documentation":"Represents a VM server location.
" - }, - "VmServerAddressList":{ - "type":"list", - "member":{"shape":"VmServerAddress"} - } - }, - "documentation":"Product update
We recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration service for lift-and-shift migrations. If Amazon Web Services MGN is unavailable in a specific Amazon Web Services Region, you can use the Server Migration Service APIs through March 2023.
Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following resources:
", - "deprecated":true, - "deprecatedMessage":"AWS Server Migration Service is Deprecated." -} diff --git a/services/sms/src/test/resources/cucumber.properties b/services/sms/src/test/resources/cucumber.properties deleted file mode 100644 index 557475c220b1..000000000000 --- a/services/sms/src/test/resources/cucumber.properties +++ /dev/null @@ -1,16 +0,0 @@ -# -# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"). -# You may not use this file except in compliance with the License. -# A copy of the License is located at -# -# http://aws.amazon.com/apache2.0 -# -# or in the "license" file accompanying this file. This file is distributed -# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either -# express or implied. See the License for the specific language governing -# permissions and limitations under the License. -# - -guice.injector-source = software.amazon.awssdk.services.servermigration.smoketests.AWSServerMigrationModuleInjector diff --git a/services/sms/src/test/resources/software/amazon/awssdk/services/servermigration/smoketests/sms.feature b/services/sms/src/test/resources/software/amazon/awssdk/services/servermigration/smoketests/sms.feature deleted file mode 100644 index 5039d6408c64..000000000000 --- a/services/sms/src/test/resources/software/amazon/awssdk/services/servermigration/smoketests/sms.feature +++ /dev/null @@ -1,12 +0,0 @@ -# language: en -@smoke @sms -Feature: AWS Server Migration Service - - Scenario: Making a request - When I call the "GetConnectors" API - Then the request should be successful - - Scenario: Handling errors - When I attempt to call the "DeleteReplicationJob" API with: - | ReplicationJobId | invalidId | - Then I expect the response error code to be "InvalidParameterException" \ No newline at end of file diff --git a/services/snowball/pom.xml b/services/snowball/pom.xml index f55b813b1d61..580655457621 100644 --- a/services/snowball/pom.xml +++ b/services/snowball/pom.xml @@ -21,7 +21,7 @@Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.
You can use SendMessageBatch
to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all). This is a batch version of SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200
.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 1 MiB 1,048,576 bytes.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.
If you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses the default value for the queue.
You can use SendMessageBatch
to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all). This is a batch version of SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200
.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 1 MiB 1,048,576 bytes.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.
If you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses the default value for the queue.
The message to send. The minimum size is one character. The maximum size is 1 MiB or 1,048,576 bytes
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.
The message to send. The minimum size is one character. The maximum size is 1 MiB or 1,048,576 bytes
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
" + "documentation":"A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
The IncludeChildOrganizationUnits
parameter is not supported by State Manager.
The action for Patch Manager to take on patches included in the RejectedPackages
list.
Linux and macOS: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as INSTALLED_OTHER
. This is the default action if no option is specified.
Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER
. Any package not already installed on the node is skipped. This is the default action if no option is specified.
All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED
.
The action for Patch Manager to take on patches included in the RejectedPackages
list.
Linux and macOS: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as INSTALLED_OTHER
. This is the default action if no option is specified.
Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER
. Any package not already installed on the node is skipped. This is the default action if no option is specified.
All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances.
State value assignment for patch compliance:
If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED
.
If an update attempts to install a dependency package that is now rejected by the baseline, when previous versions of the package were not rejected, the package being updated is reported as MISSING
for SCAN
operations and as FAILED
for INSTALL
operations.
Defines the basic information about a patch baseline override.
" + }, + "UseS3DualStackEndpoint":{ + "shape":"Boolean", + "documentation":"Specifies whether to use S3 dualstack endpoints for the patch snapshot download URL. Set to true
to receive a presigned URL that supports both IPv4 and IPv6 connectivity. Set to false
to use standard IPv4-only endpoints. Default is false
. This parameter is required for managed nodes in IPv6-only environments.
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
", + "documentation":"The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently. TargetLocationMaxConcurrency
has a default value of 1.
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
", + "documentation":"The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation. TargetLocationMaxErrors
has a default value of 0.
Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false
.
Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false
.
This parameter is not supported by State Manager.
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
" + "documentation":"A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
The IncludeChildOrganizationUnits
parameter is not supported by State Manager.
The action for Patch Manager to take on patches included in the RejectedPackages
list.
Linux and macOS: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as INSTALLED_OTHER
. This is the default action if no option is specified.
Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER
. Any package not already installed on the node is skipped. This is the default action if no option is specified.
All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED
.
The action for Patch Manager to take on patches included in the RejectedPackages
list.
Linux and macOS: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as INSTALLED_OTHER
. This is the default action if no option is specified.
Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER
. Any package not already installed on the node is skipped. This is the default action if no option is specified.
All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances.
State value assignment for patch compliance:
If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED
.
If an update attempts to install a dependency package that is now rejected by the baseline, when previous versions of the package were not rejected, the package being updated is reported as MISSING
for SCAN
operations and as FAILED
for INSTALL
operations.
The reason for the access denied exception.
" + } }, "documentation":"You do not have sufficient access to perform this action.
", "exception":true }, "AccessDeniedExceptionMessage":{"type":"string"}, + "AccessDeniedExceptionReason":{ + "type":"string", + "enum":["KMS_AccessDeniedException"] + }, "AccountAssignment":{ "type":"structure", "members":{ @@ -2606,6 +2615,14 @@ "Status":{ "shape":"InstanceStatus", "documentation":"The status of the instance.
" + }, + "StatusReason":{ + "shape":"Reason", + "documentation":"Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.
" + }, + "EncryptionConfigurationDetails":{ + "shape":"EncryptionConfigurationDetails", + "documentation":"Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.
" } } }, @@ -2773,6 +2790,43 @@ "min":1, "pattern":"(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?" }, + "EncryptionConfiguration":{ + "type":"structure", + "required":["KeyType"], + "members":{ + "KeyType":{ + "shape":"KmsKeyType", + "documentation":"The type of KMS key used for encryption.
" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The ARN of the KMS key used to encrypt data. Required when KeyType is CUSTOMER_MANAGED_KEY. Cannot be specified when KeyType is AWS_OWNED_KMS_KEY.
" + } + }, + "documentation":"A structure that specifies the KMS key type and KMS key ARN used to encrypt data in your IAM Identity Center instance.
" + }, + "EncryptionConfigurationDetails":{ + "type":"structure", + "members":{ + "KeyType":{ + "shape":"KmsKeyType", + "documentation":"The type of KMS key used for encryption.
" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The ARN of the KMS key currently used to encrypt data in your IAM Identity Center instance.
" + }, + "EncryptionStatus":{ + "shape":"KmsKeyStatus", + "documentation":"The current status of encryption configuration.
" + }, + "EncryptionStatusReason":{ + "shape":"Reason", + "documentation":"Provides additional context about the current encryption status. This field is particularly useful when the encryption status is UPDATE_FAILED. When encryption configuration update fails, this field contains information about the cause, which may include KMS key access issues, key not found errors, invalid key configuration, key in an invalid state, or a disabled key.
" + } + }, + "documentation":"The encryption configuration of your IAM Identity Center instance, including the key type, KMS key ARN, and current encryption status.
" + }, "FederationProtocol":{ "type":"string", "enum":[ @@ -3090,6 +3144,10 @@ "Status":{ "shape":"InstanceStatus", "documentation":"The current status of this Identity Center instance.
" + }, + "StatusReason":{ + "shape":"Reason", + "documentation":"Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance creation fails, this field contains information about the cause, which may include issues with KMS key configuration or insufficient permissions.
" } }, "documentation":"Provides information about the IAM Identity Center instance.
" @@ -3098,6 +3156,7 @@ "type":"string", "enum":[ "CREATE_IN_PROGRESS", + "CREATE_FAILED", "DELETE_IN_PROGRESS", "ACTIVE" ] @@ -3132,6 +3191,27 @@ }, "documentation":"A structure that defines configuration settings for an application that supports the JWT Bearer Token Authorization Grant. The AuthorizedAudience
field is the aud claim. For more information, see RFC 7523.
The reason for the resource not found exception.
" + } }, "documentation":"Indicates that a requested resource is not found.
", "exception":true }, + "ResourceNotFoundExceptionReason":{ + "type":"string", + "enum":["KMS_NotFoundException"] + }, "ResourceNotFoundMessage":{"type":"string"}, "ResourceServerConfig":{ "type":"structure", @@ -4546,12 +4634,20 @@ "ThrottlingException":{ "type":"structure", "members":{ - "Message":{"shape":"ThrottlingExceptionMessage"} + "Message":{"shape":"ThrottlingExceptionMessage"}, + "Reason":{ + "shape":"ThrottlingExceptionReason", + "documentation":"The reason for the throttling exception.
" + } }, "documentation":"Indicates that the principal has crossed the throttling limits of the API operations.
", "exception":true }, "ThrottlingExceptionMessage":{"type":"string"}, + "ThrottlingExceptionReason":{ + "type":"string", + "enum":["KMS_ThrottlingException"] + }, "Token":{ "type":"string", "max":2048, @@ -4732,10 +4828,7 @@ }, "UpdateInstanceRequest":{ "type":"structure", - "required":[ - "Name", - "InstanceArn" - ], + "required":["InstanceArn"], "members":{ "Name":{ "shape":"NameType", @@ -4744,6 +4837,10 @@ "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"Specifies the encryption configuration for your IAM Identity Center instance. You can use this to configure customer managed KMS keys (CMK) or Amazon Web Services owned KMS keys for encrypting your instance data.
" } } }, @@ -4816,12 +4913,24 @@ "ValidationException":{ "type":"structure", "members":{ - "Message":{"shape":"ValidationExceptionMessage"} + "Message":{"shape":"ValidationExceptionMessage"}, + "Reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason for the validation exception.
" + } }, "documentation":"The request failed because it contains a syntax error.
", "exception":true }, - "ValidationExceptionMessage":{"type":"string"} + "ValidationExceptionMessage":{"type":"string"}, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "KMS_InvalidKeyUsageException", + "KMS_InvalidStateException", + "KMS_DisabledException" + ] + } }, "documentation":"IAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed applications and other Amazon Web Services resources. You can connect your existing identity provider and synchronize users and groups from your directory, or create and manage your users directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following:
User access to applications
User access to Amazon Web Services accounts
This guide provides information about single sign-on operations that you can use for access to applications and Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
IAM Identity Center uses the sso
and identitystore
API namespaces.
Many API operations for IAM Identity Center rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM entities. The access token can be used to fetch short-lived credentials for the assigned Amazon Web Services accounts or to access application APIs using bearer
authentication.
Creates and returns access and refresh tokens for authorized client applications that are authenticated using any IAM entity, such as a service role or user. These tokens might contain defined scopes that specify permissions such as read:profile
or write:data
. Through downscoping, you can use the scopes parameter to request tokens with reduced permissions compared to the original client application's permissions or, if applicable, the refresh token's scopes. The access token can be used to fetch short-lived credentials for the assigned Amazon Web Services accounts or to access application APIs using bearer
authentication.
This API is used with Signature Version 4. For more information, see Amazon Web Services Signature Version 4 for API Requests.
Registers a public client with IAM Identity Center. This allows clients to perform authorization using the authorization code grant with Proof Key for Code Exchange (PKCE) or the device code grant.
", "authtype":"none", @@ -112,6 +113,10 @@ "shape":"Error", "documentation":"Single error code. For this exception the value will be access_denied
.
A string that uniquely identifies a reason for the error.
" + }, "error_description":{ "shape":"ErrorDescription", "documentation":"Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" @@ -121,6 +126,10 @@ "error":{"httpStatusCode":400}, "exception":true }, + "AccessDeniedExceptionReason":{ + "type":"string", + "enum":["KMS_AccessDeniedException"] + }, "AccessToken":{ "type":"string", "sensitive":true @@ -152,10 +161,10 @@ "members":{ "identityContext":{ "shape":"IdentityContext", - "documentation":"STS context assertion that carries a user identifier to the Amazon Web Services service that it calls and can be used to obtain an identity-enhanced IAM role session. This value corresponds to the sts:identity_context
claim in the ID token.
The trusted context assertion is signed and encrypted by STS. It provides access to sts:identity_context
claim in the idToken
without JWT parsing
Identity context comprises information that Amazon Web Services services use to make authorization decisions when they receive requests.
" } }, - "documentation":"This structure contains Amazon Web Services-specific parameter extensions for the token endpoint responses and includes the identity context.
" + "documentation":"This structure contains Amazon Web Services-specific parameter extensions and the identity context.
" }, "ClientId":{"type":"string"}, "ClientName":{"type":"string"}, @@ -202,7 +211,7 @@ }, "scope":{ "shape":"Scopes", - "documentation":"The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
" + "documentation":"The list of scopes for which authorization is requested. This parameter has no effect; the access token will always include all scopes configured during client registration.
" }, "redirectUri":{ "shape":"URI", @@ -325,7 +334,7 @@ }, "awsAdditionalDetails":{ "shape":"AwsAdditionalDetails", - "documentation":"A structure containing information from the idToken
. Only the identityContext
is in it, which is a value extracted from the idToken
. This provides direct access to identity information without requiring JWT parsing.
A structure containing information from IAM Identity Center managed user and group information.
" } } }, @@ -448,6 +457,10 @@ "shape":"Error", "documentation":"Single error code. For this exception the value will be invalid_request
.
A string that uniquely identifies a reason for the error.
" + }, "error_description":{ "shape":"ErrorDescription", "documentation":"Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" @@ -457,6 +470,15 @@ "error":{"httpStatusCode":400}, "exception":true }, + "InvalidRequestExceptionReason":{ + "type":"string", + "enum":[ + "KMS_NotFoundException", + "KMS_InvalidKeyUsageException", + "KMS_InvalidStateException", + "KMS_DisabledException" + ] + }, "InvalidRequestRegionException":{ "type":"structure", "members":{ @@ -687,5 +709,5 @@ }, "UserCode":{"type":"string"} }, - "documentation":"IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center.
API namespaces
IAM Identity Center uses the sso
and identitystore
API namespaces. IAM Identity Center OpenID Connect uses the sso-oidc
namespace.
Considerations for using this guide
Before you begin using this guide, we recommend that you first review the following important information about how the IAM Identity Center OIDC service works.
The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single sign-on authentication with the CLI.
With older versions of the CLI, the service only emits OIDC access tokens, so to obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that supports token refresh and doesn’t require re-authentication, update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and configurable IAM Identity Center session durations. For more information, see Configure Amazon Web Services access portal session duration .
The access tokens provided by this service grant access to all Amazon Web Services account entitlements assigned to an IAM Identity Center user, not just a particular application.
The documentation in this guide does not describe the mechanism to convert the access token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference Guide.
For general information about IAM Identity Center, see What is IAM Identity Center? in the IAM Identity Center User Guide.
" + "documentation":"IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center.
API namespaces
IAM Identity Center uses the sso
and identitystore
API namespaces. IAM Identity Center OpenID Connect uses the sso-oauth
namespace.
Considerations for using this guide
Before you begin using this guide, we recommend that you first review the following important information about how the IAM Identity Center OIDC service works.
The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single sign-on authentication with the CLI.
With older versions of the CLI, the service only emits OIDC access tokens, so to obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that supports token refresh and doesn’t require re-authentication, update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and configurable IAM Identity Center session durations. For more information, see Configure Amazon Web Services access portal session duration .
The access tokens provided by this service grant access to all Amazon Web Services account entitlements assigned to an IAM Identity Center user, not just a particular application.
The documentation in this guide does not describe the mechanism to convert the access token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference Guide.
For general information about IAM Identity Center, see What is IAM Identity Center? in the IAM Identity Center User Guide.
" } diff --git a/services/storagegateway/pom.xml b/services/storagegateway/pom.xml index 54cad8d6a51d..22e8552bbf15 100644 --- a/services/storagegateway/pom.xml +++ b/services/storagegateway/pom.xml @@ -21,7 +21,7 @@